Drag[en]gine Script Module DragonScript  1.21
Dragengine.Gui.ForwardKeyPressListener Class Reference

Key listener forwarding key press of specific key to widget. More...

Inheritance diagram for Dragengine.Gui.ForwardKeyPressListener:
Dragengine.Gui.Events.DefaultKeyListener Dragengine.Gui.Events.KeyListener

Public Member Functions

int getKey ()
 Key to listen on. More...
 
Widget getWidget ()
 Widget to send event to. More...
 
ForwardKeyPressListener new (int key, Widget widget)
 Create listener forwarding key to widget. More...
 
void onKeyPress (KeyEvent event)
 Keyboard key has been pressed. More...
 
void setKey (int key)
 Set key to listen on. More...
 
void setWidget (Widget widget)
 Set widget to send event to. More...
 
- Public Member Functions inherited from Dragengine.Gui.Events.DefaultKeyListener
DefaultKeyListener new ()
 Create default key listener. More...
 
void onKeyRelease (KeyEvent event)
 Keyboard key has been released. More...
 

Detailed Description

Key listener forwarding key press of specific key to widget.

Allows to create for example default buttons in dialogs and windows being pressed if the user presses InputEventKey.enter . Add this listener to Window instance with the widget (for example Button) to send InputEventKey.enter event to like this:

var Window window = ...create window...
var Button button = ...create default button you want to forward to..
window.addKeyListener(ForwardKeyPressListener.new(InputEventKey.enter, button))

Member Function Documentation

◆ getKey()

int Dragengine.Gui.ForwardKeyPressListener.getKey ( )

Key to listen on.

◆ getWidget()

Widget Dragengine.Gui.ForwardKeyPressListener.getWidget ( )

Widget to send event to.

◆ new()

ForwardKeyPressListener Dragengine.Gui.ForwardKeyPressListener.new ( int  key,
Widget  widget 
)

Create listener forwarding key to widget.

◆ onKeyPress()

void Dragengine.Gui.ForwardKeyPressListener.onKeyPress ( KeyEvent  event)

Keyboard key has been pressed.

Reimplemented from Dragengine.Gui.Events.DefaultKeyListener.

◆ setKey()

void Dragengine.Gui.ForwardKeyPressListener.setKey ( int  key)

Set key to listen on.

◆ setWidget()

void Dragengine.Gui.ForwardKeyPressListener.setWidget ( Widget  widget)

Set widget to send event to.


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