#include <input_event.h>

Inheritance diagram for pp::KeyboardInputEvent:

Collaboration diagram for pp::KeyboardInputEvent:

Public Member Functions
	KeyboardInputEvent ()
	Constructs an is_null() keyboard input event object. More...

	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)

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

uint32_t	GetKeyCode () const

Var	GetCharacterText () const

Var	GetCode () const
	Returns the DOM \|code\| for the keyboard event. More...

Public Member Functions inherited from pp::InputEvent
	InputEvent ()
	Default constructor that creates an is_null() InputEvent object. More...

	InputEvent (PP_Resource input_event_resource)

	~InputEvent ()

PP_InputEvent_Type	GetType () const

PP_TimeTicks	GetTimeStamp () const

uint32_t	GetModifiers () const

Public Member Functions inherited from pp::Resource
	Resource ()
	The default constructor. More...

	Resource (const Resource &other)

virtual	~Resource ()
	Destructor. More...

Resource &	operator= (const Resource &other)

bool	is_null () const

PP_Resource	pp_resource () const

PP_Resource	detach ()

Additional Inherited Members
Protected Member Functions inherited from pp::Resource
	Resource (PP_Resource resource)

	Resource (PassRef, PP_Resource resource)

void	PassRefFromConstructor (PP_Resource resource)

void	Clear ()
	Sets this resource to null. This releases ownership of the resource. More...

Detailed Description

Definition at line 253 of file input_event.h.

Constructor & Destructor Documentation

pp::KeyboardInputEvent::KeyboardInputEvent ( )

Constructs an is_null() keyboard input event object.

Definition at line 192 of file input_event.cc.

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.

Definition at line 195 of file input_event.cc.

References pp::Core::AddRefResource(), pp::Module::core(), pp::Module::Get(), pp::Resource::PassRefFromConstructor(), and pp::Resource::pp_resource().

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.

Definition at line 214 of file input_event.cc.

References pp::Resource::PassRefFromConstructor(), pp::InstanceHandle::pp_instance(), pp::Var::pp_var(), and pp::Resource::Var.

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,
		const Var &	code
	)

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.
[in]	code	This value reflects the DOM KeyboardEvent `code` field, which identifies the physical key associated with the event.

Definition at line 231 of file input_event.cc.

References pp::Resource::PassRefFromConstructor(), pp::InstanceHandle::pp_instance(), and pp::Var::pp_var().

Member Function Documentation

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.

Definition at line 260 of file input_event.cc.

References pp::PASS_REF, pp::Resource::pp_resource(), and pp::Resource::Var.

Var pp::KeyboardInputEvent::GetCode ( ) const

Returns the DOM |code| for the keyboard event.

Returns: A string var representing a physical key that was pressed to generate this event.

Definition at line 273 of file input_event.cc.

References pp::PASS_REF, pp::Resource::pp_resource(), and pp::Resource::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.

Definition at line 249 of file input_event.cc.

References pp::Resource::pp_resource().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation