The base structure used by all control types; a widget provides all the minimal functionalities to create a workable control. When a widget is created based on the WidgetType specified a corresponding component will be added to it extending its properties and functionalities.

Static Variables

Name	Description
`bounds`	Local bounds of the Widget.
Declaration quad bounds
`margin`	Optional margin to offset the Widget drawing.
Declaration guide margin
`history_index`	Absolute Widget bounds in window coordinates.
Declaration quad absolute
`data`	Access the Widget component data determine by the WidgetType it has been created with.
Declaration WidgetData data
`property_count`	Total amount of custom properties associated with the Widget.
Declaration unsigned char property_count
`parent`	Reference to the parent of the active Widget.
Declaration Widget *parent
`child_count`	Current number of child connected to the active Widget.
Declaration unsigned int child_count

Variables

Name	Description
`anchor`	Bit mask of AnchorState that specify to which edge(s) the Widget is anchored to.
Declaration int anchor
`priority`	Controls the priority of the Widget; the higher the value the foremost the Widget is draw on screen.
Declaration unsigned short priority
`index`	Internal sorting index used when sorting Widget.
Declaration unsigned int index
`name`	Name that identify the Widget globally.
Declaration char *name
`visible`	Toggle on/off the Widget visibility.
Declaration bool visible
`enabled`	Determine wether or not the Widget is enabled.
Declaration bool enabled
`sensitive`	Determine if the Widget is sensitive the GUI input Signal.
Declaration bool sensitive
`can_focus`	Specify if the Widget can be focused or not.
Declaration bool can_focus

Functions

