Unigine.WidgetIcon Class
| Inherits from: | Widget |
This class creates a toggleable icon with two states - pressed or not.
WidgetIcon Class
Properties
string Text#
The current floating text set to be over the icon.
set
Sets the floating text over the icon.
set value -
Floating text.
int TextAlign#
The current alignment flag set for the floating text over the icon.
set
Sets the alignment flag for the floating text over the icon. The default is ALIGN_CENTER.
set value -
Alignment flag (see GUI_ALIGN_* variables).
string Texture#
Path to the icon image.
set
Sets a texture to be used as the icon image.
set value -
Path to a texture file.
bool Toggled#
A value indicating if the icon serving as a toggle button is pressed.
set
Sets a state of the icon as a toggle button.
set value -
Positive number to press the button, 0 to release it.
bool Toggleable#
A value indicating if the icon is a toggle button or a simple button. the default is 0.
set
Sets a value indicating if the icon is a toggle button or a simple button. The default is 0.
set value -
Positive number to make the icon a toggle button, 0 to make it a simple button.
Members
WidgetIcon ( Gui gui, string str = 0, int width = 0, int height = 0 ) #
Constructor. Creates an icon of the specified size using a given texture and adds it to the specified GUI.Arguments
- Gui gui - GUI, to which the new icon will belong.
- string str - The path to a texture file.
- int width - Icon width.
- int height - Icon height.
WidgetIcon ( string str = 0, int width = 0, int height = 0 ) #
Constructor. Creates an icon of the specified size using a given texture and adds it to the Engine GUI.Arguments
- string str - The path to a texture file.
- int width - Icon width.
- int height - Icon height.
void SetImage ( Image image ) #
Sets an icon image.Arguments
- Image image - Image to set.
Image GetImage ( ) #
Returns the icon image.Return value
Icon image.Last update:
2021-04-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)