GUI Event Reference

Table of Contents

• Events by object
  • Window
  • Checkbox
  • Combobox
  • ComboDropList
  • DragContainer
  • Editbox
  • FrameWindow
  • ItemEntry
  • ItemListBase
  • ItemListbox
  • Listbox
  • ListHeader
  • ListHeaderSegment
  • MenuBase
  • MenuItem
  • MouseCursor
  • MultiColumnList
  • MultiLineEditbox
  • ProgressBar
  • PushButton
  • Radiobutton
  • ScrollablePane
  • Scrollbar
  • ScrolledContainer
  • ScrolledItemListBase
  • Slider
  • Spinner
  • TabButton
  • TabControl
  • Thumb
  • Tooltip
  • Tree
  • Renderer
  • System
• Event Arguments
  • EventArgs
  • WindowEventArgs
  • UpdateEventArgs
  • MouseEventArgs
  • MouseCursorEventArgs
  • KeyEventArgs
  • ActivationEventArgs
  • DragDropEventArgs
  • TreeEventArgs
• Simkin Helpers: Event Arguments
• Simkin Helpers: Windows

This page provides a lookup list of events available for different widgets.

Handling GUI Events from Simkin is a page that shows how to bind script methods to events and cast the event arguments to the correct type.

Events by object

Window

Event Name	Event Arg
Activated	ActivationEventArgs
AlphaChanged	WindowEventArgs
AlwaysOnTopChanged	WindowEventArgs
CharacterKey	KeyEventArgs
AddedChild	WindowEventArgs
RemovedChild	WindowEventArgs
ClippingChanged	WindowEventArgs
Deactivated	ActivationEventArgs
DestroyedByParentChanged	WindowEventArgs
DestructStart	WindowEventArgs
Disabled	WindowEventArgs
DragDropItemDropped	DragDropEventArgs
DragDropItemEnters	DragDropEventArgs
DragDropItemLeaves	DragDropEventArgs
Enabled	WindowEventArgs
FontChanged	EventArgs
Hidden	WindowEventArgs
HorizontalAlignmentChanged	WindowEventArgs
IDChanged	WindowEventArgs
InheritAlphaChanged	WindowEventArgs
CaptureGained	WindowEventArgs
CaptureLost	WindowEventArgs
KeyDown	KeyEventArgs
KeyUp	KeyEventArgs
MouseButtonDown	MouseEventArgs
MouseButtonUp	MouseEventArgs
MouseClick	MouseEventArgs
MouseDoubleClick	MouseEventArgs
MouseEnter	MouseEventArgs
MouseLeave	MouseEventArgs
MouseMove	MouseEventArgs
MouseTripleClick	MouseEventArgs
MouseWheel	MouseEventArgs
Moved	WindowEventArgs
EndRender	WindowEventArgs
StartRender	WindowEventArgs
WindowRendererAttached	WindowEventArgs
WindowRendererDetached	WindowEventArgs
Shown	WindowEventArgs
Sized	WindowEventArgs
TextChanged	WindowEventArgs
VerticalAlignmentChanged	WindowEventArgs
WindowUpdate	UpdateEventArgs
ZChanged	WindowEventArgs

Checkbox

Inherits events from Window

Event Name	Event Arg
CheckStateChanged	WindowEventArgs

Combobox

Inherits events from Window

Event Name	Event Arg
CaratMoved	WindowEventArgs
DropListDisplayed	WindowEventArgs
DropListRemoved	WindowEventArgs
EditboxFullEvent	WindowEventArgs
HorzScrollbarModeChanged	WindowEventArgs
InvalidEntryAttempted	WindowEventArgs
ListContentsChanged	WindowEventArgs
ListSelectionAccepted	WindowEventArgs
ListSelectionChanged	WindowEventArgs
MaximumTextLengthChanged	WindowEventArgs
ReadOnlyChanged	WindowEventArgs
SortModeChanged	WindowEventArgs
TextAcceptedEvent	WindowEventArgs
TextInvalidatedEvent	WindowEventArgs
TextSelectionChanged	WindowEventArgs
ValidationStringChanged	WindowEventArgs
VertScrollbarModeChanged	WindowEventArgs

ComboDropList

Inherits events from Listbox

Event Name	Event Arg
ListSelectionAccepted	WindowEventArgs

DragContainer

Inherits events from Window

Event Name	Event Arg
DragAlphaChanged	WindowEventArgs
DragDropTargetChanged	DragDropEventArgs
DragEnabledChanged	WindowEventArgs
DragEnded	WindowEventArgs
DragMouseCursorChanged	WindowEventArgs
DragPositionChanged	WindowEventArgs
DragStarted	WindowEventArgs
DragThresholdChanged	WindowEventArgs

Editbox

Inherits events from Window

Event Name	Event Arg
EditboxFull	WindowEventArgs
InvalidInputAttempt	WindowEventArgs
MaskCPChanged	WindowEventArgs
MaskRenderChanged	WindowEventArgs
MaxTextLenChanged	WindowEventArgs
ReadOnlyChanged	WindowEventArgs
TextAccepted	WindowEventArgs
TextCaratMoved	WindowEventArgs
TextInvalidated	WindowEventArgs
TextSelectChanged	WindowEventArgs
ValidatorChanged	WindowEventArgs

FrameWindow

Inherits events from Window

Event Name	Event Arg
RollupToggled	WindowEventArgs
CloseClicked	WindowEventArgs

ItemEntry

Inherits events from Window

Event Name	Event Arg
SelectionChanged	WindowEventArgs

ItemListBase

Inherits events from Window

Event Name	Event Arg
ListItemsChanged	WindowEventArgs
SortEnabledChanged	WindowEventArgs
SortModeChanged	WindowEventArgs

ItemListbox

Inherists events from ScrolledItemListBase, ItemListBase, Window

Event Name	Event Arg
MultiSelectModeChanged	WindowEventArgs
SelectionChanged	WindowEventArgs

Listbox

Inherits events from Window

Event Name	Event Arg
ListItemsChanged	WindowEventArgs
ItemSelectionChanged	WindowEventArgs
SortModeChanged	WindowEventArgs
MuliselectModeChanged	WindowEventArgs
VertScrollModeChanged	WindowEventArgs
HorzScrollModeChanged	WindowEventArgs

ListHeader

Inherits events from Window

Event Name	Event Arg
SortColumnChanged	WindowEventArgs
SortDirectionChanged	WindowEventArgs
SegmentSized	WindowEventArgs
SegmentClicked	WindowEventArgs
SplitterDoubleClicked	WindowEventArgs
SegmentSequenceChanged	WindowEventArgs
SegmentAdded	WindowEventArgs
SegmentRemoved	WindowEventArgs
SortSettingChanged	WindowEventArgs
DragMoveSettingChanged	WindowEventArgs
DragSizeSettingChanged	WindowEventArgs
SegmentOffsetChanged	WindowEventArgs

ListHeaderSegment

Inherits events from Window

Event Name	Event Arg
SegmentClicked	WindowEventArgs
SplitterDoubleClicked	WindowEventArgs
SizingSettingChanged	WindowEventArgs
SortDirectionChanged	WindowEventArgs
MovableSettingChanged	WindowEventArgs
SegmentDragStart	WindowEventArgs
SegmentDragStop	WindowEventArgs
SegmentDragPositionChanged	WindowEventArgs
SegmentSized	WindowEventArgs
ClickableSettingChanged	WindowEventArgs

MenuBase

Inherits events from ItemListBase, Window

Event Name	Event Arg
PopupOpened	WindowEventArgs
PopupClosed	WindowEventArgs

MenuItem

Inherits events from ItemEntry, Window

Event Name	Event Arg
Clicked	WindowEventArgs

MouseCursor

Event Name	Event Arg
ImageChanged	MouseCursorEventArgs

