Class: TKeyDownEvent

Declaration: KeyboardInput.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TKeyDownEvent derives from TKeyEvent and is generated when a key is pressed by the user.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TKeyDownEvent::~TKeyDownEvent

virtual ~ TKeyDownEvent ()

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: TKeyDownEvent::operator=

TKeyDownEvent & operator =(const TKeyDownEvent & assign)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TKeyDownEvent & assign -The object to be copied.

Return Value:

Returns 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: TKeyDownEvent::Dispatch

virtual bool Dispatch (MEventTarget & target)

Interface Category:

API.

Purpose:

Dispatches the key-down event to the given target.

Calling Context:

Called by the event target to dispatch the event.

Parameters:

MEventTarget & target -The target to receive the event.

Return Value:

Returns true if the target returned true after processing the event.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyDownEvent::TKeyDownEvent

TKeyDownEvent (TKeyboardInputDevice * keyboardDevice, TStandardEventReceiver * receiver, TVirtualKeyCode :: EVirtualKey key, TModifierKeys modifierKeys)
TKeyDownEvent (const TKeyDownEvent & copy)

Interface Category:

API

Purpose:

Constructs the key-down event given the keyboard device, event receiver, key code, and modifier.
Copy constructor.

Calling Context:

Called when the even generated is a keyboard event.
Called to copy an object.

Parameters:

TKeyboardInputDevice * keyboardDevice -The keyboard generating the event.
TStandardEventReceiver * receiver -The receiver that gets the event.
TVirtualKeyCode :: EVirtualKey key -The key code for the event.
TModifierKeys modifierKeys -The modifier keys, if any.
const TKeyDownEvent & copy -The object to be copied from.

Return Value:

None.

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.