WidgetComboBox Class

WidgetComboBox Class

Members

---

WidgetComboBox (Gui gui)

Constructor. Creates an empty combobox.

Arguments

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

int type ()

WidgetComboBox type.

Return value

WidgetComboBox type identifier.

void clear ()

Removes all items from the combobox.

void setItemText (int item, string str)

Sets a text for a given item.

Arguments

• int item - Item number.
• string str - Item text.

WidgetComboBox create (Widget widget)

WidgetComboBox constructor.

Arguments

• Widget widget - Widget smart pointer.

Return value

string getCurrentItemText ()

Returns a text value of the currently selected item.

Return value

Item text.

int getCurrentItem ()

Returns the currently selected item.

Return value

Item number.

void removeItem (int num)

Removes a given item from the combobox.

Arguments

• int num - Item number.

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 getCurrentItemData ()

Returns the data of a given item.

Return value

Item data.

int getNumItems ()

Returns the number of items in the combobox.

Return value

Number of items.

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.

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.

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 getImage (Image image)

Returns the image with mini-icons.

Arguments

• Image image

void setCurrentItem (int item)

Selects a given item.

Arguments

• int item - Item number.

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.

string getTexture ()

Returns file name of the image with mini-icons.

Return value

Path to the texture file.

int getItemTexture (int item)

Returns the icon of a given item.

Arguments

• int item - Item number.

Return value

Zero-based ID of the icon.

string getItemText (int item)

Returns the text of a given item.

Arguments

• int item - Item number.

Return value

Item text.

string getItemData (int item)

Returns the data of the currently selected item.

Arguments

• int item - Item number in range from 0 to the total number of items.

Return value

Item data.