Unigine::WidgetLabel Class
| Header: | #include <UnigineWidgets.h> |
| Inherits from: | Widget |
This class creates a text label.
See Also#
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/widgets/ folder:
- font_03
- font_04
- font_05
- font_06
- font_07
- UnigineScript API sample <UnigineSDK>/data/samples/objects/gui_06
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, 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 and adds it to the specified GUI.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.
static WidgetLabelPtr create ( const char * str = 0 ) #
Constructor. Creates a new text label and adds it to the Engine GUI.Arguments
- const char * str - Text of the label. This is an optional parameter.
void setText ( const char * text ) #
Sets a text for the label.Arguments
- const char * text - Label text.
const char * getText ( ) const#
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 ( ) const#
Returns alignment of the label.Return value
Alignment of the label: one of the Gui:: Enumeration with ALIGN_* prefixes.Last update:
2021-04-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)