Gui

Access to the global Gui object allowing you to call its functions and manipulate its properties.

This global object manages all Widget and produces the final GUI drawing for all interface components. It also handles the Signal for each Widget as well as inputs from the keyboard and pointing devices.

See Also

Static Variables


Name Description
bounds Current size of the GUI rectangle.
signal Store information about the current GuiSignal triggered by an event.

Functions


Name Description
GridNew Create a new Widget of the type Grid.
ButtonNew Create new Widget of the type Button.
LabelNew Create a new Widget of the type Label.
LayoutNew Create new Widget of the type Layout.
PanelNew Create a new Widget of the type Panel.
PictureNew Create new Widget of the type Picture.
ScrollerNew Create a new Widget of the type Scroller.
SplitterNew Create new Widget of the type Splitter.
TextBoxNew Create a new Widget of the type TextBox.
TextAreaNew Create new Widget of the type TextArea.
AreaNew Create a new Widget of the type kArea.
UserNew Create a new blank Widget without no component of the type kUser.
BaseNew Helper that creates a Widget of the type kBase.
WidgetNew Function to manually create a new custom Widget based on the user parameters.
TextBufferNew Create a new TextBuffer to be used by TextArea.
TextBufferDelete Delete an existing TextBuffer.
DispatchSignal Manually force a Signal to be dispatched.
KeyPress Manually send a key press signal.
KeyRelease Manually send a key release signal.
SpecialPress Manually send a press of a special key such as Shift or F1 etc...
SpecialRelease Manually send a release of a special key such as Shift or F1 etc...
MousePress Manually send a mouse press signal.
MouseRelease Manually send a release of a pointing device release signal.
MousePress Manually send a mouse press signal.
MouseMove Manually send a mouse move signal from the pointing device.
SetFocus Focus a specific Widget.
GetWidget Retrieve a Widget reference by name.
GetWidgetAt Function that retrieves a Widget based on its index.
GetWidgetIndex Retrieve the internal index of a Widget reference.
GetTextBuffer Retrieve a TextBuffer reference using its name as key.
Update Force a manual update of the GUI.
Redraw Force a full redraw of the GUI.
DispatchSignals Function that allows you to enable or disable dispatching all signals.
CancelSignals Cancel a specific signal next time it happen.
AddTrigger Create a Trigger that will call an event after a specific amount of time.

GuiSignal


Contain all the information available when a Signal occurs; user logical operations can be implemented based on the data help by this structure.

Static Variables


Name Description
type The current Signal type.
mouse Coordinate of the pointing device when the Signal occur.
mouse_delta Mouse delta at the time of the Signal.
resize_delta Amount of pixel the GUI window have been resized.
mouse_button The MouseButton currently pressed.
ascii Current ASCII pressed or released.
special Bit mask of KeyCode currently pressed or released.
widget Reference to the Widget currently handling the Signal.
selected Current Widget under the pointing device which can receive event and can eventually be focused.
focused Reference to the active focused Widget.
trigger Reference to the active Trigger that call the Signal.
delta_time Amount of time elapsed since the last event sync.
click_time Last time a mouse button have been pressed.
gui_time Active GUI time.
click_time Last time the GUI update.




NRG - API 2022.4.384543 - Fri Nov 4 2022
Copyright © 2022 nrgcore.com. All Rights Reserved. Terms of Service - Privacy Policy - EULA