MultiColumnList

Inherits events from Window

Event Name	Event Arg
SelectModeChanged	WindowEventArgs
NomSelColChanged	WindowEventArgs
NomSelRowChanged	WindowEventArgs
VertBarModeChanged	WindowEventArgs
HorzBarModeChanged	WindowEventArgs
SelectionChanged	WindowEventArgs
ContentsChanged	WindowEventArgs
SortColChanged	WindowEventArgs
SortDirChanged	WindowEventArgs
ColSized	WindowEventArgs
ColMoved	WindowEventArgs

MultiLineEditbox

Inherits events from Window

Event Name	Event Arg
ReadOnlyChanged	WindowEventArgs
WordWrapModeChanged	WindowEventArgs
MaximumTextLengthChanged	WindowEventArgs
CaratMoved	WindowEventArgs
TextSelectionChanged	WindowEventArgs
EditboxFullEvent	WindowEventArgs
VertScrollbarModeChanged	WindowEventArgs
HorzScrollbarModeChanged	WindowEventArgs

ProgressBar

Inherits events from Window

Event Name	Event Arg
ProgressChanged	WindowEventArgs
ProgressDone	WindowEventArgs

PushButton

Inherits events from Window

Event Name	Event Arg
Clicked	WindowEventArgs

Radiobutton

Inherits events from Window

Event Name	Event Arg
SelectStateChanged	WindowEventArgs

ScrollablePane

Inherits events from Window

Event Name	Event Arg
AutoSizeSettingChanged	WindowEventArgs
ContentPaneChanged	WindowEventArgs
ContentPaneScrolled	WindowEventArgs
HorzScrollbarModeChanged	WindowEventArgs
VertScrollbarModeChanged	WindowEventArgs

Scrollbar

Inherits events from Window

Event Name	Event Arg
ScrollConfigChanged	WindowEventArgs
ScrollPosChanged	WindowEventArgs
ThumbTrackStarted	WindowEventArgs
ThumbTrackEnded	WindowEventArgs

ScrolledContainer

Inherits events from Window

Event Name	Event Arg
AutoSizeSettingChanged	WindowEventArgs
ContentChanged	WindowEventArgs

ScrolledItemListBase

Inherits events from ItemListBase, Window

Event Name	Event Arg
HorzScrollbarModeChanged	WindowEventArgs
VertScrollbarModeChanged	WindowEventArgs

Slider

Inherits events from Window

Event Name	Event Arg
ThumbTrackEnded	WindowEventArgs
ThumbTrackStarted	WindowEventArgs
ValueChanged	WindowEventArgs

Spinner

Inherits events from Window

Event Name	Event Arg
MaximumValueChanged	WindowEventArgs
MinimumValueChanged	WindowEventArgs
StepChanged	WindowEventArgs
TextInputModeChanged	WindowEventArgs
ValueChanged	WindowEventArgs

TabButton

Inherits events from Window

Event Name	Event Arg
Clicked	WindowEventArgs
Dragged	MouseEventArgs
Scrolled	MouseEventArgs

TabControl

Inherits events from Window

Event Name	Event Arg
TabSelectionChanged	WindowEventArgs

Thumb

Inherits events from PushButton, Window

Event Name	Event Arg
ThumbPosChanged	WindowEventArgs
ThumbTrackEnded	WindowEventArgs
ThumbTrackStarted	WindowEventArgs

Tooltip

inherits events from Window

Event Name	Event Arg
HoverTimeChanged	WindowEventArgs
DisplayTimeChanged	WindowEventArgs
FadeTimeChanged	WindowEventArgs
TooltipActive	WindowEventArgs
TooltipInactive	WindowEventArgs

Tree

Inherits events from Window

Event Name	Event Arg
ListItemsChanged	WindowEventArgs
ItemSelectionChanged	WindowEventArgs
SortModeChanged	WindowEventArgs
MuliselectModeChanged	WindowEventArgs
VertScrollModeChanged	WindowEventArgs
HorzScrollModeChanged	WindowEventArgs
BranchOpened	TreeEventArgs
BranchClosed	TreeEventArgs

