Open Dev Kit Documentation :: GUI :: Control
GUI.ControlBase class for all UI controls
Enumerations
- Control Alignment
- Control alignment options
- Control Theme
- Control theme options
Functions
- Copy ( Other Control )
- Destroy Children ( )
- Clears and destroys children controls
- Change Parent ( New Parent Control*, Insert Index Integer )
- Removes control from previous parent and inserts it at a specific index in the same or new parent
- Get All Children ( ) Control* Array
- all nested children controls
- Find Child ( Class API Node*, Name String, Index Integer ) Control*
- Find child control with specified criteria
- Refresh Control ( Area Rectangle )
- Forces control to re-paint itself
- Update Size ( )
- Updates container size and its children's sizes
- Get Absolute Position ( Control Control*, Border Boolean ) 2D Vector
- Returns the absolute position of a control relative to the screen or another control
Properties
- Owner Resource Object Resource*
- resource that created this instance
- Index Integer
- index number of a control array
- Parent Control Control'
- parent control
- Children Control* Array
- children controls
- Next Control Control*
- next sibling control
- Previous Control Control*
- previous sibling control
- Window Window'
- parented window, changes with re-parenting
- Refresh Children Boolean
- it should refresh immediately when children controls are added
- Visible Boolean
- if control is visible
- Enabled Boolean
- control can be interacted with
- Focused Boolean
- control has keyboard focus or not
- Tooltip Text Localized String
- tooltip text of the control
- Cached Boolean
- if the control's position/size has been cached
- Position 2D Vector
- position of the control
- Cached Position 2D Vector
- position of the control that was assigned prior to container organization
- Size 2D Vector
- size of the control
- Cached Size 2D Vector
- size of the control that was assigned prior to container organization
- Total Size 2D Vector
- size of the control including its borders
- Border Integer
- margin/border/padding of the control
- Editor Border Integer
- border including editor padding
- Alignment Control Alignment
- alignment of the control
- Weight Integer
- weight of the control
- Cursor Icon Cursor Icon
- mouse cursor when hovering over control
- Cursor Constrain Boolean
- constrains cursor to window when focused
- Theme Control Theme
- manner in which theming gets applied
- Font Font Parameters
- text font of the control
- Background Color Color
- background color of the control
- Text Color Color
- text color of the control
- Render Context Render Context*
- drawing context
- Unproject Mouse Cursor 2D Vector
- cursor position relative to control
Events
- Clicked ( Position 2D Vector, Button Mouse Button )
- Triggers when the control is clicked
- Resized ( )
- Triggers when the control is resized
- Double Clicked ( Position 2D Vector, Button Mouse Button )
- Triggers when the control is double dlicked
- Focus Gained ( )
- Triggers when the control is selected
- Focus Lost ( )
- Triggers when the control is deselected
- Mouse Pressed ( Position 2D Vector, Button Mouse Button )
- Triggers when the mouse button or touch is pressed
- Mouse Entered ( Position 2D Vector )
- Triggers when the cursor enters the control
- Mouse Moved ( Position 2D Vector, Button Mouse Button )
- Triggers when the cursor moves inside the control
- Mouse Left ( Position 2D Vector )
- Triggers when the cursor leaves the control
- Mouse Released ( Position 2D Vector, Button Mouse Button )
- Triggers when the mouse button or touch is released
- Mouse Scrolled ( Position 2D Vector, Delta 2D Vector )
- Triggers when the mouse wheel is used
- Gesture Completed ( )
- Triggers when a specified gesture is performed
- Key Pressed ( Key Keyboard Key )
- Triggers when a key is pressed
- Character Typed ( Character String )
- Triggers when a character is typed on the keyboard
- Key Released ( Key Keyboard Key )
- Triggers when a key is released
- Editor Mouse Pressed ( Position 2D Vector, Button Mouse Button )
- Triggers when a mouse button is pressed in the editor
- Editor Mouse Moved ( Position 2D Vector, Button Mouse Button )
- Triggers when the mouse cursor is moved in the editor
- Editor Mouse Released ( Position 2D Vector, Button Mouse Button )
- Triggers when a mouse button is released in the editor
- Editor Key Pressed ( Key Keyboard Key )
- Triggers when a key is pressed in the editor
- Editor Key Released ( Key Keyboard Key )
- Triggers when a key is released in the editor
- Editor Character Typed ( Character String )
- Triggers when a character is typed in the editor
- Editor Double Clicked ( )
- Triggers when an editor element is double-clicked
If you think anything is missing, please feel free to: submit documentation feedback on this page