Unigine.WidgetMenuBox Class
| Inherits: | Widget |
This class creates a menu box. 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#
- 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
Properties
string CurrentItemData#
The data of the item, which is currently in focus. the data can be used as a text identifier of the item (instead of using the number of the item).
string CurrentItemText#
The text of the item, which is currently in focus.
int CurrentItem#
The item, which is currently in focus.
int NumItems#
The total number of items in the menu.
string Texture#
The path to the texture with mini icons, which are used with the list items. the texture is a vertical strip of square icons.
set
Sets a texture with mini icons to be used with items. The texture is a vertical strip of square icons.
set value -
Path to a texture file.
int SpaceY#
The vertical space between menu items and between them and menu borders.
int SpaceX#
The horizontal space between menu items and between them and menu borders.
Members
static WidgetMenuBox ( Gui gui, int x = 0, int y = 0 ) #
Constructor. Creates an empty menu box with specified spacing between menu items and items and menu borders.Arguments
- Gui gui - GUI, to which the menu will belong.
- int x - Horizontal space.
- int y - Vertical space.
WidgetMenuBox Cast ( Widget widget ) #
Casts a WidgetMenuBox out of the Widget instance.Arguments
- Widget widget - Widget instance.
Return value
WidgetMenuBox instance.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.
void GetImage ( Image image ) #
Gets the image with mini icons, which are used with menu items.Arguments
- Image image - Image with mini icons (the vertical strip of square icons).
void SetItemData ( int item, string str ) #
Sets the 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 data of 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.
Return value
Item data.void SetItemEnabled ( int item, bool 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.
- bool 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
Positive number 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
Returns 1 if the item is selectable; 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 after the given 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 after the given item.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Item space.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 tooltip for a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- string str - 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 menu widget for a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- Widget w - A widget to be used as a menu item.
Widget GetItemWidget ( int item ) #
Returns the menu widget of a given item.Arguments
- int item - Item number on range from 0 to the total number of menu items.
Return value
Menu widget.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).
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.
int type ( ) #
WidgetMenuBox type.Return value
WidgetMenuBox type identifier.Last update:
2019-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)