Class: TDocumentTextTypingStore

Declaration: DocumentTextTypingStore.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTextTypingStore

Inherited By:

None.

Purpose:

TDocumentTextTypingStore is derived from TTextTypingStore. It modifies the text via Document Frameworks commands, and uses associated TDocumentTextView and TTypingCommand objects to implement its member functions.

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

TDocumentTextTypingStore (TDocumentTextView * theView)
TDocumentTextTypingStore (const TDocumentTextTypingStore & other)

Interface Category:

API.

Purpose:

Constructs a document text typing store object that uses the specified document text view to implement its member functions.
Copy constructor.

Calling Context:

Called by a text editor to construct a document text typing store object that uses the specified document text view to implement its member functions.
Called to copy an object.

Parameters:

TDocumentTextView * theView -The document text view.
const TDocumentTextTypingStore & other -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentTextTypingStore::operator=

TDocumentTextTypingStore & operator =(const TDocumentTextTypingStore & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDocumentTextTypingStore & other -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: TDocumentTextTypingStore::~TDocumentTextTypingStore

~ TDocumentTextTypingStore ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentTextTypingStore::TypeEnd

virtual void TypeEnd ()

Interface Category:

API.

Purpose:

Terminates the typing transaction.

Calling Context:

Called by the typing configuration's TypeEnd function.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through, except for TCompoundDocumentException::kExpectedDoBegin, which it ignores.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TTypingStore function.

Member Function: TDocumentTextTypingStore::DoTyping

virtual void DoTyping (const TText & newText, const TTextRange & newRange)

Interface Category:

API.

Purpose:

Replaces the specified range of text with the specified text.

Calling Context:

Called by TypeText to do the actual text replacement.

Parameters:

const TText & newText -The text to insert.
const TTextRange & newRange -The range of text to be replaced.

Return Value:

None.

Exceptions:

Throws TTypingStoreChangedException if it encounters TCompoundDocumentException::kExpectedDoBegin. Passes all other exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This protected function overrides the inherited TTextTypingStore function.

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