Class: TSimpleTypingInteractor

Declaration: SimpleTextInteractors.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTypingInteractor

Inherited By:

None.

Purpose:

TSimpleTypingInteractor is derived from TTypingInteractor. It handles keyboard typing input to text areas that are not model-based.

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 TSimpleTextView with an override for HandleCreateTypingInteractor to instantiate your own typing interactor derived from TSimpleTypingInteractor.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSimpleTypingInteractor::TSimpleTypingInteractor

TSimpleTypingInteractor (TSimpleTextView * view)
TSimpleTypingInteractor ()

Interface Category:

API.

Purpose:

Constructs an interactor to process typing events for the specified simple 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:

TSimpleTextView * view -The simple text view to construct this interactor for.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSimpleTypingInteractor::~TSimpleTypingInteractor

virtual ~ TSimpleTypingInteractor ()

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: TSimpleTypingInteractor::GetSimpleTextView

virtual TSimpleTextView * GetSimpleTextView ()

Interface Category:

API.

Purpose:

Accessor function for getting a pointer to the simple text view associated with this interactor. Called to determine the simple text view associated with this interactor.

Calling Context:

May be called directly by clients. May be called from other classes.

Parameters:

Takes no parameters.

Return Value:

A pointer to the simple text view associated with this interactor.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TSimpleTypingInteractor::KeyDown

virtual bool KeyDown (TKeyDownEvent &)

Interface Category:

API.

Purpose:

Overrides the default ::KeyDown by choosing the typing configuration first.

Calling Context:

Not called directly.

Parameters:

TKeyDownEvent & -Reference to KeyDown event.

Return Value:

Returns true if the event was handled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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