Class: TTextRepresentationWriteEntry

Declaration: TextRepresentation.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TTextRepresentationWriteEntry is a friend of MTextRepresentation and provides protected, synchronized access to the text data store. Clients who wish to write the text data should instantiate a TTextRepresentationWriteEntry, then call GetTextForWriting.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TTextRepresentationWriteEntry::TTextRepresentationWriteEntry

TTextRepresentationWriteEntry (MTextRepresentation * textToReadOrWrite)
TTextRepresentationWriteEntry (MTextSelection * textSelection)
TTextRepresentationWriteEntry ()
TTextRepresentationWriteEntry (const TTextRepresentationWriteEntry &)

Interface Category:

API.

Purpose:

Constructs a TTextRepresentationWriteEntry object for the specified representation, and establishes a write lock on the text.
Constructs a TTextRepresentationWriteEntry object for the representation associated with the specified selection, and establishes a write lock on the text.
Default constructor.
Copy constructor.

Calling Context:

Called, via construction by client, to establish a write lock on the text of the specified representation.
Called to establish a write lock on the text of the representation associated with the specified selection.
Can't be called.
Called to copy an object.

Parameters:

MTextRepresentation * textToReadOrWrite -Pointer to the text representation whose text is to be locked for writing.
MTextSelection * textSelection -Pointer to the text selection whose representation's text is to be locked for writing.
Takes no parameters.
const TTextRepresentationWriteEntry & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTextRepresentationWriteEntry::~TTextRepresentationWriteEntry

virtual ~ TTextRepresentationWriteEntry ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TTextRepresentationWriteEntry::operator=

TTextRepresentationWriteEntry & operator =(const TTextRepresentationWriteEntry &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

May be called directly by clients.

Parameters:

const TTextRepresentationWriteEntry & -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:

Multithread safe.

Other Considerations:

This function is protected.

Member Function: TTextRepresentationWriteEntry::GetTextForWriting

TText * GetTextForWriting ()

Interface Category:

API.

Purpose:

Returns a pointer to the TText object contained by this representation.

Calling Context:

Clients can call this function to obtain the TText pointer with write access, then use TText API to write the text.

Parameters:

Takes no parameters.

Return Value:

A pointer to the TText object contained by this representation.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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