Returns the control type identifier for the current event.
Takes no parameters.
Returns the value of the global variable LuiEventID.
BGI GUI
Parameters & Returns
Parameters
This function takes no parameters.
Returns
Int
Quick Summary
Returns the control type identifier for the current event.
Takes no parameters.
Returns the value of the global variable LuiEventID.
Technical Exegesis...
Returns the control type identifier for the current event. Returns the value of the global variable LuiEventID.
Returns the control type identifier for the current event. Returns the value of the global variable LuiEventID. Event ID constants identify which type of control triggered the event: BGI_EVENT_ID_MENU (0x101), BGI_EVENT_ID_BUTTON (0x102), BGI_EVENT_ID_TRACKBAR (0x103), BGI_EVENT_ID_TEXTBOX (0x104), BGI_EVENT_ID_LIST (0x105), BGI_EVENT_ID_TREEVIEW (0x106), BGI_EVENT_ID_SPINNER (0x107), BGI_EVENT_ID_TABCONTROL (0x108), BGI_EVENT_ID_LISTVIEW (0x109), BGI_EVENT_ID_TOOLBAR (0x10A), BGI_EVENT_ID_DATEPICKER (0x10B), BGI_EVENT_ID_TIMEPICKER (0x10C), BGI_EVENT_ID_LINK (0x10D), BGI_EVENT_ID_VSCROLLBAR (0x10E), BGI_EVENT_ID_HSCROLLBAR (0x10F), BGI_EVENT_ID_HTMLVIEW (0x110), BGI_EVENT_ID_CHECKBOX (0x111), BGI_EVENT_ID_SCROLLPANEL (0x112), BGI_EVENT_ID_RICHTEXTBOX (0x113). Returns 0 when no event is pending.
This function identifies the control type category that generated the event. The LuiEventID global is set alongside LuiEvent when events are dispatched. Use after checking bgiGetEventMessage() to narrow down the control type, then use bgiGetEventSource() to get the specific control's ID. Example: if bgiGetEventMessage() == BGI_EVENT_COMMAND_CLICK and bgiGetEventID() == BGI_EVENT_ID_BUTTON, then a button was clicked - use bgiGetEventSource() to determine which button. Different control types may fire different event messages (buttons fire CLICK, trackbars fire UPDATE).