Class: TSimpleTextSelection

Declaration: SimpleTextSelection.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MToolTarget, MTextSelection, MCollectible

Inherited By:

None.

Purpose:

TSimpleTextSelection is a concrete derived class of MTextSelection for specifying data that is not model-based.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSimpleTextSelection::TSimpleTextSelection

TSimpleTextSelection (MTextRepresentation * textToAlias)
TSimpleTextSelection (const TSimpleTextSelection &)
TSimpleTextSelection ()

Interface Category:

API.

Purpose:

Constructs a simple text selection object bound to the specified MTextRepresentation.
Copy constructor.
Default constructor.

Calling Context:

May be called directly by clients.
May be called directly by clients.
May be called directly by clients.

Parameters:

MTextRepresentation * textToAlias -A pointer to the MTextRepresentation to be associated with the new simple text selection object.
const TSimpleTextSelection & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextSelection::~TSimpleTextSelection

virtual ~ TSimpleTextSelection ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextSelection::operator=

TSimpleTextSelection & operator =(const TSimpleTextSelection &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

May be called directly by clients.

Parameters:

const TSimpleTextSelection & -The source object for the assignment.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextSelection::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

May be called directly by clients.

Parameters:

TStream & towhere -The stream the object streams itself out to.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextSelection::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

May be called directly by clients.

Parameters:

TStream & fromwhere -The stream the object streams itself in from.

Return Value:

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

Exceptions:

Throws TInvalidVersionError if the object has detected an unsupportable version during the stream-in process.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTextSelection::GetTextForWriting

virtual MTextRepresentation * GetTextForWriting ()

Interface Category:

API.

Purpose:

Returns a pointer to the MTextRepresentation representation bound to this selection.

Calling Context:

May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

A pointer to the MTextRepresentation.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited MTextSelection function.

Member Function: TSimpleTextSelection::GetTextForReading

virtual const TText * GetTextForReading () const

Interface Category:

API.

Purpose:

Returns the text object contained by the representation bound to this selection.

Calling Context:

May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

A pointer to the TText object contained by the representation bound to this selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited MTextSelection function.

Member Function: TSimpleTextSelection::CopyTextSelection

virtual MTextSelection * CopyTextSelection () const

Interface Category:

API.

Purpose:

Returns a copy of this simple text selection object.

Calling Context:

May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

A pointer to the new selection object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This protected function overrides the inherited MTextSelection function.

Member Function: TSimpleTextSelection::GetRepresentation

virtual MTextRepresentation * GetRepresentation ()

Interface Category:

API.

Purpose:

Returns the text representation bound to this simple text selection. Called to get access to the representation bound to this selection.

Calling Context:

May be called directly by clients.

Parameters:

Takes no parameters.

Return Value:

A pointer to the representation bound to this selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This protected function overrides the inherited MTextSelection function.

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