Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.Events.KeyEvent Class Reference

Immutable keyboard event. More...

Inheritance diagram for Dragengine.Gui.Events.KeyEvent:
Dragengine.Gui.Events.ModifiableEvent Dragengine.Gui.Events.Event

Public Member Functions

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

Static Public Member Functions

static bool isKeyEvent (int identifier)
 Event identifier is a key event identifier. More...
 

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. More...
 
static final int control = 2
 Control key pressed. More...
 
static final int shift = 1
 Shift key pressed. More...
 

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 
)

◆ 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 
)

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: