This page has been translated automatically.
编程
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
应用程序接口
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

Unigine::WidgetLabel Class

Header:#include <UnigineWidgets.h>
Inherits:Widget

This class creates a text label.

The following sample demonstrates the usage of the WidgetLabel class:

Example

The following code illustrates how to create a label widget and set its parameters.

Source code (UnigineScript)
#include <UnigineWidgets.h>
using namespace Unigine;

/* .. */

// getting a pointer to the system GUI
GuiPtr gui = Gui::get();

// creating a label widget and setting up its caption
WidgetLabelPtr widget_label = WidgetLabel::create(gui, "Label text");

// setting a tooltip
widget_label->setToolTip("This is a label");

// rearranging label size
widget_label->arrange();

// setting label position
widget_label->setPosition(10, 10);
	
// adding created label widget to the system GUI
gui->addChild(widget_label->getWidget(), Gui::ALIGN_OVERLAP | Gui::ALIGN_FIXED);

WidgetLabel Class

Members


static WidgetLabelPtr create(const Ptr<Gui> & gui, const char * str = 0)

Constructor. Creates a new text label.

Arguments

  • const Ptr<Gui> & gui - GUI, to which the new label will belong.
  • const char * str - Text of the label. This is an optional parameter.

Ptr<WidgetLabel> cast(const Ptr<Widget> & widget)

Casts a WidgetLabel out of the Widget instance.

Arguments

  • const Ptr<Widget> & widget - Pointer to Widget.

Return value

Pointer to WidgetLabel.

void setText(const char * text)

Sets a text for the label.

Arguments

  • const char * text - Label text.

const char * getText()

Returns the text of the label.

Return value

Label text.

void setTextAlign(int align)

Sets alignment of the label.

Arguments

  • int align - One of the Gui:: Enumeration with ALIGN_* prefixes.

int getTextAlign()

Returns alignment of the label.

Return value

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

int type()

WidgetLabel type.

Return value

WidgetLabel type identifier.
Last update: 2017-12-21
Build: ()