Unigine.WidgetComboBox Class

/* .. */

// event handler function
void onComboBoxChanged()
{
	/* .. */

}

/* .. */

void Init()
{
	// getting a pointer to the system GUI
	Gui gui = Gui.GetCurrent();

	// creating a combobox widget
	WidgetComboBox widget_combo = new WidgetComboBox(gui);

	// adding items to the combobox
	widget_combo.AddItem("----ALL-----");
	widget_combo.AddItem("Item 1");
	widget_combo.AddItem("Item 2");
	widget_combo.AddItem("Item 3");

	// setting a tooltip
	widget_combo.SetToolTip("This is a combo box");

	// rearranging combobox size
	widget_combo.Arrange();

	// setting combobox position
	widget_combo.SetPosition(10, 10);

	// setting the first item as currently selected one
	widget_combo.CurrentItem = 0;

	// setting onComboBoxChanged function to handle CHANGED event
	widget_combo.EventChanged.Connect(onComboBoxChanged);

	// adding created combobox widget to the system GUI
	gui.AddChild(widget_combo, Gui.ALIGN_OVERLAP | Gui.ALIGN_FIXED);
	
}

WidgetComboBox Class

Properties

string StyleTextureBorder#

string StyleTextureBackground#

string StyleTextureSelection#

string StyleTextureButton#

string StyleTextureIcon#

int CurrentItem#

int NumItems#

string Texture#

vec4 ButtonColor#

vec4 BorderColor#

vec4 SelectionColor#

vec4 ListBackgroundColor#

vec4 MainBackgroundColor#

Members

---

WidgetComboBox ( Gui gui ) #

Constructor. Creates an empty combobox and adds it to the specified GUI.

Arguments

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

WidgetComboBox ( ) #

Constructor. Creates an empty combobox and adds it to the Engine GUI.

string GetCurrentItemData ( ) #

Returns the text data of the currently selected item. 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 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.

Image GetImage ( ) #

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

Return value

Image with mini icons.

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.

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 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 FindItemByText ( string str ) #

Returns the number of the item the text of which is the same as in the argument.

Arguments

• string str - Item text.

Return value

Number of the item with the matching text.