Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TTypingInteractor
Inherited By:
None.
Purpose:
TDocumentTypingInteractor is a derived class of TTypingInteractor. It handles keyboard typing input to a document.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
This class is designed to be used directly.
However, a derived class can override the KeyDown member function to monitor key events. In order to use a derived class to monitor key events, it is necessary to create a derived class of TDocumentTextView with an override for HandleCreateTypingInteractor to instantiate your own typing interactor derived from TDocumentTypingInteractor.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
- TDocumentTypingInteractor (TDocumentTextView * view)
- TDocumentTypingInteractor ()
Interface Category:
API.
Purpose:
- Constructs an interactor to process typing events for the specified document text view.
- Default constructor. This constructor is protected.
Calling Context:
- Called to construct an interactor for a particular view.
- Called by the stream-in operators.
Parameters:
- TDocumentTextView * view -The document text view to construct this interactor for.
- Takes no parameters.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ TDocumentTypingInteractor ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object. Typically not called directly by clients.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual TDocumentTextView * GetDocumentTextView ()
Interface Category:
API.
Purpose:
Accessor function for getting a pointer to the document text view associated with this interactor. Called to determine the document text view associated with this interactor.
Calling Context:
May be called directly by clients. May be called from other classes.
Parameters:
Return Value:
A pointer to the document text view associated with this interactor.
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.
Copyright©1995 Taligent,Inc. All rights reserved.