GuiInputCtrl

Engine/source/gui/utility/guiInputCtrl.h

A control that locks the mouse and reports all keyboard input events to script.

More...

Public Types

Protected Attributes

Public Functions

DECLARE_CALLBACK(void , onAxisEvent , (const char *device, const char *action, F32 axisValue) )
DECLARE_CALLBACK(void , onInputEvent , (const char *device, const char *action, bool state) )
DECLARE_CATEGORY("Gui Other Script" )
DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that locks the mouse and reports all input events <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> script." )
bool

General input handler.

Called when this object is asked to sleep.

bool

Called when this object is asked to wake up returns true if it's actually awake at the end.

Public Static Functions

Detailed Description

A control that locks the mouse and reports all keyboard input events to script.

This is useful for implementing custom keyboard handling code.

Public Types

typedef GuiMouseEventCtrl Parent 

Protected Attributes

bool mSendAxisEvents 
bool mSendBreakEvents 
bool mSendModifierEvents 

Public Functions

GuiInputCtrl()

DECLARE_CALLBACK(void , onAxisEvent , (const char *device, const char *action, F32 axisValue) )

DECLARE_CALLBACK(void , onInputEvent , (const char *device, const char *action, bool state) )

DECLARE_CATEGORY("Gui Other Script" )

DECLARE_CONOBJECT(GuiInputCtrl )

DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that locks the mouse and reports all input events <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> script." )

onInputEvent(const InputEventInfo & event)

Reimplemented from: GuiControl

onSleep()

Reimplemented from: GuiControl

onWake()

Reimplemented from: GuiControl

Public Static Functions

initPersistFields()