WINDOW OBJECT
The following table illustrate a complete Window object, the main template is stored in HGui.Window, if you want to change default values or behaviours you have to modify this table.
HGui.Window
FIELD NAME | TYPE | DEFAULT | DESCRIPTION |
---|---|---|---|
Title | String | empty string | Window's title, the one showed in the drag bar. |
Name | String | Nil | Internal unique identifier. |
Position | Table | A table with the window's position. | |
→ x | Number | #CENTER | → Horizontal position |
→ y | Number | #CENTER | → Vertical position |
Size | Table | A table with the window's current size | |
→ w | Number | 320 | → Width |
→ h | Number | 240 | → Height |
NativeSize | Table | A table with the window's native size | |
→ w | Number | 320 | → Width |
→ h | Number | 240 | → Height |
SizeMax | Table | A table with the window's maximum size | |
→ w | Number | 320 | → Width |
→ h | Number | 240 | → Height |
SizeMin | Table | A table with the window's minimum size | |
→ w | Number | 320 | → Width |
→ h | Number | 240 | → Height |
DontOpen | Boolean | False | True : Do not open the window after the creation |
CacheRoot | Boolean | False | True : Enable the cache system for the root gadget |
Root | Table | empty table | A table where all interface items will be stored |
RootGadget | Table | empty table | A table where the root gadget will be stored |
Focus | — | — | NOT USED |
Menu | Table | empty table | The window's system menu definition |
Contextual | Table | empty table | The window's contextual menu definition |
TopMenu | Table | empty table | NOT USED |
Flags | Table | Window's flags | |
→ Resizeable | Boolean | True | → Sets if the window can be resized by the user or not |
→ Closeable | Boolean | True | → Sets if the window can be closed by the user or not |
→ Moveable | Boolean | True | → Sets if the window can be moved by the user or not |
→ Borderless | Boolean | False | → Sets if the window's borders are visible or not |
→ Modal | Boolean | False | → Sets if the window is modal or not |
→ Hideable | Boolean | True | → Sets if the window can be hided/iconified by the user or not |
→ AutoClose | Boolean | True | → Sets if the window close event must be managed automatically or using a specific code |
Events | Table | Window's callback functions | |
→ OnClose | Function | dummy func | → Callback function executed when the window is closed |
→ OnMove | Function | dummy func | → Callback function executed when the window is moved |
→ OnActivate | Function | dummy func | → Callback function executed when the window receives the focus |
→ OnDeactivate | Function | dummy func | → Callback function executed when the window loses the focus |
→ OnHide | Function | dummy func | → Callback function executed when the window is hided/iconified |
→ OnShow | Function | dummy func | → Callback function executed when the window is showed/deiconified |
→ OnSize | Function | dummy func | → Callback function executed when the window is resized |
IgnoreRMBUp | Boolean | False | INTERNAL Flag used to handle certain situations |
Private | Table | A table used to track the window activity and its status | |
→ HWId | — | Nil | → Hollywood display id associated with this window |
→ Hidden | Boolean | False | → True if the window is hidden or iconified |
→ Closed | Boolean | False | → True if the window is closed |
→ BGFile | String | empty string | → The file name used for the window's background |
→ BGId | — | Nil | → The brush id of the loaded background file |
→ Events | Boolean | True | → True if the window's events detextion is enabled |
→ ActGadList | Table | empty table | → NOT YET AVAILABLE |
→ IgnoreNxRes | Boolean | False | → Internal flag used to handle certain resize situations |
HotKeys | Table | A table used to store the window's hotkeys assignment | |
→ Hide | — | Nil | → Key associated with the Hide action |
→ Show | — | Nil | → Key associated with the Show action |
→ Activate | — | Nil | → Key associated with the Activate action |
→ Close | — | Nil | → Key associated with the Close action |
→ Open | — | Nil | → Key associated with the Open action |
CustomHotKeys | Table | empty table | Table used to store custom hot keys |