WidgetMenuBar Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits: | Widget |
This class creates a horizontal menu bar.
WidgetMenuBar Class
Members
static WidgetMenuBar ( Gui gui, int x = 0, int y = 0 ) #
Constructor. Creates an empty menu bar and adds it to the specified GUI.Arguments
- Gui gui - GUI, to which the menu bar will belong.
- int x - Offset along the X axis.
- int y - Offset along the Y axis.
static WidgetMenuBar ( int x = 0, int y = 0 ) #
Constructor. Creates an empty menu bar and adds it to the Engine GUI.Arguments
- int x - Offset along the X axis.
- int y - Offset along the Y axis.
void setItemData ( int item, string str ) #
Sets the text data for the item with the specified number. The data can be used as a text identifier of the item (instead of using the item number).Arguments
- int item - Item number in range from 0 to the total number of menu bar items.
- string str - Item text data to be set.
string getItemData ( int item ) #
Returns the text data of the item with the specified number. The data can be used as a text identifier of the item (instead of using the item number).Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Item text data.void setItemEnabled ( int item, int enabled ) #
Sets an enabled flag for the item.Arguments
- int item - Item number in range from 0 to the total number of items.
- int enabled - Enabled flag:
- 1 - Item is enabled.
- 0 - Item is disabled.
int isItemEnabled ( int item ) #
Returns a value indicating if the given item is enabled.Arguments
- int item - Item number in range from 0 to the total number of menu bar items.
Return value
1 if the item is enabled; otherwise - 0.void setItemMenu ( int item, WidgetMenuBox menu ) #
Sets a menu for a given item.Arguments
- int item - Item number in range from 0 to the total number of menu bar items.
- WidgetMenuBox menu - Menu.
WidgetMenuBox getItemMenu ( int item ) #
Returns the menu of a given item.Arguments
- int item - Item number in range from 0 to the total number of menu bar items.
Return value
Menu.void setItemSpace ( int item, int space ) #
Sets a space between the given menu item and the next item located to the right.Arguments
- int item - Item number in range from 0 to the total number of menu bar items.
- int space - Space to set, in pixels.
int getItemSpace ( int item ) #
Returns the space between the given menu item and the next item located to the right.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Space between items, in pixels.void setItemText ( int item, string str ) #
Sets a title for a given item.Arguments
- int item - Item number in range from 0 to the total number of menu bar items.
- string str - Menu title.
string getItemText ( int item ) #
Returns the title of a given item.Arguments
- int item - Item number.
Return value
Item title.int getNumItems ( ) #
Returns the number of items in the menu bar.Return value
Number of items.void setSpace ( int x, int y ) #
Sets a space between menu items and menu borders.Arguments
- int x - Horizontal space, in pixels.
- int y - Vertical space, in pixels.
int getSpaceX ( ) #
Returns the horizontal space between menu items and menu borders.Return value
Horizontal space, in pixels.int getSpaceY ( ) #
Returns the vertical space between menu items and menu borders.Return value
Vertical space, in pixels.int addItem ( string str, WidgetMenuBox menu ) #
Adds a menu with a given title.Arguments
- string str - Menu title.
- WidgetMenuBox menu - Menu.
Return value
Number of the added menu.void clear ( ) #
Removes all menus from the menu bar.void removeItem ( int item ) #
Removes a given item from the menu bar.Arguments
- int item - Item number in range from 0 to the total number of menu bar items.
void setSelectionColor ( vec4 color ) #
Sets the color to be used to highlight the current selection for the widget.Arguments
- vec4 color - Four-component vector specifying the color in the RGBA format.
vec4 getSelectionColor ( ) #
Returns the current color used to highlight the current selection for the widget.Return value
Four-component vector specifying the color in the RGBA format.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)