Dragengine.Gui.Events.KeyEvent Class Reference

Immutable keyboard event. More...

Inheritance diagram for Dragengine.Gui.Events.KeyEvent:

Public Member Functions
bool	equalKeyEvents (KeyEvent event)
	Key events are equal.
int	getButtonCode ()
	Device button code.
int	getDevice ()
	Device index.
int	getKeyChar ()
	Printable key character if existing.
int	getKeyCode ()
	Key code.
InputEventSource	getSystem ()
	Source system.
KeyEvent	new (Object source, int id, int keyCode, int modifiers, InputEventSource system, int device, int buttonCode)
	Create event.
KeyEvent	new (Object source, int id, int keyCode, int modifiers, int device, int buttonCode)
	Create event.
KeyEvent	new (Object source, int id, int keyCode, int modifiers, int keyChar, InputEventSource system, int device, int buttonCode)
	Create event.
KeyEvent	new (Object source, int id, int keyCode, int modifiers, int keyChar, int device, int buttonCode)
	Create event.
Public Member Functions inherited from Dragengine.Gui.Events.ModifiableEvent
int	getModifiers ()
	Modifier keys.
ModifiableEvent	new (Object source, int id, int modifiers)
	Create event.
Public Member Functions inherited from Dragengine.Gui.Events.Event
int	getIdentifier ()
	Event identifier.
Object	getSource ()
	Event source.
Event	new (Object source, int id)
	Create event.

Static Public Member Functions
static bool	isKeyEvent (int identifier)
	Event identifier is a key event identifier.

Static Public Attributes
static final int	idKeyPressed = 10
static final int	idKeyReleased = 11
Static Public Attributes inherited from Dragengine.Gui.Events.ModifiableEvent
static final int	alt = 4
	Alt key pressed.
static final int	control = 2
	Control key pressed.
static final int	shift = 1
	Shift key pressed.

Detailed Description

Immutable keyboard event.

Stores the code of the key involved as well as the character it does represent if one exists.

Member Function Documentation

equalKeyEvents()

bool Dragengine.Gui.Events.KeyEvent.equalKeyEvents

(

KeyEvent

event

)

Key events are equal.

Two key events equal if they have the same identifier and key code.

getButtonCode()

int Dragengine.Gui.Events.KeyEvent.getButtonCode

(

)

Device button code.

getDevice()

int Dragengine.Gui.Events.KeyEvent.getDevice

(

)

Device index.

getKeyChar()

int Dragengine.Gui.Events.KeyEvent.getKeyChar

(

)

Printable key character if existing.

getKeyCode()

int Dragengine.Gui.Events.KeyEvent.getKeyCode

(

)

Key code.

getSystem()

InputEventSource Dragengine.Gui.Events.KeyEvent.getSystem

(

)

Source system.

Version

1.6

isKeyEvent()

static bool Dragengine.Gui.Events.KeyEvent.isKeyEvent ( int  identifier )

static

Event identifier is a key event identifier.

new() [1/4]

KeyEvent Dragengine.Gui.Events.KeyEvent.new	(	Object	source,
		int	id,
		int	keyCode,
		int	modifiers,
		InputEventSource	system,
		int	device,
		int	buttonCode
	)

Create event.

Version

1.6

new() [2/4]

KeyEvent Dragengine.Gui.Events.KeyEvent.new	(	Object	source,
		int	id,
		int	keyCode,
		int	modifiers,
		int	device,
		int	buttonCode
	)

Create event.

Deprecated:

Use new(Object,int,int,int,InputEventSource,int,int)

new() [3/4]

KeyEvent Dragengine.Gui.Events.KeyEvent.new	(	Object	source,
		int	id,
		int	keyCode,
		int	modifiers,
		int	keyChar,
		InputEventSource	system,
		int	device,
		int	buttonCode
	)

Create event.

Version

1.6

new() [4/4]

KeyEvent Dragengine.Gui.Events.KeyEvent.new	(	Object	source,
		int	id,
		int	keyCode,
		int	modifiers,
		int	keyChar,
		int	device,
		int	buttonCode
	)

Create event.

Deprecated:

Use new(Object,int,int,int,int,InputEventSource,int,int)

Member Data Documentation

idKeyPressed

final int Dragengine.Gui.Events.KeyEvent.idKeyPressed = 10

static

Key pressed event idenfitier

idKeyReleased

final int Dragengine.Gui.Events.KeyEvent.idKeyReleased = 11

static

Key released event idenfitier

---

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

• KeyEvent.ds