Name	Description
`SetBounds`	Set the active Widget bounds.
Declaration void SetBounds( const quad bounds ) Parameters `bounds`: Set the Widget box coordinates in pixels.
`SetMargin`	Set the Widget margin offset.
Declaration void SetMargin( const guide margin ) Parameters `margin`: The margin offset of the Widget in pixels.
`SetParent`	Function to assign the parent of the active Widget.
Declaration void SetParent( Widget parent ) Parameters* `parent`: Reference of the Widget to parent to.
`ClearParent`	Clear the active Widget parent.
Declaration void ClearParent( void )
`RemoveChild`	Remove a specific child using its Widget reference as key.
Declaration bool RemoveChild( Widget child ) Parameters* `child`: Reference to the child Widget to remove. Return Value `true` if removed successfully; else return `false` if the reference is innexistent.
`RemoveChildAt`	Remove a child using its index as key.
Declaration bool RemoveChildAt( int index ) Parameters `index`: Internal index of the child Widget to remove. Return Value `true` if removed successfully; else return `false` if the index provided is invalid.
`DetachChild`	Detach a specific child from the active Widget.
Declaration bool DetachChild( Widget child ) Parameters* `child`: Reference to the child Widget to detach. Return Value `true` the child have been detached; else return `false` if the reference provided is invalid.
`GetChild`	Retrieve the reference of a child connected to the active Widget by name.
Declaration Widget GetChild( const char name ) Parameters `name`: Name of the child Widget to retrieve. Return Value `nil` if no child connected to the Widget matches the name received in parameter; else return its reference.
`GetChildIndex`	Retrieve the internal index of the child connected to the current Widget.
Declaration int GetChildIndex( const Widget child ) Parameters* `child`: Reference of the child connected to the Widget. Return Value `-1` if the child reference cannot be found else return its internal list index.
`SetChildIndex`	Change the internal index of a child connected to the active Widget.
Declaration bool SetChildIndex( Widget child, unsigned int index ) Parameters* `child`: Reference of the child to move. `index`: The new index to place to child to. Return Value `true` if the child have been moved successfully; else return `false` if the child reference or the index provided is invalid.
`GetVisibleChildIndex`	Helper that return the visible index of a child based on all previously visible Widget connected to the active one.
Declaration int GetVisibleChildIndex( const Widget child ) Parameters* `child`: Reference of the child to retrieve its visible index. Return Value `-1` if the child reference is invalid; else return its visible index.
`GetChildAt`	Retrieve a child reference using its internal index as key.
Declaration Widget GetChildAt( unsigned int index ) Parameters* `index`: Internal child index. Return Value `nil` if the index is invalid; else return the reference to the child Widget pointed by the index.
`GetRoot`	Recursively loop down the parent of a Widget for a specified amount of level(s).
Declaration Widget GetRoot( int level ) Parameters* `level`: Number of level down. Return Value Reference to the parent at `X` level down. Remarks A level value of `0` give is the same as accessing the `parent` property of the current Widget; a value of `-1` force the function to go as deep as it possibly can until no other parent is found.
`SetSignal`	Assign a Signal to the Widget to respond to.
Declaration void SetSignal( Signal signal, const char L_callback, const RunType run_type ) Parameters* `signal`: The type of Signal the Widget should be able to trigger. `L_callback`: The Lua callback function to call when the Signal occur. `run_type`: The RunType of the Signal which determine when it is executed. Note If a Signal of a specific type has already been assigned calling this function will overwrite it.
`IsPointInParentsBounds`	Helper function that check if an arbitraty point in window coordinate is inside the Widget parent bounds.
Declaration bool IsPointInParentsBounds( const ivec2 v ) Parameters `v`: Point to test against all Widget parent(s) absolute bounds. Return Value `true` if the point provided to the function is inside the Widget parent bounds; else return `false`.
`IsInParentsBounds`	Helper to test if the active Widget bounds is inside all the Widget parent bounds.
Declaration bool IsInParentsBounds( void ) Return Value `true` on success; else return `false`.
`IsContained`	Helper function that determine if a certain root is inside the Widget bounds.
Declaration bool IsContained( const Widget root ) Parameters* `root`: Reference to the root Widget to test. Return Value `true` on success; else return `false`.
`IsInParentBounds`	Helper to test if the active Widget bounds is inside its immediate parent bounds.
Declaration bool IsInParentBounds( void ) Return Value `true` on success; else return `false`.
`IsPointInBounds`	Test if a point is insize the current Widget bounds.
Declaration bool IsPointInBounds( const ivec2 v ) Parameters `v`: Point to test in window coordinate against the Widget absolute bounds. Return Value `true` on success; else return `false`.
`SetAllVisible`	Recursively set visibile or invisible all children of the Widget (including the current Widget).
Declaration void SetAllVisible( bool visible ) Parameters `visible`: Determine if the Widget and its children should visible or not.
`IsContained`	Recursively enable or disable all children of the Widget (including the current Widget).
Declaration void SetAllEnabled( bool enabled ) Parameters `enabled`: Determine if the Widget and its children should enabled or not.
`Resize`	Resize the current Widget (and all its children if any).
Declaration void Resize( const ivec2 d ) Parameters `d`: Specify the resize delta in pixels.
`SwapChildren`	Exchange the internal index of two children.
Declaration bool SwapChildren( unsigned int index0, unsigned int index1 ) Parameters `index0`: Index of the source. `index1`: Index of the destination. Return Value `true` if the swap occur successfully; return `false` if one or both index are invalid
`SortChildren`	Soft all children by their `index` property.
Declaration void SortChildren( void )
`AddProperty`	Add a new custom Property to the active Widget.
Declaration Property AddProperty( const char name, const VariableType type ) Parameters `name`: Name to identify the property. `type`: The VariableType to create. Return Value Reference to the newly created Property.
`GetProperty`	Retrieve an existing Widget Property by name.
Declaration Property GetProperty( const char name ) Parameters `name`: Name of the Property to retrieve. Return Value `nil` if no Property attached to the Widget matches the name received in parameter; else return the Property reference.
`GetPropertyAt`	Retrieve a Property using its index as key.
Declaration Property GetPropertyAt( unsigned char index ) Parameters* `index`: Index of the Property to retrieve. Return Value `nil` if the index provided is invalid; else return the Property reference.
`GetPriority`	Retreive the actual prioriy of the Widget based on its own and the one its parent(s).
Declaration unsigned short GetPriority( void ) Return Value The absolute priority of the current Widget.
`RespondToSignalL`	Retrieve wether or not the active Widget can respond to a specific Signal type.
Declaration int RespondToSignalL( Signal signal ) Parameters `signal`: The Signal to test. Return Value `-1` if the Widget does not respond to the Signal received in parameter; else return the internal Signal index.

