The Battle for Wesnoth  1.15.2+dev
Public Attributes | List of all members
gui2::dialogs::wml_message_input Struct Reference

Parameter pack for message text input options. More...

#include <wml_message.hpp>

Public Attributes

std::string caption
 The caption for the optional input text box. More...
 
std::string text
 The initial text value. More...
 
unsigned maximum_length
 The maximum length of the text. More...
 
bool text_input_was_specified
 True when [text_input] appeared in [message]. More...
 

Detailed Description

Parameter pack for message text input options.

Definition at line 212 of file wml_message.hpp.

Member Data Documentation

◆ caption

std::string gui2::dialogs::wml_message_input::caption

The caption for the optional input text box.

If empty, there is no input box.

Definition at line 216 of file wml_message.hpp.

Referenced by lua_gui2::show_message_dialog().

◆ maximum_length

unsigned gui2::dialogs::wml_message_input::maximum_length

The maximum length of the text.

Definition at line 221 of file wml_message.hpp.

Referenced by lua_gui2::show_message_dialog().

◆ text

std::string gui2::dialogs::wml_message_input::text
mutable

The initial text value.

Will be set to the result.

Definition at line 219 of file wml_message.hpp.

Referenced by lua_gui2::show_message_dialog().

◆ text_input_was_specified

bool gui2::dialogs::wml_message_input::text_input_was_specified

True when [text_input] appeared in [message].

Definition at line 223 of file wml_message.hpp.

Referenced by lua_gui2::show_message_dialog().


The documentation for this struct was generated from the following file: