class PCaret: public PContainer

A class representing a caret indicator for text input.

Inheritance:


Public Fields

[more]PDim caretSize
Size of the caret.

Public Methods

[more] PCaret ()
Create the default caret.
[more] PCaret ( PDIMENSION dx, PDIMENSION dy )
Create a block caret of the specified dimensions.
[more]virtual Comparison Compare ( const PObject & obj ) const
Get whether the caret object is of the same size as the current caret.
[more]void SetDimensions ( PDIMENSION dx, PDIMENSION dy )
Set the dimensions of the caret to the width and height specified.
[more]void Activate ( PInteractor * activator, BOOL display )
Activate the caret displaying it in the interactor.
[more]void Deactivate ( PInteractor * activator )
Deactivate the caret removing it from the interactor.
[more]void Show ( PInteractor * activator )
Show the caret displaying it in the interactor, if it is active.
[more]void Hide ( PInteractor * activator )
Hide the caret removing it from the interactor, if it is active.
[more]void SetPosition ( PInteractor * activator )
Set the position of the physical caret, if it is active.

Public

[more] Overrides from class PObject
[more] New functions for class

Protected

[more] Member variables;


Inherited from PContainer:

Public

Construction

Common functions for containers

Protected Methods

ovirtual void DestroyContents()
ovirtual void AssignContents(const PContainer & c)
ovoid CopyContents(const PContainer & c)
ovoid CloneContents(const PContainer * src)
ovoid Destruct()


Inherited from PObject:

Public

Run Time Type functions

Comparison functions

I/O functions

Miscellaneous functions


Documentation

A class representing a caret indicator for text input. A caret is used to indicate where the current insertion point is in a line of text.
o PCaret()
Create the default caret. This consists of a single vertical line.

o PCaret( PDIMENSION dx, PDIMENSION dy )
Create a block caret of the specified dimensions.
Parameters:
dx - Width of the caret block.
dy - Height of the caret block.

o Overrides from class PObject

ovirtual Comparison Compare( const PObject & obj ) const
Get whether the caret object is of the same size as the current caret.

Returns:
EqualTo if they are of the same size, GreaterThan otherwise.
Parameters:
obj - Object to compare

o New functions for class

ovoid SetDimensions( PDIMENSION dx, PDIMENSION dy )
Set the dimensions of the caret to the width and height specified.
Parameters:
dx - Width of the caret block.
dy - Height of the caret block.

ovoid Activate( PInteractor * activator, BOOL display )
Activate the caret displaying it in the interactor.

Note that the user does not normally call this function. It is called by the PInteractor class when it gains the focus.

Parameters:
activator - Interactor activating the caret.
display - Display caret.

ovoid Deactivate( PInteractor * activator )
Deactivate the caret removing it from the interactor.

Note that the user does not normally call this function. It is called by the PInteractor class when it loses the focus.

Parameters:
activator - Interactor activating the caret.

ovoid Show( PInteractor * activator )
Show the caret displaying it in the interactor, if it is active.

Note that the user does not normally call this function. It is called by the PInteractor class when it shows the caret.

Parameters:
activator - Interactor activating the caret.

ovoid Hide( PInteractor * activator )
Hide the caret removing it from the interactor, if it is active.

Note that the user does not normally call this function. It is called by the PInteractor class when it hides the caret.

Parameters:
activator - Interactor activating the caret.

ovoid SetPosition( PInteractor * activator )
Set the position of the physical caret, if it is active.

Note that the user does not normally call this function. It is called by the PInteractor class for example when the PInteractor::SetCaretPos() function is called.

Parameters:
activator - Interactor activating the caret.

o Member variables;

oPDim caretSize
Size of the caret.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.