WidgetMenuBox 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 UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits from: | Widget |
This class creates a menu box.
The object of this class looks as follows:
A menu box can be either stand-alone or attached to a menu bar. In the first case, it needs to be handled manually. By using this widget, you can do the following:
- Create hierarchical menus.
- Use the other widgets as menu items (See the example).
See Also#
- Widgets sample in C# Component Samples suite
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/widgets/ folder:
- menubox_00
- menubox_01
- menubox_02
- The Widgets article providing details on menubox features
WidgetMenuBox Class
Members
const char * getCurrentItemData() const#
Returns the current text data of the selected item (the last clicked item). The data can be used as a text identifier of the item (instead of using the number of the item).
Return value
Current text data of the selected item, or nullptr in case no item is selected.const char * getCurrentItemText() const#
Returns the current text of the selected item (the last clicked item).
Return value
Current text of the selected item, or nullptr in case no item is selected.void setCurrentItem ( ) #
Sets a new item selection (the last clicked item number). When nothing is selected the value is -1 (setting the selection to a non-existent item number will also reset the value to -1).
Arguments
- item - The selected item number.
getCurrentItem() const#
Returns the current item selection (the last clicked item number). When nothing is selected the value is -1 (setting the selection to a non-existent item number will also reset the value to -1).
Return value
Current selected item number.getNumItems() const#
Returns the current total number of items in the menu.
Return value
Current total number of items in the menu.void setTexture ( string texture ) #
Sets a new path to the texture file with mini icons to be used with the list items. The texture is a vertical strip of square icons.
Arguments
- string texture - The path to the texture file to be used.
const char * getTexture() const#
Returns the current path to the texture file with mini icons to be used with the list items. The texture is a vertical strip of square icons.
Return value
Current path to the texture file to be used.getSpaceY() const#
Returns the current vertical space between menu items, and between items and the menu borders.
Return value
Current vertical space between menu items and menu borders, in pixels.getSpaceX() const#
Returns the current horizontal space between menu items, and between items and the menu borders.
Return value
Current horizontal space between menu items and menu borders, in pixels.void setBorderColor ( vec4 color ) #
Sets a new border color of the widget.
Arguments
- vec4 color - The color in the RGBA format.
vec4 getBorderColor() const#
Returns the current border color of the widget.
Return value
Current color in the RGBA format.void setSelectionColor ( vec4 color ) #
Sets a new color to be used to highlight the current selection.
Arguments
- vec4 color - The color in the RGBA format.
vec4 getSelectionColor() const#
Returns the current color to be used to highlight the current selection.
Return value
Current color in the RGBA format.void setBackgroundColor ( vec4 color ) #
Sets a new background color to be used.
Arguments
- vec4 color - The color in the RGBA format.
vec4 getBackgroundColor() const#
Returns the current background color to be used.
Return value
Current color in the RGBA format.void setCurrentItemHighlight ( int highlight ) #
Sets a new highlight flag of the item that is clicked last.
Arguments
- int highlight - The highlight flag
int isCurrentItemHighlight() const#
Returns the current highlight flag of the item that is clicked last.
Return value
Current highlight flagvoid setCurrentItemColor ( vec4 color ) #
Sets a new color of the highlight for item that is clicked last. The highlight state should be enabled.
Arguments
- vec4 color - The color in the RGBA format.
vec4 getCurrentItemColor() const#
Returns the current color of the highlight for item that is clicked last. The highlight state should be enabled.
Return value
Current color in the RGBA format.static WidgetMenuBox ( Gui gui, int x = 0, int y = 0 ) #
Constructor. Creates an empty menu box with specified spacing between menu items as well as items and menu borders and adds it to the specified GUI.Arguments
static WidgetMenuBox ( int x = 0, int y = 0 ) #
Constructor. Creates an empty menu box with specified spacing between menu items as well as items and menu borders and adds it to the Engine GUI.Arguments
- int x - Horizontal space.
- int y - Vertical space.
void setImage ( Image image ) #
Sets an image with mini icons to be used with items. The image is a vertical strip of square icons.Arguments
- Image image - Image to set.
Image getImage ( ) #
Gets the image with mini icons that are used with menu items.Return value
Image with mini icons (the vertical strip of square icons).void setItemData ( int item, string str ) #
Sets the text data for a given item. The data can be used as a text identifier of the item (instead of using the number of the item).Arguments
- int item - Item number in range from 0 to the total number of items.
- string str - Data to 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 a value indicating if a given item is enabled (i.e. can be clicked).Arguments
- int item - Item number in range from 0 to the total number of items.
- int enabled - 1 to enable the item, 0 to disable it.
int isItemEnabled ( int item ) #
Returns a value indicating if a given item is enabled (i.e. can be clicked).Arguments
- int item - Item number.
Return value
1 if the item is enabled; otherwise, 0.void setItemSelectable ( int item, int selectable ) #
Sets a value indicating if a given item can be selected.Arguments
- int item - Item number in range from 0 to the total number of items.
- int selectable - 1 to set the item as selectable; otherwise, 0.
int isItemSelectable ( int item ) #
Returns a value indicating if the given item can be selected. By default, the item is selectable.Arguments
- int item - Item number.
Return value
1 if the item can be selected; otherwise, 0.void setItemSeparator ( int item, int separator ) #
Adds or removes a separator after a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- int separator - Positive number to add a separator, 0 to remove it.
int isItemSeparator ( int item ) #
Checks whether a separator is placed after the given item.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Positive number if separator is placed; otherwise, 0.void setItemSpace ( int item, int space ) #
Sets a space between the given menu item and the next item.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.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 text for a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- string str - Item text.
string getItemText ( int item ) #
Returns the text of a given item in range from 0 to the total number of items.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Item text.void setItemTexture ( int item, int texture ) #
Sets an icon for a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- int texture - Zero-based ID of the icon (i.e. number of the icon in the icon texture).
int getItemTexture ( int item ) #
Returns the icon of a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Zero-based ID of the icon (i.e. number of the icon in the icon texture).void setItemToolTip ( int item, string str ) #
Sets a new tooltip for the given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- string str - Text of a tooltip to set.
string getItemToolTip ( int item ) #
Returns the tooltip of a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Text of the item tooltip.void setItemWidget ( int item, Widget w ) #
Sets a widget for the given item of the menu.Arguments
- int item - Item number in range from 0 to the total number of menu items.
- Widget w - A widget to be used as a menu item.
Widget getItemWidget ( int item ) #
Returns a widget set for the given item of the menu.Arguments
- int item - Item number on range from 0 to the total number of menu items.
Return value
A widget used as an item.void setSpace ( int x, int y ) #
Sets a space between menu items and between them and menu borders.Arguments
- int x - Horizontal space. If a negative value is provided, 0 will be used instead.
- int y - Vertical space. If a negative value is provided, 0 will be used instead.
int addItem ( string str, int texture = -1 ) #
Adds a new item with a given text and an icon.Arguments
- string str - Item text.
- int texture - Zero-based ID of the icon (i.e. number of the icon in the icon texture). -1 means that an item has no icon.
Return value
Number of the added item.void clear ( ) #
Removes all items from the menu.void removeItem ( int item ) #
Removes a given item from the menu.Arguments
- int item - Item number in range from 0 to the total number of items.
void resetCurrentItem ( ) #
Resets the current item selection (the last clicked item).The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-04-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)