Renderer

Event Name	Event Arg
DisplayModeChanged	EventArgs

System

Event Name	Event Arg
GUISheetChanged	WindowEventArgs
SingleClickTimeoutChanged	EventArgs
MultiClickTimeoutChanged	EventArgs
MultiClickAreaSizeChanged	EventArgs
DefaultFontChanged	EventArgs
DefaultMouseCursorChanged	EventArgs
MouseMoveScalingChanged	EventArgs

Event Arguments

EventArgs

Base class used as the argument of all subscribed event handlers.

bool handled
bool hasWindow

WindowEventArgs

WindowEventArgs is used for objects passed to handlers triggered for events concerning some Window object.

bool handled
bool hasWindow
Window window

UpdateEventArgs

UpdateEventArgs is used for objects passed to handlers triggered for events concerning the update of a Window object.

bool handled
bool hasWindow
Window window
float timeSinceLastFrame

MouseEventArgs

MouseEventArgs is used for objects passed to input event handlers concerning mouse input.

bool handled
bool hasWindow
Window window
Point position
Vector2 moveDelta
int button
int sysKeys
float wheelChange

MouseCursorEventArgs

MouseCursorEventArgs is used for objects passed to input event handlers concerning mouse cursor events.

bool handled
bool hasWindow
GUI::MouseCursor mouseCursor
Image image

KeyEventArgs

KeyEventArgs is used for objects passed to input event handlers concerning keyboard input.

bool handled
bool hasWindow
Window window
int codepoint
int scancode
int sysKeys

ActivationEventArgs

ActivationEventArgs is used for Activated and Deactivated window events.

bool handled
bool hasWindow
Window window
Window otherWindow

DragDropEventArgs

DragDropEventArgs is used for certain drag/drop notifications.

bool handled
bool hasWindow
Window window
DragContainer dragDropItem

TreeEventArgs

TreeEventArgs is used for objects passed to input event handlers concerning Tree events.

bool handled
bool hasWindow
Window window
TreeItem treeItem

Simkin Helpers: Event Arguments

These helpers are usable in Simkin to cast event arguments to the correct type.

GUI.toMouseCursorEventArgs(e);
GUI.toWindowEventArgs(e);
GUI.toActivationEventArgs(e);
GUI.toHeaderSequenceEventArgs(e);
GUI.toMouseEventArgs(e);
GUI.toKeyEventArgs(e);
GUI.toDragDropEventArgs(e);
GUI.toTreeEventArgs(e);

Simkin Helpers: Windows

These helpers are used to cast the window member of most event arguments.

GUI.toButtonBase(w);
GUI.toCheckbox(w);
GUI.toCombobox(w);
GUI.toComboDropList(w);
GUI.toDragContainer(w);
GUI.toEditbox(w);
GUI.toFrameWindow(w);
GUI.toGUISheet(w);
GUI.toItemEntry(w);
GUI.toItemListBase(w);
GUI.toItemListbox(w);
GUI.toListbox(w);
GUI.toListHeader(w);
GUI.toListHeaderSegment(w);
GUI.toMenubar(w);
GUI.toMenuBase(w);
GUI.toMenuItem(w);
GUI.toMultiColumnList(w);
GUI.toMultiLineEditbox(w);
GUI.toPopupMenu(w);
GUI.toProgressBar(w);
GUI.toPushButton(w);
GUI.toRadioButton(w);
GUI.toScrollablePane(w);
GUI.toScrollbar(w);
GUI.toScrolledContainer(w);
GUI.toScrolledItemListBase(w);
GUI.toSlider(w);
GUI.toSpinner(w);
GUI.toTabButton(w);
GUI.toTabControl(w);
GUI.toThumb(w);
GUI.toTooltip(w);
GUI.toTree(w);