Unigine.WidgetIcon Class

WidgetIcon Class

Members

---

static WidgetIcon(Gui gui, string str = 0, int width = 0, int height = 0)

Constructor. Creates an icon of the specified size using a given texture.

Arguments

• Gui gui - GUI, to which the new icon will belong.
• string str - The path to a texture file.
• int width - The width.
• int height - The height.

WidgetIcon cast(Widget widget)

Casts a WidgetIcon out of the Widget instance.

Arguments

• Widget widget - Widget instance.

Return value

WidgetIcon instance.

void setImage(Image image)

Sets an icon image.

Arguments

• Image image - Image to set.

void getImage(Image image)

Returns the icon image.

Arguments

• Image image

void setText(string text)

Sets the floating text over the icon.

Arguments

• string text - Floating text.

string getText()

Returns the current floating text set to be over the icon.

Return value

Floating text.

void setTextAlign(int align)

Sets the alignment flag for the floating text over the icon. The default is ALIGN_CENTER.

Arguments

• int align - Alignment flag (see GUI_ALIGN_* variables).

int getTextAlign()

Returns the current alignment flag set for the floating text over the icon.

Return value

Alignment flag: one of the Gui Enumeration with ALIGN_* prefixes.

void setTexture(string texture)

Sets a texture to be used as the icon image.

Arguments

• string texture - Path to a texture file.

string getTexture()

Returns path to the icon image.

Return value

Path to a texture file.

void setToggleable(int toggleable)

Sets a value indicating if the icon is a toggle button or a simple button. The default is 0.

Arguments

• int toggleable - Positive number to make the icon a toggle button, 0 to make it a simple button.

int isToggleable()

Returns a value indicating if the icon is a toggle button or a simple button. The default is 0.

Return value

Positive number if the icon is a toggle button; otherwise, 0.

void setToggled(int toggled)

Sets a state of the icon as a toggle button.

Arguments

• int toggled - Positive number to press the button, 0 to release it.

int isToggled()

Returns a value indicating if the icon serving as a toggle button is pressed.

Return value

Returns 1 if the button is pressed; otherwise, 0.

int type()

WidgetIcon type.

Return value

WidgetIcon type identifier.