WidgetData

A structure that allows you to manipulate the active Widget data. Using the associated data type that is represented by the WidgetType of your widget you will gain access to its variables, methods, and functions specific to that data class.

Static Variables

Name	Description
`type`	Return the object data WidgetType.
Declaration WidgetType type
`button_type`	Sub data type used by Button Widget that determine the ButtonType to use.
Declaration ButtonType button_type
`textbox_type`	Sub data type used by TextBox Widget that determine the TextBoxType to use.
Declaration TextBoxType textbox_type
`panel_type`	Sub data type used by Panel Widget that determine the PanelType to use.
Declaration PanelType panel_type
`scroller_type`	Sub data type used by Scroller Widget that determine the ScrollerType to use.
Declaration ScrollerType scroller_type
`splitter_type`	Sub data type used by Splitter Widget that determine the SplitterType to use.
Declaration SplitterType splitter_type
`button`	Access the Button component attached to the Widget; `nil` if the WidgetType is not `kButton`.
Declaration Button *button
`label`	Access the Label component attached to the Widget; `nil` if the WidgetType is not `kLabel`.
Declaration Label *label
`textbox`	Access the TextBox component attached to the Widget; `nil` if the WidgetType is not `kTextBox`.
Declaration TextBox *textbox
`textarea`	Access the TextArea component attached to the Widget; `nil` if the WidgetType is not `kTextArea`.
Declaration TextArea *textarea
`panel`	Access the Panel component attached to the Widget; `nil` if the WidgetType is not `kPanel`.
Declaration Panel *panel
`grid`	Access the Grid component attached to the Widget; `nil` if the WidgetType is not `kGrid`.
Declaration Grid *grid
`picture`	Access the Panel component attached to the Widget; `nil` if the WidgetType is not `kPicture`.
Declaration Picture *picture
`scroller`	Access the Scroller component attached to the Widget; `nil` if the WidgetType is not `kScroller`.
Declaration Scroller *scroller
`layout`	Access the Layout component attached to the Widget; `nil` if the WidgetType is not `kLayout`.
Declaration Layout *layout
`splitter`	Access the Splitter component attached to the Widget; `nil` if the WidgetType is not `kSplitter`.
Declaration Splitter *splitter

RunType

Constants that determine when a Signal should be executed.

kOverride: Override the default C/C++ Signal (if any) and replace it.
kBefore: Run before the default C/C++ Signal (if any).
kAfter: Run after the default C/C++ Signal (if any).

AnchorState

Bit flags that define each edge a Widget can be anchored to.

fNone: Not anchored.
fLeft: Left edge.
fRight: Right edge.
fTop: Top edge.
fBottom: Bottom edge.
fAllSides: All edges (left,right,top,down).

WidgetType

Constant value that defines the primary component type of Widget which gave it its capabilities and potential behaviors.

kUser: Empty user based Widget.
kButton: Provides functionalities to implement all sort of buttons.
kArea: Draw using a custom OpenGL area.
kLabel: Component that handles static text.
kTextBox: Component to implement single or multiple line text inputs.
kTextArea: Component that allows the user to edit large Stream of text.
kPanel: Provides a scrolling area that scrolls horizontally or vertically children Widget.
kGrid: Provides functionality to create a table to place Widget on every cell.
kPicture: Component that allows integrating Texture to the UI.
kScroller: Provide slider and scrollbar functionalities to a Widget.
kLayout: Component that allows splitting a Widget horizontally and vertically creating resizable cells that can be used to place other Widget.
kSplitter: Provides functionalities to split a Widget where both cells can be resized and use to store other Widget.
kBase: Empty Widget that is marked as based.