Class: TTextPresenterStateSelection

Declaration: TextPresenterStateSelection.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPresenterStateSelection, MToolTarget

Inherited By:

None.

Purpose:

TTextPresenterStateSelection specifies a selection on a text presenter state. A presenter state selection always specifies all the information associated with a particular text presenter state. These selections are used by commands that set text presentation appearance parameters. For example, the color used to draw the text caret.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

This class uses the document component entry to support concurrent access.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TTextPresenterStateSelection::TTextPresenterStateSelection

TTextPresenterStateSelection (const TPresenterStateReference & presenterState)
TTextPresenterStateSelection (const TTextPresenterStateSelection & selection)
TTextPresenterStateSelection ()

Interface Category:

API.

Purpose:

Constructor taking associated presenter state reference.
Copy constructor.
Default constructor.

Calling Context:

Called to instantiate a presenter state selection.
Called to copy an object.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TPresenterStateReference & presenterState -Reference to associated presenter state, bound to this selection.
const TTextPresenterStateSelection & selection -reference to selection to copy from.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

This class uses the document component.

Other Considerations:

None.

Member Function: TTextPresenterStateSelection::~TTextPresenterStateSelection

virtual ~ TTextPresenterStateSelection ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

This class uses the document component.

Other Considerations:

None.

Member Function: TTextPresenterStateSelection::operator=

TTextPresenterStateSelection & operator =(const TTextPresenterStateSelection &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. May be called directly by clients.

Parameters:

const TTextPresenterStateSelection & -reference to object to copy from.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

This class uses the document component.

Other Considerations:

None.

Member Function: TTextPresenterStateSelection::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. May be called directly by clients.

Parameters:

TStream & towhere -reference to stream to write to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

This class uses the document component.

Other Considerations:

None.

Member Function: TTextPresenterStateSelection::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. May be called directly by clients.

Parameters:

TStream & fromwhere -Reference to stream to read from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TInvalidVersionError if the version of the information on the stream in incompatible with this.

Concurrency:

This class uses the document component.

Other Considerations:

None.

Member Function: TTextPresenterStateSelection::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Return a hash value representing the state of this.

Calling Context:

Called by utility classes and hash table based structures. May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

Returns a long.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

This class uses the document component.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.