Unigine::WidgetDialogMessage Class

WidgetDialogMessage Class

Members

---

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

Constructor. Creates a message dialog with given parameters.

Arguments

• const Ptr<Gui> & gui - GUI, to which the dialog will belong.
• const char * str - Dialog title. This is an optional parameter.

Ptr<WidgetDialogMessage> cast(const Ptr<WidgetDialog> & widgetdialog)

Casts a WidgetDialogMessage out of the WidgetDialog instance.

Arguments

• const Ptr<WidgetDialog> & widgetdialog - Pointer to WidgetDialog.

Return value

Pointer to WidgetDialogMessage.

void setMessageFont(const char * name)

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

Arguments

• const char * name - Font name.

void setMessageFontColor(const Math::vec4 & color)

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

Arguments

• const Math::vec4 & color - Font color.

void setMessageFontRich(int rich)

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.

void setMessageFontSize(int size)

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

Arguments

• int size - Font size.

void setMessageHidden(int hidden)

Hides or shows the text message in the widget.

Arguments

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

int isMessageHidden()

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.

void setMessageText(const char * text)

Sets a text message of the dialog.

Arguments

• const char * text - message.

const char * getMessageText()

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

Return value

Text message.