Shows a transient message. More...

#include <transient_message.hpp>

Inheritance diagram for gui2::dialogs::transient_message:

Public Member Functions
	transient_message (const std::string &title, const bool title_use_markup, const std::string &message, const bool message_use_markup, const std::string &image)

Public Member Functions inherited from gui2::dialogs::modal_dialog
	modal_dialog ()

virtual	~modal_dialog ()

bool	show (const unsigned auto_close_time=0)
	Shows the window. More...

window *	get_window () const
	Returns a pointer to the dialog's window. More...

int	get_retval () const
	Returns the cached window exit code. More...

void	set_retval (int retval)
	Convenience wrapper to set the window's exit code. More...

void	set_always_save_fields (const bool always_save_fields)

void	set_restore (const bool restore)

void	set_allow_plugin_skip (const bool allow_plugin_skip)

void	set_show_even_without_video (const bool show_even_without_video)

Private Member Functions
virtual const std::string &	window_id () const override
	The id of the window to build. More...

virtual void	pre_show (window &window) override
	Actions to be taken before showing the window. More...

Private Attributes
bool	hide_title_

bool	hide_image_

Additional Inherited Members
Protected Member Functions inherited from gui2::dialogs::modal_dialog
template<typename T , typename... Args>
T *	register_field (Args &&... args)
	Creates a new field of given type with given arguments. More...

field_bool *	register_bool (const std::string &id, const bool mandatory, const std::function< bool()> callback_load_value=nullptr, const std::function< void(bool)> callback_save_value=nullptr, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...

field_bool *	register_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...

field_integer *	register_integer (const std::string &id, const bool mandatory, const std::function< int()> callback_load_value=nullptr, const std::function< void(int)> callback_save_value=nullptr)
	Creates a new integer field. More...

field_integer *	register_integer (const std::string &id, const bool mandatory, int &linked_variable)
	Creates a new integer field. More...

field_text *	register_text (const std::string &id, const bool mandatory, const std::function< std::string()> callback_load_value=nullptr, const std::function< void(const std::string &)> callback_save_value=nullptr, const bool capture_focus=false)
	Creates a new text field. More...

field_text *	register_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
	Creates a new text field. More...

field_label *	register_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
	Registers a new styled_widget as a label. More...

field_label *	register_image (const std::string &id, const bool mandatory, const std::string &filename)
	Registers a new styled_widget as image. More...

Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< window >	window_
	The window object build for this dialog. More...

Detailed Description

Shows a transient message.

Definition at line 26 of file transient_message.hpp.

Constructor & Destructor Documentation

◆ transient_message()

gui2::dialogs::transient_message::transient_message	(	const std::string &	title,
		const bool	title_use_markup,
		const std::string &	message,
		const bool	message_use_markup,
		const std::string &	image
	)

Definition at line 34 of file transient_message.cpp.

Member Function Documentation

◆ pre_show()

void gui2::dialogs::transient_message::pre_show ( window & window )

overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters

window The window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 46 of file transient_message.cpp.

References hide_image_, hide_title_, gui2::widget::invisible, and gui2::widget::set_visible().

◆ window_id()

virtual const std::string& gui2::dialogs::transient_message::window_id ( ) const

overrideprivatevirtual

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ hide_image_

bool gui2::dialogs::transient_message::hide_image_

private

Definition at line 39 of file transient_message.hpp.

Referenced by pre_show().

◆ hide_title_

bool gui2::dialogs::transient_message::hide_title_

private

Definition at line 38 of file transient_message.hpp.

Referenced by pre_show().

The documentation for this class was generated from the following files:

gui/dialogs/transient_message.hpp
gui/dialogs/transient_message.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members