pp::KeyboardInputEvent Class Reference

Inheritance diagram for pp::KeyboardInputEvent:

Public Member Functions

	KeyboardInputEvent ()
	KeyboardInputEvent (const InputEvent &event)
	KeyboardInputEvent (const InstanceHandle &instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers, uint32_t key_code, const Var &character_text)
uint32_t	GetKeyCode () const
Var	GetCharacterText () const

pp::KeyboardInputEvent::KeyboardInputEvent ( )

Constructs an is_null() keyboard input event object.

pp::KeyboardInputEvent::KeyboardInputEvent ( const InputEvent & event ) [explicit]

Constructs a keyboard input event object from the provided generic input event.

If the given event is itself is_null() or is not a keyboard input event, the keybaord object will be is_null().

Parameters:

[in] event A generic input event.

pp::KeyboardInputEvent::KeyboardInputEvent	(	const InstanceHandle &	instance,
		PP_InputEvent_Type	type,
		PP_TimeTicks	time_stamp,
		uint32_t	modifiers,
		uint32_t	key_code,
		const Var &	character_text
	)

Constructs a keyboard input even from the given parameters.

Parameters:

[in]	instance	The instance for which this event occurred.
[in]	type	A `PP_InputEvent_Type` identifying the type of input event.
[in]	time_stamp	A `PP_TimeTicks` indicating the time when the event occurred.
[in]	modifiers	A bit field combination of the `PP_InputEvent_Modifier` flags.
[in]	key_code	This value reflects the DOM KeyboardEvent `keyCode` field. Chrome populates this with the Windows-style Virtual Key code of the key.
[in]	character_text	This value represents the typed character as a UTF-8 string.

Var pp::KeyboardInputEvent::GetCharacterText ( ) const

Returns the typed character for the given character event.

Returns:: A string var representing a single typed character for character input events. For non-character input events the return value will be an undefined var.

uint32_t pp::KeyboardInputEvent::GetKeyCode ( ) const

Returns the DOM keyCode field for the keyboard event.

Chrome populates this with the Windows-style Virtual Key code of the key.

The documentation for this class was generated from the following file: