This page has been translated automatically.
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
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::WidgetDialogMessage Class

Interface for widget dialog color handling. See also UnigineScript analog.

To use this class, include the UnigineWidgetDialogMessage.h file.

Unigine::WidgetDialogMessage Class

Members


static Ptr< WidgetDialogMessage > create (const WidgetDialogPtr & dialog)

WidgetDialogMessage constructor.

Arguments

  • const WidgetDialogPtr & dialog - Dialog smart pointer.

static Ptr< WidgetDialogMessage > create (const Ptr< Gui > & gui, const char * str)

WidgetDialogMessage constructor.

Arguments

  • const Ptr< Gui > & gui - Gui pointer.
  • const char * str - Dialog window title. This is an optional argument.

virtual void setMessageHidden (int hidden) const =0

Hides or shows the text message in the widget.

Arguments

  • int hidden - 1 to hide the text message, 0 to show it.

virtual int isMessageHidden () const =0

Returns a value indicating if a text message in the widget is hidden or shown.

Return value

Returns 1 if the text message is hidden; otherwise, 0.

virtual void setMessageFont (const char * name) const =0

Sets a font that will be used to display the text message in the widget.

Arguments

  • const char * name - Font name.

virtual void setMessageFontSize (int size) const =0

Sets a size of the font used to display the text message in the widget.

Arguments

  • int size - Font size.

virtual void setMessageFontColor (const vec4 & color) const =0

Sets a color of the font used to display the text message in the widget.

Arguments

  • const vec4 & color - Font color.

virtual void setMessageFontRich (int rich) const =0

Sets a value indicating if rich text formatting should be used for the text message in the widget.

Arguments

  • int rich - Positive number to use rich text formatting, 0 to use plain text formatting.

virtual void setMessageText (const char * Text) const =0

Sets a text message of the dialog.

Arguments

  • const char * Text - message.

virtual const char * getMessageText () const =0

Returns the text message of the dialog. The default is equal to the dialog title.

Return value

Text message.
Last update: 2017-07-03
Build: ()