Base class for the wml generated messages. More...

#include <wml_message.hpp>

Inheritance diagram for gui2::twml_message_:

Collaboration diagram for gui2::twml_message_:

Public Member Functions
	twml_message_ (const std::string &title, const std::string &message, const std::string &portrait, const bool mirror)
void	set_input (const std::string &caption, std::string *text, const unsigned maximum_length)
	Sets the input text variables.
void	set_option_list (const std::vector< std::string > &option_list, int *chosen_option)
Private Member Functions
void	pre_show (CVideo &video, twindow &window)
	Inherited from tdialog.
void	post_show (twindow &window)
	Inherited from tdialog.
Private Attributes
std::string	title_
	The title for the dialog.
std::string	image_
	The image which is shown in the dialog.
std::string	message_
	The message to show to the user.
std::string	portrait_
	Filename of the portrait.
bool	mirror_
	Mirror the portrait?
bool	has_input_
	Do we need to show an input box?
std::string	input_caption_
	The caption to show for the input text.
std::string *	input_text_
	The text input.
unsigned	input_maximum_length_
	The maximum length of the input text.
std::vector< std::string >	option_list_
	The list of options the user can choose.
int *	chosen_option_
	The chosen option.

Detailed Description

Base class for the wml generated messages.

We have a separate sub class for left and right images.

Definition at line 28 of file wml_message.hpp.

Constructor & Destructor Documentation

gui2::twml_message_::twml_message_	(	const std::string &	title,
		const std::string &	message,
		const std::string &	portrait,
		const bool	mirror
	)			`[inline]`

Definition at line 32 of file wml_message.hpp.

Member Function Documentation

void gui2::twml_message_::post_show ( twindow & window ) [private, virtual]

Inherited from tdialog.

Reimplemented from gui2::tdialog.

Definition at line 146 of file wml_message.cpp.

References chosen_option_, has_input_, input_text_, and option_list_.

void gui2::twml_message_::pre_show	(	CVideo &	video,
		twindow &	window
	)			`[private, virtual]`

Inherited from tdialog.

Todo:: This function enables the wml markup for all items, but the interface is a bit hacky.

Especially the fiddling in the internals of the listbox is ugly. There needs to be a clean interface to set whether a widget has a markup and what kind of markup. These fixes will be post 1.6.

Todo:: This syntax looks like a bad hack, it would be nice to write a new syntax which doesn't use those hacks (also avoids the problem with special meanings for certain characters.

Reimplemented from gui2::tdialog.

Definition at line 62 of file wml_message.cpp.

References gui2::tlistbox::add_row(), gui2::tcontrol::canvas(), chosen_option_, gui2::tlegacy_menu_item::description(), has_input_, gui2::tlegacy_menu_item::icon(), input_caption_, input_maximum_length_, input_text_, gui2::twidget::INVISIBLE, gui2::tlegacy_menu_item::is_default(), gui2::tlegacy_menu_item::label(), message_, mirror_, option_list_, portrait_, gui2::tlistbox::select_row(), gui2::tlabel::set_can_wrap(), gui2::tcontrol::set_label(), gui2::tcontrol::set_use_markup(), gui2::twidget::set_visible(), and title_.