This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
CIGI Client Plugin
Rendering-Related Classes
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.WidgetIcon Class

Inherits: 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 IsToggled#

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 IsToggleable#

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


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

int type ( ) #

WidgetIcon type.

Return value

WidgetIcon type identifier.
Last update: 2019-08-16
Build: ()