Unigine.WidgetMenuBox Class
| Inherits: | Widget |
WidgetMenuBox Class
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.int getCurrentItem()
Returns the item, which is currently in focus.Return value
Item number.string getCurrentItemData()
Returns 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).Return value
Item data if the item is in range from 0 to the total number of items; otherwise, NULL.string getCurrentItemText()
Returns the text of the item, which is currently in focus.Return value
Item text if the item is in range from 0 to the total number of items; otherwise, NULL.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, 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 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 a given item can be selected.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.int getNumItems()
Returns the total number of items in the menu.Return value
Number of items.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 getSpaceX()
Returns the horizontal space between menu items and between them and menu borders.Return value
Horizontal space.int getSpaceY()
Returns the vertical space between menu items and between them and menu borders.Return value
Vertical space.void setTexture(string texture)
Sets a texture with mini-icons to be used with items. The texture is a vertical strip of square icons.Arguments
- string texture - Path to a texture file.
string getTexture()
Returns the path to the texture with mini-icons, which are used with the list items. The texture is a vertical strip of square icons.Return value
Path to the texture file.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: 2018-08-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)