Unigine::WidgetListBox Class
| Header: | #include <UnigineWidgets.h> |
| Inherits from: | Widget |
This class creates a list box, which is multiple line text box where more than one item can be picked.
The object of this class looks as follows:
See Also#
- Widgets sample in C# Component Samples suite
WidgetListBox Class
Members
static WidgetListBoxPtr create ( const Ptr<Gui> & gui ) #
Constructor. Creates an empty list box and adds it to the specified GUI.Arguments
static WidgetListBoxPtr create ( ) #
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 ( ) const#
Returns the number of the item, which is currently in focus.Return value
Item number.const char * getCurrentItemData ( ) const#
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.const char * getCurrentItemText ( ) const#
Returns the text of item, which is currently in focus.Return value
Item text.void setImage ( const Ptr<Image> & image ) #
Sets an image with mini-icons to be used with list items. The image is a vertical strip of square icons.Arguments
Ptr<Image> getImage ( ) const#
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, const Math::vec4 & color ) #
Sets a custom color for a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- const Math::vec4 & color - Color to set.
Math::vec4 getItemColor ( int item ) const#
Returns a color set to a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
Return value
Item color.void setItemData ( int item, const char * 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.
- const char * str - Item text data to be set.
const char * getItemData ( int item ) const#
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 ) const#
Returns 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.
Return value
Returns 1 if the item is selectable; otherwise, 0.void setItemSelected ( int item, int selected ) #
Sets a value indicating if a given item is selected.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 ) const#
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
Returns 1 if the item is selected; otherwise, 0.void setItemText ( int item, const char * str ) #
Sets a text for a given item.Arguments
- int item - Item number in range from 0 to the total number of items.
- const char * str - Item text to be set.
const char * getItemText ( int item ) const#
Returns the text of a given item.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 ) const#
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 setMultiSelection ( bool selection ) #
Enables or disables multiple selection of items. The default is 0.Arguments
- bool selection - 1 to enable multiple selection, 0 to disable it.
bool isMultiSelection ( ) const#
Returns a value indicating if multiple selection of items is enabled. The default is 0.Return value
Returns 1 if several items can be selected at once; otherwise, 0.int getNumItems ( ) const#
Returns the total number of items in the list box.Return value
Number of items.int getNumSelectedItems ( ) const#
Returns the number of selected items in the box.Return value
Number of selected items.int getSelectedItem ( int num ) const#
Returns ID of the 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 ( const char * texture ) #
Sets a texture with mini-icons to be used with list items. The texture is a vertical strip of square icons.Arguments
- const char * texture - Path to a texture with mini-icons (the vertical strip of square icons).
const char * getTexture ( ) const#
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 ( const char * str, int texture = -1 ) #
Adds a new item with a given text and an icon. By default, a new item is not selected.Arguments
- const char * str - Item text.
- int texture - Zero-based ID of the icon. -1 means that an item has no icon.
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 in range from 0 to the total number of items.
void setSelectionColor ( const Math::vec4 & color ) #
Sets the color to be used to highlight the current selection for the widget.Arguments
- const Math::vec4 & color - Four-component vector specifying the color in the RGBA format.
Math::vec4 getSelectionColor ( ) const#
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 ( bool enabled ) #
Enables the icons display next to the items.Arguments
- bool enabled - true to enable the icons, otherwise, false.
bool isIconsEnabled ( ) const#
Returns a value indicating if the icons display is enabled.Return value
true if the icons are enabled, otherwise, false.void setIconsAlphaEnabled ( bool enabled ) #
Enables the alpha channel of the icons.Arguments
- bool enabled - true to enable the alpha channel, otherwise, false.
bool isIconsAlphaEnabled ( ) const#
Returns a value indicating if the alpha channel of the icons is enabled.Return value
true if the alpha channel is enabled, otherwise, false.void setIconsResolution ( int resolution ) #
Sets the resolution of the icons.Arguments
- int resolution - Desired resolution.
int getIconsResolution ( ) const#
Returns the current resolution of the icons.Return value
Icon resolution.void setItemIcon ( int item, const Ptr<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.
- const Ptr<Texture> & texture - Icon to be set.
Ptr<Texture> getItemIcon ( int item ) const#
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:
2024-12-02
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)