Class: TCursorKeyFilter

Declaration: CursorKeyFilter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MEventTarget, MKeyEventHandler, MMouseEventHandler

Inherited By:

None.

Purpose:

Defines navigational behavior of cursor keys on the keyboard.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Deriving classes may override the KeyDown member function to change navigational behavior.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

This class can be used as an event behavior to views.

Member Function: TCursorKeyFilter::TCursorKeyFilter

TCursorKeyFilter (TTextView * associatedViewToAlias)

Interface Category:

API.

Purpose:

Constructor to associate this object with a text view to alias.

Calling Context:

Call this function directly.

Parameters:

TTextView * associatedViewToAlias -Pointer to text view to alias.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorKeyFilter::~TCursorKeyFilter

virtual ~ TCursorKeyFilter ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Typically not called directly by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorKeyFilter::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Calculates a hash value representing this object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a long.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorKeyFilter::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. Call this function directly.

Parameters:

TStream & -A reference to stream to write to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorKeyFilter::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. Call this function directly.

Parameters:

TStream & -A reference to stream to read from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorKeyFilter::KeyDown

virtual bool KeyDown (TKeyDownEvent &)

Interface Category:

API.

Purpose:

Interpret key-down events and process them if they are navigational keys.

Calling Context:

Called by Text Editing Framework. Typically not called directly by clients.

Parameters:

TKeyDownEvent & -The reference to key-down event.

Return Value:

Returns true if key-down event was handled by this object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorKeyFilter::MouseDown

virtual bool MouseDown (TMouseDownEvent &)

Interface Category:

API.

Purpose:

Interpret mouse-down events.

Calling Context:

Called by Text Editing Framework. Not called by clients.

Parameters:

TMouseDownEvent & -The reference to mouse down event.

Return Value:

Returns true if mouse-down event is handled by this object.

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.