Unigine.WidgetMenuBar Class
| Inherits from: | Widget |
This class creates a horizontal menu bar.
WidgetMenuBar Class
Properties
int NumItems#
The number of items in the menu bar.
int SpaceY#
The vertical space between menu items and menu borders.
int SpaceX#
The horizontal space between menu items and menu borders.
vec4 SelectionColor#
The four-component vector specifying the color in the RGBA format.
Members
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.
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, bool enabled ) #
Sets an enabled flag for the item.Arguments
- int item - Item number in range from 0 to the total number of items.
- bool enabled - Enabled flag:
- 1 - Item is enabled.
- 0 - Item is disabled.
bool 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 box.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
Item space, 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.void SetSpace ( int x, int y ) #
Sets a space between menu items and between them and menu borders.Arguments
- int x - Horizontal space, in pixels.
- int y - Vertical space, in pixels.
int AddItem ( string str ) #
Adds an empty menu with a given title.Arguments
- string str - Menu title.
Return value
Number of the added menu.int AddItem ( string str, WidgetMenuBox menu ) #
Adds an empty 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.
Last update:
2022-12-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)