This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
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 from: Widget

This class creates a combo box.

WidgetComboBox Class

Properties

string StyleTextureBorder#

The skin used for the widget's border.

string StyleTextureBackground#

The skin used for the widget's background.

string StyleTextureSelection#

The skin used to highlight the current selection for the widget.

string StyleTextureButton#

The path to the skin used for buttons.

string StyleTextureIcon#

The path to the skin used for icons.

int CurrentItem#

The currently selected item.

int NumItems#

The number of items in the combobox.

string Texture#

The path to the image with mini icons, which are used with combobox items.

vec4 ButtonColor#

The color for the widget's button.

vec4 BorderColor#

The border color for the widget.

vec4 SelectionColor#

The color used to highlight the current selection for the widget.

vec4 ListBackgroundColor#

The background color used for the widget's list items.

vec4 MainBackgroundColor#

The background color used for the widget's text box.

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.
Last update: 2022-12-14
Build: ()