Class: TTextRepresentationReadEntry

Declaration: TextRepresentation.h

Taxonomy Categories:

Member Functions:

TTextRepresentationReadEntry
~TTextRepresentationReadEntry
GetTextForReading
operator=

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

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

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: TTextRepresentationReadEntry::TTextRepresentationReadEntry

TTextRepresentationReadEntry (MTextRepresentation * textToRead)
TTextRepresentationReadEntry (MTextSelection * textSelection)
TTextRepresentationReadEntry ()
TTextRepresentationReadEntry (const TTextRepresentationReadEntry &)

Interface Category:

API.

Purpose:

Constructs a TTextRepresentationReadEntry object for the specified representation, and establishes a read lock on the text.
Constructs a TTextRepresentationReadEntry object for the representation associated with the specified selection, and establishes a read lock on the text.
Default constructor. This constructor is protected and should not be called.
Copy constructor.

Calling Context:

Called, via construction by clients, to establish a read lock on the text of the specified representation.
Called, via construction by clients, to establish a read lock on the text of the representation associated with the specified selection.
Can't be called.
Called to copy an object. Typically not called directly by clients.

Parameters:

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

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTextRepresentationReadEntry::~TTextRepresentationReadEntry

virtual ~ TTextRepresentationReadEntry ()

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: TTextRepresentationReadEntry::GetTextForReading

const TText * GetTextForReading () const

Interface Category:

API.

Purpose:

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

Calling Context:

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

Parameters:

Takes no parameters.

Return Value:

A const pointer to the TText object contained by this representation.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTextRepresentationReadEntry::operator=

TTextRepresentationReadEntry & operator =(const TTextRepresentationReadEntry &)

Interface Category:

API.

Purpose:

Assignment operator. Called when an object is assigned to another compatible object.

Calling Context:

May be called directly by clients.

Parameters:

const TTextRepresentationReadEntry & -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.

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