Difference between revisions of "Event reference"
From CEGUI Wiki - Crazy Eddie's GUI System (Open Source)
m (Robot: Cosmetic changes) |
|||
| Line 1: | Line 1: | ||
This page is intended to give experienced users of CEGUI a chance to easily lookup what events are a available for different objects. | This page is intended to give experienced users of CEGUI a chance to easily lookup what events are a available for different objects. | ||
| − | See [[EventGalore]] for more information how to use the most common events, [[ | + | See [[EventGalore]] for more information how to use the most common events, [[Identifying Multiple Event Sources From A Single Callback]] and is a page that shows how to cast the events to correct type. The same for LUA is described in this page [[Handling Events from Lua]]. |
== Events by object == | == Events by object == | ||
| − | ===Window=== | + | === Window === |
{| | {| | ||
!width="300pt"|Event | !width="300pt"|Event | ||
| Line 99: | Line 99: | ||
|} | |} | ||
| − | ===Checkbox=== | + | === Checkbox === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 110: | Line 110: | ||
|[[#Checkbox|Checkbox]]::EventCheckStateChanged||"CheckStateChanged"||[[#WindowEventArgs|WindowEventArgs]]||the checkbox got checked or un-checked | |[[#Checkbox|Checkbox]]::EventCheckStateChanged||"CheckStateChanged"||[[#WindowEventArgs|WindowEventArgs]]||the checkbox got checked or un-checked | ||
|} | |} | ||
| − | ===Combobox=== | + | === Combobox === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 154: | Line 154: | ||
|} | |} | ||
| − | ===ComboDropList=== | + | === ComboDropList === |
Inherits events from: [[#Listbox|Listbox]] | Inherits events from: [[#Listbox|Listbox]] | ||
{| | {| | ||
| Line 166: | Line 166: | ||
|} | |} | ||
| − | ===DragContainer=== | + | === DragContainer === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 192: | Line 192: | ||
|} | |} | ||
| − | ===Editbox=== | + | === Editbox === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 224: | Line 224: | ||
|} | |} | ||
| − | ===FrameWindow=== | + | === FrameWindow === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 238: | Line 238: | ||
|} | |} | ||
| − | ===ItemEntry=== | + | === ItemEntry === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 250: | Line 250: | ||
|} | |} | ||
| − | ===ItemListBase=== | + | === ItemListBase === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 266: | Line 266: | ||
|} | |} | ||
| − | ===ItemListbox=== | + | === ItemListbox === |
Inherists events from [[#ScrolledItemListBase|ScrolledItemListBase]], [[#ItemListBase|ItemListBase]], [[#Window|Window]] | Inherists events from [[#ScrolledItemListBase|ScrolledItemListBase]], [[#ItemListBase|ItemListBase]], [[#Window|Window]] | ||
{| | {| | ||
| Line 280: | Line 280: | ||
|} | |} | ||
| − | ===Listbox=== | + | === Listbox === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 302: | Line 302: | ||
|} | |} | ||
| − | ===ListHeader=== | + | === ListHeader === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 336: | Line 336: | ||
|} | |} | ||
| − | ===ListHeaderSegment=== | + | === ListHeaderSegment === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 366: | Line 366: | ||
|} | |} | ||
| − | ===MenuBase=== | + | === MenuBase === |
Inherits events from [[#ItemListBase|ItemListBase]], [[#Window|Window]] | Inherits events from [[#ItemListBase|ItemListBase]], [[#Window|Window]] | ||
{| | {| | ||
| Line 380: | Line 380: | ||
|} | |} | ||
| − | ===MenuItem=== | + | === MenuItem === |
Inherits events from [[#ItemEntry|ItemEntry]], [[#Window|Window]] | Inherits events from [[#ItemEntry|ItemEntry]], [[#Window|Window]] | ||
{| | {| | ||
| Line 392: | Line 392: | ||
|} | |} | ||
| − | ===MouseCursor=== | + | === MouseCursor === |
{| | {| | ||
|- | |- | ||
| Line 403: | Line 403: | ||
|} | |} | ||
| − | ===MultiColumnList=== | + | === MultiColumnList === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 435: | Line 435: | ||
|} | |} | ||
| − | ===MultiLineEditbox=== | + | === MultiLineEditbox === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 461: | Line 461: | ||
|} | |} | ||
| − | ===ProgressBar=== | + | === ProgressBar === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 475: | Line 475: | ||
|} | |} | ||
| − | ===PushButton=== | + | === PushButton === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 487: | Line 487: | ||
|} | |} | ||
| − | ===Radiobutton=== | + | === Radiobutton === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 499: | Line 499: | ||
|} | |} | ||
| − | ===ScrollablePane=== | + | === ScrollablePane === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 519: | Line 519: | ||
|} | |} | ||
| − | ===Scrollbar=== | + | === Scrollbar === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 537: | Line 537: | ||
|} | |} | ||
| − | ===ScrolledContainer=== | + | === ScrolledContainer === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 551: | Line 551: | ||
|} | |} | ||
| − | ===ScrolledItemListBase=== | + | === ScrolledItemListBase === |
Inherits events from [[#ItemListBase|ItemListBase]], [[#Window|Window]] | Inherits events from [[#ItemListBase|ItemListBase]], [[#Window|Window]] | ||
{| | {| | ||
| Line 565: | Line 565: | ||
|} | |} | ||
| − | ===Slider=== | + | === Slider === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 581: | Line 581: | ||
|} | |} | ||
| − | ===Spinner=== | + | === Spinner === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 601: | Line 601: | ||
|} | |} | ||
| − | ===TabButton=== | + | === TabButton === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 617: | Line 617: | ||
|} | |} | ||
| − | ===TabControl=== | + | === TabControl === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 629: | Line 629: | ||
|} | |} | ||
| − | ===Thumb=== | + | === Thumb === |
Inherits events from [[#PushButton|PushButton]], [[#Window|Window]] | Inherits events from [[#PushButton|PushButton]], [[#Window|Window]] | ||
{| | {| | ||
| Line 645: | Line 645: | ||
|} | |} | ||
| − | ===Tooltip=== | + | === Tooltip === |
inherits events from [[#Window|Window]] | inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 665: | Line 665: | ||
|} | |} | ||
| − | ===Tree=== | + | === Tree === |
Inherits events from [[#Window|Window]] | Inherits events from [[#Window|Window]] | ||
{| | {| | ||
| Line 691: | Line 691: | ||
|} | |} | ||
| − | ===Renderer=== | + | === Renderer === |
{| | {| | ||
|- | |- | ||
| Line 702: | Line 702: | ||
|} | |} | ||
| − | ===System=== | + | === System === |
{| | {| | ||
|- | |- | ||
| Line 727: | Line 727: | ||
| − | ==Event Arguments== | + | == Event Arguments == |
| − | ===EventArgs=== | + | === EventArgs === |
bool handled | bool handled | ||
bool d_hasWindow | bool d_hasWindow | ||
| − | ===WindowEventArgs=== | + | === WindowEventArgs === |
bool handled | bool handled | ||
bool d_hasWindow | bool d_hasWindow | ||
Window* window | Window* window | ||
| − | ===UpdateEventArgs=== | + | === UpdateEventArgs === |
bool handled | bool handled | ||
bool d_hasWindow | bool d_hasWindow | ||
| Line 744: | Line 744: | ||
float d_timeSinceLastFrame | float d_timeSinceLastFrame | ||
| − | ===MouseEventArgs=== | + | === MouseEventArgs === |
bool handled | bool handled | ||
bool d_hasWindow | bool d_hasWindow | ||
| Line 755: | Line 755: | ||
uint clickCount | uint clickCount | ||
| − | ===MouseCursorEventArgs=== | + | === MouseCursorEventArgs === |
bool handled | bool handled | ||
bool d_hasWindow | bool d_hasWindow | ||
| Line 761: | Line 761: | ||
const Image* image | const Image* image | ||
| − | ===KeyEventArgs=== | + | === KeyEventArgs === |
bool handled | bool handled | ||
bool d_hasWindow | bool d_hasWindow | ||
| Line 775: | Line 775: | ||
Window* otherWindow | Window* otherWindow | ||
| − | ===DragDropEventArgs=== | + | === DragDropEventArgs === |
bool handled | bool handled | ||
bool d_hasWindow | bool d_hasWindow | ||
| Line 787: | Line 787: | ||
TreeItem *treeItem; | TreeItem *treeItem; | ||
| − | ==LUA Helpers Args== | + | == LUA Helpers Args == |
These helpers are usable in lua to cast event arguments to correct type. | These helpers are usable in lua to cast event arguments to correct type. | ||
CEGUI.toMouseCursorEventArgs(e) | CEGUI.toMouseCursorEventArgs(e) | ||
| Line 799: | Line 799: | ||
CEGUI.toRenderQueueEventArgs(e) | CEGUI.toRenderQueueEventArgs(e) | ||
| − | ==LUA Helpers Windows== | + | == LUA Helpers Windows == |
These helpers helps casting the window member of most event arguments. | These helpers helps casting the window member of most event arguments. | ||
CEGUI.toCombobox(w) | CEGUI.toCombobox(w) | ||
Revision as of 15:07, 26 February 2011
This page is intended to give experienced users of CEGUI a chance to easily lookup what events are a available for different objects. See EventGalore for more information how to use the most common events, Identifying Multiple Event Sources From A Single Callback and is a page that shows how to cast the events to correct type. The same for LUA is described in this page Handling Events from Lua.
Contents
- 1 Events by object
- 1.1 Window
- 1.2 Checkbox
- 1.3 Combobox
- 1.4 ComboDropList
- 1.5 DragContainer
- 1.6 Editbox
- 1.7 FrameWindow
- 1.8 ItemEntry
- 1.9 ItemListBase
- 1.10 ItemListbox
- 1.11 Listbox
- 1.12 ListHeader
- 1.13 ListHeaderSegment
- 1.14 MenuBase
- 1.15 MenuItem
- 1.16 MouseCursor
- 1.17 MultiColumnList
- 1.18 MultiLineEditbox
- 1.19 ProgressBar
- 1.20 PushButton
- 1.21 Radiobutton
- 1.22 ScrollablePane
- 1.23 Scrollbar
- 1.24 ScrolledContainer
- 1.25 ScrolledItemListBase
- 1.26 Slider
- 1.27 Spinner
- 1.28 TabButton
- 1.29 TabControl
- 1.30 Thumb
- 1.31 Tooltip
- 1.32 Tree
- 1.33 Renderer
- 1.34 System
- 2 Event Arguments
- 3 LUA Helpers Args
- 4 LUA Helpers Windows
Events by object
Window
| Event | Scripted Event | Event Arg | Fired when ... |
|---|---|---|---|
| Window::EventActivated | "Activated" | ActivationEventArgs | |
| Window::EventAlphaChanged | "AlphaChanged" | WindowEventArgs | |
| Window::EventAlwaysOnTopChanged | "AlwaysOnTopChanged" | WindowEventArgs | |
| Window::EventCharacterKey | "CharacterKey" | KeyEventArgs | |
| Window::EventChildAdded | "AddedChild" | WindowEventArgs | |
| Window::EventChildRemoved | "RemovedChild" | WindowEventArgs | |
| Window::EventClippedByParentChanged | "ClippingChanged" | WindowEventArgs | |
| Window::EventDeactivated | "Deactivated" | ActivationEventArgs | |
| Window::EventDestroyedByParentChanged | "DestroyedByParentChanged" | WindowEventArgs | |
| Window::EventDestructionStarted | "DestructStart" | WindowEventArgs | |
| Window::EventDisabled | "Disabled" | WindowEventArgs | |
| Window::EventDragDropItemDropped | "DragDropItemDropped" | DragDropEventArgs | the item has been dropped on the window. |
| Window::EventDragDropItemEnters | "DragDropItemEnters" | DragDropEventArgs | a drag and drop item floats over the window. |
| Window::EventDragDropItemLeaves | "DragDropItemLeaves" | DragDropEventArgs | a drag and drop item floats out of the window. |
| Window::EventEnabled | "Enabled" | WindowEventArgs | |
| Window::EventFontChanged | "FontChanged" | EventArgs | |
| Window::EventHidden | "Hidden" | WindowEventArgs | |
| Window::EventHorizontalAlignmentChanged | "HorizontalAlignmentChanged" | WindowEventArgs | |
| Window::EventIDChanged | "IDChanged" | WindowEventArgs | |
| Window::EventInheritsAlphaChanged | "InheritAlphaChanged" | WindowEventArgs | |
| Window::EventInputCaptureGained | "CaptureGained" | WindowEventArgs | |
| Window::EventInputCaptureLost | "CaptureLost" | WindowEventArgs | |
| Window::EventKeyDown | "KeyDown" | KeyEventArgs | |
| Window::EventKeyUp | "KeyUp" | KeyEventArgs | |
| Window::EventMouseButtonDown | "MouseButtonDown" | MouseEventArgs | |
| Window::EventMouseButtonUp | "MouseButtonUp" | MouseEventArgs | |
| Window::EventMouseClick | "MouseClick" | MouseEventArgs | |
| Window::EventMouseDoubleClick | "MouseDoubleClick" | MouseEventArgs | |
| Window::EventMouseEnters | "MouseEnter" | MouseEventArgs | the mouse enters the widget |
| Window::EventMouseLeaves | "MouseLeave" | MouseEventArgs | when the mouse leaves the widget |
| Window::EventMouseMove | "MouseMove" | MouseEventArgs | |
| Window::EventMouseTripleClick | "MouseTripleClick" | MouseEventArgs | |
| Window::EventMouseWheel | "MouseWheel" | MouseEventArgs | |
| Window::EventMoved | "Moved" | WindowEventArgs | |
| Window::EventRenderingEnded | "EndRender" | WindowEventArgs | |
| Window::EventRenderingStarted | "StartRender" | WindowEventArgs | |
| Window::EventWindowRendererAttached | "WindowRendererAttached" | WindowEventArgs | |
| Window::EventWindowRendererDetached | "WindowRendererDetached" | WindowEventArgs | |
| Window::EventShown | "Shown" | WindowEventArgs | |
| Window::EventSized | "Sized" | WindowEventArgs | |
| Window::EventTextChanged | "TextChanged" | WindowEventArgs | |
| Window::EventVerticalAlignmentChanged | "VerticalAlignmentChanged" | WindowEventArgs | |
| Window::EventWindowUpdated | "WindowUpdate | UpdateEventArgs | |
| Window::EventZOrderChanged | "ZChanged" | WindowEventArgs |
Checkbox
Inherits events from Window
| Checkbox::EventCheckStateChanged | "CheckStateChanged" | WindowEventArgs | the checkbox got checked or un-checked |
Combobox
Inherits events from Window
| Combobox::EventCaratMoved | "CaratMoved" | WindowEventArgs | |
| Combobox::EventDropListDisplayed | "DropListDisplayed" | WindowEventArgs | |
| Combobox::EventDropListRemoved | "DropListRemoved" | WindowEventArgs | |
| Combobox::EventEditboxFull | "EditboxFullEvent" | WindowEventArgs | |
| Combobox::EventHorzScrollbarModeChanged | "HorzScrollbarModeChanged" | WindowEventArgs | |
| Combobox::EventInvalidEntryAttempted | "InvalidEntryAttempted" | WindowEventArgs | |
| Combobox::EventListContentsChanged | "ListContentsChanged" | WindowEventArgs | |
| Combobox::EventListSelectionAccepted | "ListSelectionAccepted" | WindowEventArgs | |
| Combobox::EventListSelectionChanged | "ListSelectionChanged" | WindowEventArgs | |
| Combobox::EventMaximumTextLengthChanged | "MaximumTextLengthChanged" | WindowEventArgs | |
| Combobox::EventReadOnlyModeChanged | "ReadOnlyChanged" | WindowEventArgs | |
| Combobox::EventSortModeChanged | "SortModeChanged" | WindowEventArgs | |
| Combobox::EventTextAccepted | "TextAcceptedEvent" | WindowEventArgs | |
| Combobox::EventTextInvalidated | "TextInvalidatedEvent" | WindowEventArgs | |
| Combobox::EventTextSelectionChanged | "TextSelectionChanged" | WindowEventArgs | |
| Combobox::EventValidationStringChanged | "ValidationStringChanged" | WindowEventArgs | |
| Combobox::EventVertScrollbarModeChanged | "VertScrollbarModeChanged" | WindowEventArgs |
ComboDropList
Inherits events from: Listbox
| ComboDropList::EventListSelectionAccepted | "ListSelectionAccepted" | WindowEventArgs |
DragContainer
Inherits events from Window
| DragContainer::EventDragAlphaChanged | "DragAlphaChanged" | WindowEventArgs | |
| DragContainer::EventDragDropTargetChanged | "DragDropTargetChanged" | DragDropEventArgs | |
| DragContainer::EventDragEnabledChanged | "DragEnabledChanged" | WindowEventArgs | |
| DragContainer::EventDragEnded | "DragEnded" | WindowEventArgs | |
| DragContainer::EventDragMouseCursorChanged | "DragMouseCursorChanged" | WindowEventArgs | |
| DragContainer::EventDragPositionChanged | "DragPositionChanged" | WindowEventArgs | |
| DragContainer::EventDragStarted | "DragStarted" | WindowEventArgs | |
| DragContainer::EventDragThresholdChanged | "DragThresholdChanged" | WindowEventArgs |
Editbox
Inherits events from Window
| Editbox::EventEditboxFull | "EditboxFull" | WindowEventArgs | |
| Editbox::EventInvalidEntryAttempted | "InvalidInputAttempt" | WindowEventArgs | |
| Editbox::EventMaskCodePointChanged | "MaskCPChanged" | WindowEventArgs | |
| Editbox::EventMaskedRenderingModeChanged | "MaskRenderChanged" | WindowEventArgs | |
| Editbox::EventMaximumTextLengthChanged | "MaxTextLenChanged" | WindowEventArgs | |
| Editbox::EventReadOnlyModeChanged | "ReadOnlyChanged" | WindowEventArgs | |
| Editbox::EventTextAccepted | "TextAccepted" | WindowEventArgs | |
| Editbox::EventCaratMoved | "TextCaratMoved" | WindowEventArgs | |
| Editbox::EventTextInvalidated | "TextInvalidated" | WindowEventArgs | |
| Editbox::EventTextSelectionChanged | "TextSelectChanged" | WindowEventArgs | |
| Editbox::EventValidationStringChanged | "ValidatorChanged" | WindowEventArgs |
FrameWindow
Inherits events from Window
| FrameWindow::EventRollupToggled | "RollupToggled" | WindowEventArgs | |
| FrameWindow::EventCloseClicked | "CloseClicked" | WindowEventArgs |
ItemEntry
Inherits events from Window
| ItemEntry::EventSelectionChanged | "SelectionChanged" | WindowEventArgs |
ItemListBase
Inherits events from Window
| ItemListBase::EventListContentsChanged | "ListItemsChanged" | WindowEventArgs | |
| ItemListBase::EventSortEnabledChanged | "SortEnabledChanged" | WindowEventArgs | |
| ItemListBase::EventSortModeChanged | "SortModeChanged" | WindowEventArgs |
ItemListbox
Inherists events from ScrolledItemListBase, ItemListBase, Window
| ItemListbox::EventMultiSelectModeChanged | "MultiSelectModeChanged" | WindowEventArgs | |
| ItemListbox::EventSelectionChanged | "SelectionChanged" | WindowEventArgs |
Listbox
Inherits events from Window
| Listbox::EventListContentsChanged | "ListItemsChanged" | WindowEventArgs | |
| Listbox::EventSelectionChanged | "ItemSelectionChanged" | WindowEventArgs | |
| Listbox::EventSortModeChanged | "SortModeChanged" | WindowEventArgs | |
| Listbox::EventMultiselectModeChanged | "MuliselectModeChanged" | WindowEventArgs | |
| Listbox::EventVertScrollbarModeChanged | "VertScrollModeChanged" | WindowEventArgs | |
| Listbox::EventHorzScrollbarModeChanged | "HorzScrollModeChanged" | WindowEventArgs |
ListHeader
Inherits events from Window
| ListHeader::EventSortColumnChanged | "SortColumnChanged" | WindowEventArgs | |
| ListHeader::EventSortDirectionChanged | "SortDirectionChanged" | WindowEventArgs | |
| ListHeader::EventSegmentSized | "SegmentSized" | WindowEventArgs | |
| ListHeader::EventSegmentClicked | "SegmentClicked" | WindowEventArgs | |
| ListHeader::EventSplitterDoubleClicked | "SplitterDoubleClicked" | WindowEventArgs | |
| ListHeader::EventSegmentSequenceChanged | "SegmentSequenceChanged" | WindowEventArgs | |
| ListHeader::EventSegmentAdded | "SegmentAdded" | WindowEventArgs | |
| ListHeader::EventSegmentRemoved | "SegmentRemoved" | WindowEventArgs | |
| ListHeader::EventSortSettingChanged | "SortSettingChanged" | WindowEventArgs | |
| ListHeader::EventDragMoveSettingChanged | "DragMoveSettingChanged" | WindowEventArgs | |
| ListHeader::EventDragSizeSettingChanged | "DragSizeSettingChanged" | WindowEventArgs | |
| ListHeader::EventSegmentRenderOffsetChanged | "SegmentOffsetChanged" | WindowEventArgs |
ListHeaderSegment
Inherits events from Window
| ListHeaderSegment::EventSegmentClicked | "SegmentClicked" | WindowEventArgs | |
| ListHeaderSegment::EventSplitterDoubleClicked | "SplitterDoubleClicked" | WindowEventArgs | |
| ListHeaderSegment::EventSizingSettingChanged | "SizingSettingChanged" | WindowEventArgs | |
| ListHeaderSegment::EventSortDirectionChanged | "SortDirectionChanged" | WindowEventArgs | |
| ListHeaderSegment::EventMovableSettingChanged | "MovableSettingChanged" | WindowEventArgs | |
| ListHeaderSegment::EventSegmentDragStart | "SegmentDragStart" | WindowEventArgs | |
| ListHeaderSegment::EventSegmentDragStop | "SegmentDragStop" | WindowEventArgs | |
| ListHeaderSegment::EventSegmentDragPositionChanged | "SegmentDragPositionChanged" | WindowEventArgs | |
| ListHeaderSegment::EventSegmentSized | "SegmentSized" | WindowEventArgs | |
| ListHeaderSegment::EventClickableSettingChanged | "ClickableSettingChanged" | WindowEventArgs |
MenuBase
Inherits events from ItemListBase, Window
| MenuBase::EventPopupOpened | "PopupOpened" | WindowEventArgs | |
| MenuBase::EventPopupClosed | "PopupClosed" | WindowEventArgs |
MenuItem
Inherits events from ItemEntry, Window
| MenuItem::EventClicked | "Clicked" | WindowEventArgs |
MouseCursor
| MouseCursor::EventImageChanged | "ImageChanged" | MouseCursorEventArgs |
MultiColumnList
Inherits events from Window
| MultiColumnList::EventSelectionModeChanged | "SelectModeChanged" | WindowEventArgs | |
| MultiColumnList::EventNominatedSelectColumnChanged | "NomSelColChanged" | WindowEventArgs | |
| MultiColumnList::EventNominatedSelectRowChanged | "NomSelRowChanged" | WindowEventArgs | |
| MultiColumnList::EventVertScrollbarModeChanged | "VertBarModeChanged" | WindowEventArgs | |
| MultiColumnList::EventHorzScrollbarModeChanged | "HorzBarModeChanged" | WindowEventArgs | |
| MultiColumnList::EventSelectionChanged | "SelectionChanged" | WindowEventArgs | |
| MultiColumnList::EventListContentsChanged | "ContentsChanged" | WindowEventArgs | |
| MultiColumnList::EventSortColumnChanged | "SortColChanged" | WindowEventArgs | |
| MultiColumnList::EventSortDirectionChanged | "SortDirChanged" | WindowEventArgs | |
| MultiColumnList::EventListColumnSized | "ColSized" | WindowEventArgs | |
| MultiColumnList::EventListColumnMoved | "ColMoved" | WindowEventArgs |
MultiLineEditbox
Inherits events from Window
| MultiLineEditbox::EventReadOnlyModeChanged | "ReadOnlyChanged" | WindowEventArgs | |
| MultiLineEditbox::EventWordWrapModeChanged | "WordWrapModeChanged" | WindowEventArgs | |
| MultiLineEditbox::EventMaximumTextLengthChanged | "MaximumTextLengthChanged" | WindowEventArgs | |
| MultiLineEditbox::EventCaratMoved | "CaratMoved" | WindowEventArgs | |
| MultiLineEditbox::EventTextSelectionChanged | "TextSelectionChanged" | WindowEventArgs | |
| MultiLineEditbox::EventEditboxFull | "EditboxFullEvent" | WindowEventArgs | |
| MultiLineEditbox::EventVertScrollbarModeChanged | "VertScrollbarModeChanged" | WindowEventArgs | |
| MultiLineEditbox::EventHorzScrollbarModeChanged | "HorzScrollbarModeChanged" | WindowEventArgs |
ProgressBar
Inherits events from Window
| PorgressBar::EventProgressChanged | "ProgressChanged" | WindowEventArgs | |
| PorgressBar::EventProgressDone | "ProgressDone" | WindowEventArgs |
PushButton
Inherits events from Window
| PushButton::EventClicked | "Clicked" | WindowEventArgs | the button has been clicked. |
Radiobutton
Inherits events from Window
| RadioButton::EventSelectStateChanged | "SelectStateChanged" | WindowEventArgs |
ScrollablePane
Inherits events from Window
| ScrollablePane::EventAutoSizeSettingChanged | "AutoSizeSettingChanged" | WindowEventArgs | |
| ScrollablePane::EventContentPaneChanged | "ContentPaneChanged" | WindowEventArgs | |
| ScrollablePane::EventContentPaneScrolled | "ContentPaneScrolled" | WindowEventArgs | |
| ScrollablePane::EventHorzScrollbarModeChanged | "HorzScrollbarModeChanged" | WindowEventArgs | |
| ScrollablePane::EventVertScrollbarModeChanged | "VertScrollbarModeChanged" | WindowEventArgs |
Scrollbar
Inherits events from Window
| Scrollbar::EventScrollConfigChanged | "ScrollConfigChanged" | WindowEventArgs | |
| Scrollbar::EventScrollPositionChanged | "ScrollPosChanged" | WindowEventArgs | |
| Scrollbar::EventThumbTrackStarted | "ThumbTrackStarted" | WindowEventArgs | |
| Scrollbar::EventThumbTrackEnded | "ThumbTrackEnded" | WindowEventArgs |
ScrolledContainer
Inherits events from Window
| ScrolledContainer::EventAutoSizeSettingChanged | "AutoSizeSettingChanged" | WindowEventArgs | |
| ScrolledContainer::EventContentChanged | "ContentChanged" | WindowEventArgs |
ScrolledItemListBase
Inherits events from ItemListBase, Window
| ScrolledItemListBase::EventHorzScrollbarModeChanged | "HorzScrollbarModeChanged" | WindowEventArgs | |
| ScrolledItemListBase::EventVertScrollbarModeChanged | "VertScrollbarModeChanged" | WindowEventArgs |
Slider
Inherits events from Window
| Slider::EventThumbTrackEnded | "ThumbTrackEnded" | WindowEventArgs | |
| Slider::EventThumbTrackStarted | "ThumbTrackStarted" | WindowEventArgs | |
| Slider::EventValueChanged | "ValueChanged" | WindowEventArgs |
Spinner
Inherits events from Window
| Spinner::EventMaximumValueChanged | "MaximumValueChanged" | WindowEventArgs | |
| Spinner::EventMinimumValueChanged | "MinimumValueChanged" | WindowEventArgs | |
| Spinner::EventStepChanged | "StepChanged" | WindowEventArgs | |
| Spinner::EventTextInputModeChanged | "TextInputModeChanged" | WindowEventArgs | |
| Spinner::EventValueChanged | "ValueChanged" | WindowEventArgs |
TabButton
Inherits events from Window
| Tabbutton::EventClicked | "Clicked" | WindowEventArgs | |
| Tabbutton::EventDragged | "Dragged" | MouseEventArgs | |
| Tabbutton::EventScrolled | "Scrolled" | MouseEventArgs |
TabControl
Inherits events from Window
| TabControl::EventSelectionChanged | "TabSelectionChanged" | WindowEventArgs |
Thumb
Inherits events from PushButton, Window
| Thumb::EventThumbPositionChanged | "ThumbPosChanged" | WindowEventArgs | |
| Thumb::EventThumbTrackEnded | "ThumbTrackEnded" | WindowEventArgs | |
| Thumb::EventThumbTrackStarted | "ThumbTrackStarted" | WindowEventArgs |
Tooltip
inherits events from Window
| Tooltip::EventHoverTimeChanged | "HoverTimeChanged" | WindowEventArgs | |
| Tooltip::EventDisplayTimeChanged | "DisplayTimeChanged" | WindowEventArgs | |
| Tooltip::EventFadeTimeChanged | "FadeTimeChanged" | WindowEventArgs | |
| Tooltip::EventTooltipActive | "TooltipActive" | WindowEventArgs | |
| Tooltip::EventTooltipInactive | "TooltipInactive" | WindowEventArgs |
Tree
Inherits events from Window
| Tree::EventListContentsChanged | "ListItemsChanged" | WindowEventArgs | |
| Tree::EventSelectionChanged | "ItemSelectionChanged" | WindowEventArgs | |
| Tree::EventSortModeChanged | "SortModeChanged" | WindowEventArgs | |
| Tree::EventMultiselectModeChanged | "MuliselectModeChanged" | WindowEventArgs | |
| Tree::EventVertScrollbarModeChanged | "VertScrollModeChanged" | WindowEventArgs | |
| Tree::EventHorzScrollbarModeChanged | "HorzScrollModeChanged" | WindowEventArgs | |
| Tree::EventBranchOpened | "BranchOpened" | TreeEventArgs | |
| Tree::EventBranchClosed | "BranchClosed" | TreeEventArgs |
Renderer
| Renderer::EventDisplaySizeChanged | "DisplayModeChanged" | EventArgs |
System
| System::EventGUISheetChanged | "GUISheetChanged" | WindowEventArgs | |
| System::EventSingleClickTimeoutChanged | "SingleClickTimeoutChanged" | EventArgs | |
| System::EventMultiClickTimeoutChanged | "MultiClickTimeoutChanged" | EventArgs | |
| System::EventMultiClickAreaSizeChanged | "MultiClickAreaSizeChanged" | EventArgs | |
| System::EventDefaultFontChanged | "DefaultFontChanged" | EventArgs | |
| System::EventDefaultMouseCursorChanged | "DefaultMouseCursorChanged" | EventArgs | |
| System::EventMouseMoveScalingChanged | "MouseMoveScalingChanged" | EventArgs |
Event Arguments
EventArgs
bool handled bool d_hasWindow
WindowEventArgs
bool handled bool d_hasWindow Window* window
UpdateEventArgs
bool handled bool d_hasWindow Window* window float d_timeSinceLastFrame
MouseEventArgs
bool handled bool d_hasWindow Window* window Point position Vector2 moveDelta MouseButton button uint sysKeys float wheelChange uint clickCount
MouseCursorEventArgs
bool handled bool d_hasWindow MouseCursor* mouseCursor const Image* image
KeyEventArgs
bool handled bool d_hasWindow Window* window utf32 codepoint Key::Scan scancode uint sysKeys
ActivationEventArgs
bool handled bool d_hasWindow Window* window Window* otherWindow
DragDropEventArgs
bool handled bool d_hasWindow Window* window DragContainer* dragDropItem
TreeEventArgs
bool handled bool d_hasWindow Window* window TreeItem *treeItem;
LUA Helpers Args
These helpers are usable in lua to cast event arguments to correct type.
CEGUI.toMouseCursorEventArgs(e) CEGUI.toWindowEventArgs(e) CEGUI.toActivationEventArgs(e) CEGUI.toHeaderSequenceEventArgs(e) CEGUI.toMouseEventArgs(e) CEGUI.toKeyEventArgs(e) CEGUI.toDragDropEventArgs(e) CEGUI.toTreeEventArgs(e) CEGUI.toRenderQueueEventArgs(e)
LUA Helpers Windows
These helpers helps casting the window member of most event arguments.
CEGUI.toCombobox(w) CEGUI.toComboDropList(w) CEGUI.toDragContainer(w) CEGUI.toEditbox(w) CEGUI.toFrameWindow(w) CEGUI.toGUISheet(w) CEGUI.toItemEntry(w) CEGUI.toItemListBase(w) CEGUI.toItemListbox(w) CEGUI.toListbox(w) CEGUI.toListHeader(w) CEGUI.toListHeaderSegment(w) CEGUI.toMenubar(w) CEGUI.toMenuBase(w) CEGUI.toMenuItem(w) CEGUI.toMultiColumnList(w) CEGUI.toMultiLineEditbox(w) CEGUI.toPopupMenu(w) CEGUI.toProgressBar(w) CEGUI.toPushButton(w) CEGUI.toRadioButton(w) CEGUI.toScrollablePane(w) CEGUI.toScrollbar(w) CEGUI.toScrolledContainer(w) CEGUI.toScrolledItemListBase(w) CEGUI.toSlider(w) CEGUI.toSpinner(w) CEGUI.toTabButton(w) CEGUI.toTabControl(w) CEGUI.toTabPane(w) CEGUI.toThumb(w) CEGUI.toTooltip(w) CEGUI.toTree(w)
