C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | Public Attributes | List of all members
PureWebKeyboardEventArgs Struct Reference

The PureWebKeyboardEventArgs structure provides event arguments for keyboard input events. PureWebKeyboardEventArgs objects are automatically generated whenever the end user interacts with a view on the client using a keyboard.

Public Functions

bool Handled () const
 
Guid SessionId () const
 
void SetHandled (bool value)
 
String ViewName () const
 
Constructors and Destructors
 PureWebKeyboardEventArgs ()
 
 PureWebKeyboardEventArgs (Guid sessionId, String viewName)
 

Public Attributes

int CharacterCode
 
KeyboardEventType::Enum EventType
 
KeyCode::Enum KeyCode
 
Modifiers::Enum Modifiers
 

Usage Description

bool Handled ( ) const
inlineinherited

Returns a Boolean value indicating whether the event receiver has handled this event.

Guid SessionId ( ) const
inlineinherited

Returns the content of the sessionID argument. Indicates in which session the input event occurred.

void SetHandled ( bool  value)
inlineinherited

Sets whether the event receiver has handled this event.

String ViewName ( ) const
inlineinherited

Returns the content of the viewName argument. Indicates in which view the input event occurred.

Member Data Documentation

int CharacterCode

The UTF character code of the key that was pressed, or zero if the key is not a printable character.

The type of the keyboard event that occurred (key up, key down, or none).

KeyCode::Enum KeyCode

The virtual key code of the key that was pressed, such as Space, Delete or NumPad1.

Modifiers::Enum Modifiers

The modifier key (such as Shift or Control) that was pressed simultaneously with another key when using a keyboard combination.