This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.WidgetComboBox Class

Inherits:Widget

This class creates a combo box.

WidgetComboBox Class

Members


static WidgetComboBox(Gui gui)

Constructor. Creates an empty combobox.

Arguments

  • Gui gui - GUI, to which the new combobox will belong.

WidgetComboBox cast(Widget widget)

Casts a WidgetComboBox out of the Widget instance.

Arguments

  • Widget widget - Widget instance.

Return value

WidgetComboBox instance.

void setCurrentItem(int item)

Sets a given item as selected.

Arguments

  • int item - Item number.

int getCurrentItem()

Returns the currently selected item.

Return value

Item number.

string getCurrentItemData()

Returns the data of the currently selected item. The data can be used as a text identifier of the item (instead of using the number of the item).

Return value

Item data.

string getCurrentItemText()

Returns a text value of the currently selected item.

Return value

Item text.

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)

Returns the image with mini-icons, which are used with the combobox items.

Arguments

  • Image image

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 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.

int getItemTexture(int item)

Returns the icon of a given item.

Arguments

  • int item - Item number.

Return value

Zero-based ID of the icon.

int getNumItems()

Returns the number of items in the combobox.

Return value

Number of items.

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 path to the image with mini-icons, which are used with combobox 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.

Return value

Number of the added item.

void clear()

Removes all items from the combobox.

void removeItem(int num)

Removes a given item from the combobox.

Arguments

  • int num - Item number.

int type()

WidgetComboBox type.

Return value

WidgetComboBox type identifier.
Last update: 2018-08-10
Build: ()