WidgetListBox 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 list box, which is multiple line text box where more than one item can be picked.
WidgetListBox Class
Members
static WidgetListBox ( Gui gui ) #
Constructor. Creates an empty list box and adds it to the specified GUI.Arguments
static WidgetListBox ( ) #
Constructor. Creates an empty list box and adds it to the Engine GUI.void setCurrentItem ( int item ) #
Places focus on a given item.Arguments
- int item - Item number.
int getCurrentItem ( ) #
Returns the number of the item, which is currently in focus.Return value
Item number.string getCurrentItemData ( ) #
Returns the text data of item, which is currently in focus. The data can be used as a text identifier of the item (instead of using the item number).Return value
Item text data.string getCurrentItemText ( ) #
Returns the text of item, which is currently in focus.Return value
Item text.void setImage ( Image image ) #
Sets an image with mini-icons to be used with list items. The image is a vertical strip of square icons.Arguments
- Image image - Image to set.
Image getImage ( ) #
Gets the image with mini-icons, which are used with the list items.Return value
Image with mini-icons (the vertical strip of square icons).void setItemColor ( int item, vec4 color ) #
Sets a custom color for a given item.Arguments
- int item - Item number.
- vec4 color - Color to set.
vec4 getItemColor ( int item ) #
Returns a color set to a given item.Arguments
- int item - Item number.
Return value
Color.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 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 if the item is in range from 0 to the total number of items; otherwise, NULL.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
1 if the item is selectable; otherwise, 0.void setItemSelected ( int item, int selected ) #
Selects or deselects a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- int selected - 1 to select the item, 0 to deselect it.
int isItemSelected ( int item ) #
Returns a value indicating if a given item is selected.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
1 if the item is selected; otherwise, 0.void setItemText ( int item, string str ) #
Sets a text for a given item.Arguments
- int item - Item number.
- string str - Item text.
string getItemText ( int item ) #
Returns the text of a given item.Arguments
- int item - Item number.
Return value
Item text.void setItemTexture ( int item, int texture ) #
Sets an icon for a given item.Arguments
- int item - Item number.
- 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.
Return value
Zero-based ID of the icon (i.e. number of the icon in the icon texture).void setMultiSelection ( int selection ) #
Enables or disables multiple selection of items.Arguments
- int selection - 1 to enable multiple selection, 0 to disable it.
int isMultiSelection ( ) #
Returns a value indicating if multiple selection of items is enabled.Return value
1 if several items can be selected at once; otherwise, 0.int getNumItems ( ) #
Returns the total number of items in the list box.Return value
Number of items.int getNumSelectedItems ( ) #
Returns number of selected items in the box.Return value
Number of selected items.int getSelectedItem ( int num ) #
Returns ID of a selected item (multi-selection mode).Arguments
- int num - Number in the list of the selected items in range from 0 to the total number of the selected items.
Return value
ID of a selected item.void setTexture ( string texture ) #
Sets a path to 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.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 list box.void clearSelection ( ) #
Clears list of selected items.void removeItem ( int item ) #
Removes a given item from the list box.Arguments
- int item - Item number in range from 0 to the total number of items.
void showItem ( int item ) #
Scrolls a list box so that a given item is visible.Arguments
- int item - Item number.
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.void setIconsEnabled ( int enabled ) #
Enables the icons display next to the items.Arguments
- int enabled - 1 to enable the icons, otherwise, 0.
int isIconsEnabled ( ) #
Returns a value indicating if the icons display is enabled.Return value
1 if the icons are enabled, otherwise, 0.void setIconsAlphaEnabled ( int enabled ) #
Enables the alpha channel of the icons.Arguments
- int enabled - 1 to enable the alpha channel, otherwise, 0.
int isIconsAlphaEnabled ( ) #
Returns a value indicating if the alpha channel of the icons is enabled.Return value
1 if the alpha channel is enabled, otherwise, 0.void setIconsResolution ( int resolution ) #
Sets the resolution of the icons.Arguments
- int resolution - Desired resolution.
int getIconsResolution ( ) #
Returns the current resolution of the icons.Return value
Icon resolution.void setItemIcon ( int item, Texture texture ) #
Sets the icon for a given list item.Arguments
- int item - Item number in range from 0 to the total number of items.
- Texture texture - Icon to be set.
Texture getItemIcon ( int item ) #
Returns the icon for a given list item.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Icon of the item.Last update:
2022-03-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)