Torque3D Documentation / _generateds / GuiMouseEventCtrl

GuiMouseEventCtrl

Engine/source/gui/utility/guiMouseEventCtrl.h

More...

Private Types

GuiControl

Parent

Private Attributes

bool

mLockMouse

Private Functions

void

sendMouseEvent(const char * name, const GuiEvent & )

Public Functions

GuiMouseEventCtrl()

DECLARE_CALLBACK(void , onMouseDown , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseDragged , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseEnter , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseLeave , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseMove , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseUp , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onRightMouseDown , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onRightMouseDragged , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onRightMouseUp , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CATEGORY("Gui Other Script" )

DECLARE_CONOBJECT(GuiMouseEventCtrl )

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

void

onMouseDown(const GuiEvent & event)

void

onMouseDragged(const GuiEvent & event)

void

onMouseEnter(const GuiEvent & event)

void

onMouseLeave(const GuiEvent & event)

void

onMouseMove(const GuiEvent & event)

void

onMouseUp(const GuiEvent & event)

void

onRightMouseDown(const GuiEvent & event)

void

onRightMouseDragged(const GuiEvent & event)

void

onRightMouseUp(const GuiEvent & event)

Public Static Functions
void

initPersistFields()

Detailed Description
Private Types
typedef GuiControl Parent 

Private Attributes
bool mLockMouse 

Private Functions
sendMouseEvent(const char * name, const GuiEvent & )

Public Functions
GuiMouseEventCtrl()

DECLARE_CALLBACK(void , onMouseDown , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseDragged , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseEnter , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseLeave , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseMove , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onMouseUp , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onRightMouseDown , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onRightMouseDragged , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CALLBACK(void , onRightMouseUp , (S32 modifier, Point2I mousePoint, S32 mouseClickCount) )

DECLARE_CATEGORY("Gui Other Script" )

DECLARE_CONOBJECT(GuiMouseEventCtrl )

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

onMouseDown(const GuiEvent & event)

Reimplemented from: GuiControl
onMouseDragged(const GuiEvent & event)

Reimplemented from: GuiControl
onMouseEnter(const GuiEvent & event)

Reimplemented from: GuiControl
onMouseLeave(const GuiEvent & event)

Reimplemented from: GuiControl
onMouseMove(const GuiEvent & event)

Reimplemented from: GuiControl
onMouseUp(const GuiEvent & event)

Reimplemented from: GuiControl
onRightMouseDown(const GuiEvent & event)

Reimplemented from: GuiControl
onRightMouseDragged(const GuiEvent & event)

Reimplemented from: GuiControl
onRightMouseUp(const GuiEvent & event)

Reimplemented from: GuiControl
Public Static Functions
initPersistFields()