Abstract base class for all modal dialogs. More...

#include <modal_dialog.hpp>

Inheritance diagram for gui2::dialogs::modal_dialog:

Public Member Functions
	modal_dialog (const std::string &window_id)

virtual	~modal_dialog ()

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

void	set_always_save_fields (const bool always_save_fields)

void	set_allow_plugin_skip (const bool allow_plugin_skip)

void	set_show_even_without_video (const bool show_even_without_video)

Public Member Functions inherited from gui2::window
	window (const builder_window::window_resolution &definition)
	< Needs to be initialized in show. More...

virtual	~window ()

int	show (unsigned auto_close_timeout=0)
	Shows the window, running an event loop until it should close. More...

void	show_tooltip ()
	Shows the window as a tooltip. More...

void	show_non_modal ()
	Shows the window non modal. More...

void	draw ()
	Draws the window. More...

void	hide ()
	Hides the window. More...

virtual void	layout () override
	Lays out the window. More...

virtual void	render () override
	Ensure the window's internal render buffer is up-to-date. More...

virtual bool	expose (const rect &region) override
	Called by draw_manager when it believes a redraw is necessary. More...

virtual rect	screen_location () override
	The current draw location of the window, on the screen. More...

void	queue_rerender (const rect &region)
	Queue a rerender of the internal render buffer. More...

void	queue_rerender ()

void	defer_region (const rect &region)
	Defer rendering of a particular region to next frame. More...

void	close ()
	Requests to close the window. More...

bool	invalidate_layout_blocked () const
	Is invalidate_layout blocked, see invalidate_layout_blocker. More...

void	invalidate_layout ()
	Updates the size of the window. More...

virtual widget *	find_at (const point &coordinate, const bool must_be_active) override
	See widget::find_at. More...

virtual const widget *	find_at (const point &coordinate, const bool must_be_active) const override
	See widget::find_at. More...

dialogs::modal_dialog *	dialog ()
	Inherited from widget. More...

widget *	find (const std::string_view id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string_view id, const bool must_be_active) const override
	See widget::find. More...

bool	does_click_dismiss () const
	Does the window close easily? More...

void	set_enter_disabled (const bool enter_disabled)
	Disable the enter key. More...

void	set_escape_disabled (const bool escape_disabled)
	Disable the escape key. More...

bool	init_linked_size_group (const std::string &id, const bool fixed_width, const bool fixed_height)
	Initializes a linked size group. More...

bool	has_linked_size_group (const std::string &id)
	Is the linked size group defined for this window? More...

void	add_linked_widget (const std::string &id, widget *widget)
	Adds a widget to a linked size group. More...

void	remove_linked_widget (const std::string &id, const widget *widget)
	Removes a widget from a linked size group. More...

void	set_retval (const int retval, const bool close_window=true)
	Sets there return value of the window. More...

int	get_retval ()

void	set_owner (dialogs::modal_dialog *owner)

void	set_click_dismiss (const bool click_dismiss)

bool	get_need_layout () const

void	set_variable (const std::string &key, const wfl::variant &value)

point	get_linked_size (std::string_view group_id) const

template<typename Func >
void	set_exit_hook (exit_hook mode, const Func &hook)
	Sets the window's exit hook. More...

const event::distributor &	get_distributor () const
	Gets a reference to the window's distributor to allow some state peeking. More...

show_mode	mode () const
	Returns the dialog mode for this window. More...

void	mouse_capture (const bool capture=true)

void	keyboard_capture (widget *widget)

void	add_to_keyboard_chain (widget *widget)
	Adds the widget to the keyboard chain. More...

void	remove_from_keyboard_chain (widget *widget)
	Remove the widget from the keyboard chain. More...

void	add_to_tab_order (widget *widget, int at=-1)
	Add the widget to the tabbing order. More...

Public Member Functions inherited from gui2::panel
	panel (const implementation::builder_styled_widget &builder, const std::string &control_type="")
	Constructor. More...

virtual rect	get_client_rect () const override
	See container_base::get_client_rect. More...

virtual bool	get_active () const override
	See styled_widget::get_active. More...

virtual unsigned	get_state () const override
	See styled_widget::get_state. More...

Public Member Functions inherited from gui2::container_base
	container_base (const implementation::builder_styled_widget &builder, const std::string &control_type)

virtual void	layout_initialize (const bool full_initialization) override
	See widget::layout_initialize. More...

void	reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a container. More...

virtual void	request_reduce_width (const unsigned maximum_width) override
	See widget::request_reduce_width. More...

virtual void	demand_reduce_width (const unsigned maximum_width) override
	See widget::demand_reduce_width. More...

void	reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a container. More...

virtual void	request_reduce_height (const unsigned maximum_height) override
	See widget::request_reduce_height. More...

virtual void	demand_reduce_height (const unsigned maximum_height) override
	See widget::demand_reduce_height. More...

virtual bool	can_wrap () const override
	See widget::can_wrap. More...

virtual void	place (const point &origin, const point &size) override
	See widget::place. More...

virtual bool	has_widget (const widget &widget) const override
	See widget::has_widget. More...

virtual void	set_origin (const point &origin) override
	See widget::set_origin. More...

virtual void	set_visible_rectangle (const rect &rectangle) override
	See widget::set_visible_rectangle. More...

virtual void	impl_draw_children () override
	See widget::impl_draw_children. More...

virtual void	set_active (const bool active) override
	See styled_widget::set_active. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. More...

void	init_grid (const builder_grid &grid_builder)
	Initializes and builds the grid. More...

grid::iterator	begin ()

grid::iterator	end ()

unsigned	add_row (const unsigned count=1)

void	set_rows (const unsigned rows)

unsigned int	get_rows () const

void	set_cols (const unsigned cols)

unsigned int	get_cols () const

void	set_rows_cols (const unsigned rows, const unsigned cols)

void	set_child (std::unique_ptr< widget > widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)

void	set_row_grow_factor (const unsigned row, const unsigned factor)

void	set_column_grow_factor (const unsigned column, const unsigned factor)

const grid &	get_grid () const

grid &	get_grid ()

Public Member Functions inherited from gui2::styled_widget
	styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
	Constructor. More...

virtual void	set_members (const widget_item &data)
	Sets the members of the styled_widget. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

point	get_config_minimum_size () const
	Gets the minimum size as defined in the config. More...

point	get_config_default_size () const
	Gets the default size as defined in the config. More...

point	get_config_maximum_size () const
	Gets the best size as defined in the config. More...

virtual unsigned	get_characters_per_line () const
	Returns the number of characters per line. More...

virtual bool	get_link_aware () const
	Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...

virtual color_t	get_link_color () const
	Returns the color string to be used with links. More...

bool	get_use_tooltip_on_label_overflow () const

void	set_use_tooltip_on_label_overflow (const bool use_tooltip=true)

const t_string &	get_label () const

virtual void	set_label (const t_string &text)

virtual void	set_use_markup (bool use_markup)

bool	get_use_markup () const

const t_string &	tooltip () const

void	set_tooltip (const t_string &tooltip)

const t_string &	help_message () const

void	set_help_message (const t_string &help_message)

std::vector< canvas > &	get_canvases ()

canvas &	get_canvas (const unsigned index)

virtual void	set_text_alignment (const PangoAlignment text_alignment)

PangoAlignment	get_text_alignment () const

void	set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)

PangoEllipsizeMode	get_text_ellipse_mode () const
	Get the text's ellipsize mode. More...

Public Member Functions inherited from gui2::widget
	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget ()

	widget (const builder_widget &builder)
	Constructor. More...

virtual	~widget () override

void	set_id (const std::string &id)

const std::string &	id () const

window *	get_window ()
	Get the parent window. More...

const window *	get_window () const
	The constant version of get_window. More...

grid *	get_parent_grid ()
	Get the parent grid. More...

const grid *	get_parent_grid () const

void	set_parent (widget *parent)

widget *	parent ()

point	get_best_size () const
	Gets the best size for the widget. More...

virtual bool	can_mouse_focus () const
	Whether the mouse move/click event go 'through' this widget. More...

virtual void	set_size (const point &size)
	Sets the size of the widget. More...

virtual void	move (const int x_offset, const int y_offset)
	Moves a widget. More...

virtual void	set_horizontal_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	set_vertical_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

point	get_origin () const
	Returns the screen origin of the widget. More...

point	get_size () const
	Returns the size of the widget. More...

rect	get_rectangle () const
	Gets the bounding rectangle of the widget on the screen. More...

int	get_x () const

int	get_y () const

unsigned	get_width () const

unsigned	get_height () const

void	set_linked_group (const std::string &linked_group)

std::string	get_linked_group () const

rect	calculate_blitting_rectangle () const
	Calculates the blitting rectangle of the widget. More...

rect	calculate_clipping_rectangle () const
	Calculates the clipping rectangle of the widget. More...

bool	draw_background ()
	Draws the background of a widget. More...

void	draw_children ()
	Draws the children of a widget. More...

bool	draw_foreground ()
	Draws the foreground of the widget. More...

rect	get_dirty_rectangle () const
	Gets the dirty rectangle of the widget. More...

void	queue_redraw ()
	Indicates that this widget should be redrawn. More...

void	queue_redraw (const rect &region)
	Indicate that specific region of the screen should be redrawn. More...

void	set_visible (const visibility visible)

visibility	get_visible () const

void	set_visible (bool visible)
	Sets widget to visible if visible is true, else invisible. More...

redraw_action	get_drawing_action () const

void	set_debug_border_mode (const debug_border debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

template<class T >
T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

template<class T >
const T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist) const

template<class T >
T &	find_widget (const std::string_view id, const bool must_be_active=false)
	Gets a widget with the wanted id. More...

template<class T >
const T &	find_widget (const std::string_view id, const bool must_be_active=false) const

Public Member Functions inherited from gui2::event_executor
	event_executor ()

virtual	~event_executor ()

void	set_wants_mouse_hover (const bool hover=true)

bool	wants_mouse_hover () const

void	set_wants_mouse_left_double_click (const bool click=true)

bool	wants_mouse_left_double_click () const

void	set_wants_mouse_middle_double_click (const bool click=true)

bool	wants_mouse_middle_double_click () const

event_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::dispatcher
	dispatcher ()

virtual	~dispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

void	disconnect ()
	Disconnects the dispatcher from the event handler. More...

bool	is_connected () const
	Return whether the dispatcher is currently connected. More...

bool	has_event (const ui_event event, const event_queue_type event_type)

bool	fire (const ui_event event, widget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const ui_event event, widget &target, const point &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const ui_event event, widget &target, const point &pos, const point &distance)
	Fires an event which takes touch-motion parameters. More...

bool	fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
	Fires an event which takes touch-gesture parameters. More...

bool	fire (const ui_event event, widget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const ui_event event, widget &target, const message &msg)
	Fires an event which takes message parameters. More...

bool	fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
	Fires an event that's a raw SDL event. More...

bool	fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
	Fires an event which takes text input parameters. More...

template<ui_event E, typename F >
void	connect_signal (const F &func, const queue_position position=back_child)
	Adds a callback to the appropriate queue based on event type. More...

template<ui_event E, typename F >
void	disconnect_signal (const F &func, const queue_position position=back_child)
	Removes a callback from the appropriate queue based on event type. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const mouse_behavior mouse_behavior)

mouse_behavior	get_mouse_behavior () const

void	set_want_keyboard_input (const bool want_keyboard_input)

bool	get_want_keyboard_input () const

template<typename Func >
void	register_hotkey (const hotkey::HOTKEY_COMMAND id, Func &&function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Public Member Functions inherited from enable_lua_ptr< widget >
	enable_lua_ptr (widget *tp)

	enable_lua_ptr (enable_lua_ptr &&o)

enable_lua_ptr &	operator= (enable_lua_ptr &&o)

Public Member Functions inherited from gui2::top_level_drawable
virtual void	update ()
	Update state and any parameters that may effect layout, or any of the later stages. More...

Protected Member Functions
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 Member Functions inherited from gui2::container_base
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

virtual void	layout_children () override
	See widget::layout_children. More...

Protected Member Functions inherited from gui2::styled_widget
resolution_definition_ptr	get_config ()

resolution_definition_const_ptr	get_config () const

template<typename T >
std::shared_ptr< const typename T::resolution >	cast_config_to () const
	Casts the current resolution definition config to the respective type of a derived widget. More...

virtual void	update_canvas ()
	Updates the canvas(ses). More...

unsigned int	get_text_font_size () const
	Resolves and returns the text_font_size. More...

int	get_text_maximum_width () const
	Returns the maximum width available for the text. More...

int	get_text_maximum_height () const
	Returns the maximum height available for the text. More...

std::string	get_label_token (const point &position, std::string_view delimiters=" \n\r\t") const
	Exposes font::pango_text::get_token, for the text label of this styled_widget. More...

std::string	get_label_link (const point &position) const

Protected Member Functions inherited from gui2::widget
void	set_layout_size (const point &size)

const point &	layout_size () const

void	clear_layout_size ()
	Throws away layout_size_. More...

Protected Member Functions inherited from gui2::top_level_drawable
	top_level_drawable ()

virtual	~top_level_drawable ()

	top_level_drawable (const top_level_drawable &)

top_level_drawable &	operator= (const top_level_drawable &)

	top_level_drawable (top_level_drawable &&) noexcept

top_level_drawable &	operator= (top_level_drawable &&) noexcept

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

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

virtual void	post_show ()
	Actions to be taken after the window has been shown. More...

void	init_fields ()
	Initializes all fields in the dialog and set the keyboard focus. More...

void	finalize_fields (const bool save_fields)
	When the dialog is closed with the OK status saves all fields. More...

Private Attributes
bool	always_save_fields_
	Always save the fields upon closing. More...

std::vector< std::unique_ptr< class field_base > >	fields_
	Contains the automatically managed fields. More...

std::string	focus_
	Contains the widget that should get the focus when the window is shown. More...

bool	allow_plugin_skip_
	Allow plugins to skip through the dialog? Most dialogs install a plugins context to allow plugins to accept whatever the dialog is offering and continue. More...

bool	show_even_without_video_
	Show the dialog even with –nogui? Some dialogs need to be shown even when –nogui is specified if the game is being driven by a plugin. More...

Friends
std::string	get_modal_dialog_id (const modal_dialog &dialog)
	Special helper function to get the id of the window. More...

Additional Inherited Members
Public Types inherited from gui2::window
enum class	status { NEW , SHOWING , REQUEST_CLOSE , CLOSED }
	The status of the window. More...

enum class	exit_hook { always , ok_only }

enum class	show_mode { none , modal , modeless , tooltip }

Public Types inherited from gui2::widget
enum class	visibility { visible , hidden , invisible }
	Visibility settings done by the user. More...

enum class	redraw_action { full , partly , none }
	Visibility set by the engine. More...

enum class	debug_border { none , outline , fill }

Public Types inherited from gui2::event::dispatcher
enum	event_queue_type { pre = 1 , child = 2 , post = 4 }

enum	queue_position { front_pre_child , back_pre_child , front_child , back_child , front_post_child , back_post_child }
	The position where to add a new callback in the signal handler. More...

enum class	mouse_behavior { all , hit , none }
	The behavior of the mouse events. More...

Static Public Member Functions inherited from gui2::window
static window *	window_instance (const unsigned handle)
	Returns the instance of a window. More...

static retval	get_retval_by_id (const std::string &id)
	Gets the retval for the default buttons. More...

static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Static Public Member Functions inherited from gui2::panel
static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Detailed Description

Abstract base class for all modal dialogs.

A dialog shows a certain window instance to the user. The subclasses of this class will hold the parameters used for a certain window, eg a server connection dialog will hold the name of the selected server as parameter that way the caller doesn't need to know about the 'contents' of the window.

Usage

Simple dialogs that are shown to query user information it is recommended to add a static member called execute. The parameters to the function are:

references to in + out parameters by reference
references to the in parameters
the parameters for modal_dialog::show.

The 'in + out parameters' are used as initial value and final value when the OK button is pressed. The 'in parameters' are just extra parameters for showing.

When a function only has 'in parameters' it should return a void value and the function should be called display, if it has 'in + out parameters' it must return a bool value. This value indicates whether or not the OK button was pressed to close the dialog. See editor_new_map::execute for an example.

Definition at line 145 of file modal_dialog.hpp.

Constructor & Destructor Documentation

◆ modal_dialog()

gui2::dialogs::modal_dialog::modal_dialog ( const std::string & window_id )

explicit

Definition at line 36 of file modal_dialog.cpp.

References gui2::widget::set_id(), and window_id().

◆ ~modal_dialog()

gui2::dialogs::modal_dialog::~modal_dialog ( )

virtual

Definition at line 47 of file modal_dialog.cpp.

Member Function Documentation

◆ finalize_fields()

void gui2::dialogs::modal_dialog::finalize_fields ( const bool save_fields )

private

When the dialog is closed with the OK status saves all fields.

Saving only happens if a callback handler is installed.

Parameters

save_fields Does the value in the fields need to be saved?

Definition at line 228 of file modal_dialog.cpp.

References gui2::field_base::detach_from_window(), fields_, and gui2::field_base::widget_finalize().

Referenced by show().

◆ init_fields()

void gui2::dialogs::modal_dialog::init_fields ( )

private

Initializes all fields in the dialog and set the keyboard focus.

Definition at line 213 of file modal_dialog.cpp.

References gui2::field_base::attach_to_window(), fields_, gui2::window::find(), focus_, gui2::window::keyboard_capture(), and gui2::field_base::widget_init().

Referenced by show().

◆ post_show()

void gui2::dialogs::modal_dialog::post_show ( )

privatevirtual

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the button with id 'ok' has been pressed).

Reimplemented in gui2::dialogs::wml_message_base, gui2::dialogs::units_dialog, gui2::dialogs::unit_attack, gui2::dialogs::unit_advance, gui2::dialogs::theme_list, gui2::dialogs::story_viewer, gui2::dialogs::sp_options_configure, gui2::dialogs::simple_item_selector, gui2::dialogs::select_orb_colors, gui2::dialogs::reachmap_options, gui2::dialogs::prompt, gui2::dialogs::preferences_dialog, gui2::dialogs::network_transmission, gui2::dialogs::lobby_player_info, gui2::dialogs::mp_staging, gui2::dialogs::mp_report, gui2::dialogs::mp_method_selection, gui2::dialogs::mp_login, gui2::dialogs::mp_join_game, gui2::dialogs::mp_create_game, gui2::dialogs::mp_change_control, gui2::dialogs::mp_alerts_options, gui2::dialogs::mp_lobby, gui2::dialogs::faction_select, gui2::dialogs::migrate_version_selection, gui2::dialogs::message, gui2::dialogs::log_settings, gui2::dialogs::loading_screen, gui2::dialogs::language_selection, gui2::dialogs::label_settings, gui2::dialogs::gui_test_dialog, gui2::dialogs::game_stats, gui2::dialogs::game_cache_options, gui2::dialogs::tod_new_schedule, gui2::dialogs::editor_edit_side, gui2::dialogs::editor_edit_pbl_translation, gui2::dialogs::editor_edit_pbl, gui2::dialogs::custom_tod, gui2::dialogs::editor_choose_addon, gui2::dialogs::drop_down_menu, gui2::dialogs::depcheck_select_new, gui2::dialogs::core_selection, gui2::dialogs::campaign_difficulty, gui2::dialogs::addon_uninstall_list, gui2::dialogs::addon_connect, gui2::dialogs::addon_server_info, gui2::dialogs::addon_auth, and gui2::dialogs::achievements_dialog.

Definition at line 208 of file modal_dialog.cpp.

Referenced by show().

◆ pre_show()

void gui2::dialogs::modal_dialog::pre_show ( )

privatevirtual

Actions to be taken before showing the window.

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

Definition at line 203 of file modal_dialog.cpp.

Referenced by show().

◆ register_bool() [1/2]

field_bool * gui2::dialogs::modal_dialog::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`
	)

protected

Creates a new boolean field.

The field created is owned by modal_dialog, the returned pointer can be used in the child classes as access to a field.

Parameters

id	Id of the widget, same value as in WML.
mandatory	Is the widget mandatory or optional?
linked_variable	The variable the widget is linked to. See field::field for more information.
callback_change	When the value of the widget changes this callback is called.
initial_fire

Returns: Pointer to the created widget.

Definition at line 123 of file modal_dialog.cpp.

References fields_.

◆ register_bool() [2/2]

field_bool * gui2::dialogs::modal_dialog::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`
	)

protected

Creates a new boolean field.

The field created is owned by modal_dialog, the returned pointer can be used in the child classes as access to a field.

Parameters

id	Id of the widget, same value as in WML.
mandatory	Is the widget mandatory or optional?
callback_load_value	The callback function to set the initial value of the widget.
callback_save_value	The callback function to write the resulting value of the widget. Saving will only happen if the widget is enabled and the window closed with ok.
callback_change	When the value of the widget changes this callback is called.
initial_fire

Returns: Pointer to the created widget.

Definition at line 103 of file modal_dialog.cpp.

References fields_.

Referenced by gui2::dialogs::game_delete::game_delete(), gui2::dialogs::preferences_dialog::initialize_callbacks(), gui2::dialogs::preferences_dialog::initialize_sound_option_group(), and gui2::dialogs::mp_host_game_prompt::mp_host_game_prompt().

◆ register_field()

template<typename T , typename... Args>

T * gui2::dialogs::modal_dialog::register_field ( Args &&... args )

protected

Creates a new field of given type with given arguments.

The field created is owned by modal_dialog, the returned pointer can be used in the child classes as access to a field.

Parameters

args	Arguments to forward to the field constructor.

Definition at line 94 of file modal_dialog.cpp.

References fields_.

◆ register_image()

field_label* gui2::dialogs::modal_dialog::register_image	(	const std::string &	id,
		const bool	mandatory,
		const std::string &	filename
	)

inlineprotected

Registers a new styled_widget as image.

Definition at line 317 of file modal_dialog.hpp.

References filename, and register_label().

◆ register_integer() [1/2]

field_integer * gui2::dialogs::modal_dialog::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`
	)

protected

Creates a new integer field.

See register_bool for more info.

Definition at line 136 of file modal_dialog.cpp.

References fields_.

Referenced by gui2::dialogs::preferences_dialog::initialize_callbacks(), gui2::dialogs::preferences_dialog::initialize_sound_option_group(), and gui2::dialogs::editor_edit_label::register_color_component().

◆ register_integer() [2/2]

field_integer * gui2::dialogs::modal_dialog::register_integer	(	const std::string &	id,
		const bool	mandatory,
		int &	linked_variable
	)

protected

Creates a new integer field.

See register_bool for more info.

Definition at line 149 of file modal_dialog.cpp.

References fields_.

◆ register_label()

field_label * gui2::dialogs::modal_dialog::register_label	(	const std::string &	id,
		const bool	mandatory,
		const std::string &	text,
		const bool	use_markup = `false`
	)

protected

Registers a new styled_widget as a label.

The label is used for a styled_widget to set the 'label' since it calls the styled_widget::set_label it can also be used for the image since there this sets the filename. (The use_markup makes no sense in an image but that's a detail.)

Note: In general it's preferred a widget sets its markup flag in WML, but some generic windows (like messages) may need different versions depending on where used.

Parameters

id	Id of the widget, same value as in WML.
mandatory	Is the widget mandatory or optional?
text	The text for the label.
use_markup	Whether or not use markup for the label.

Definition at line 192 of file modal_dialog.cpp.

References fields_.

Referenced by gui2::dialogs::network_transmission::network_transmission(), and register_image().

◆ register_text() [1/2]

field_text * gui2::dialogs::modal_dialog::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`
	)

protected

Creates a new text field.

See register_bool for more info.

Definition at line 159 of file modal_dialog.cpp.

References fields_, focus_, and gui2::widget::id().

Referenced by gui2::dialogs::editor_generate_map::pre_show(), and gui2::dialogs::lua_interpreter::pre_show().

◆ register_text() [2/2]

field_text * gui2::dialogs::modal_dialog::register_text	(	const std::string &	id,
		const bool	mandatory,
		std::string &	linked_variable,
		const bool	capture_focus = `false`
	)

protected

Creates a new text field.

See register_bool for more info.

Definition at line 177 of file modal_dialog.cpp.

References fields_, focus_, and gui2::widget::id().

◆ set_allow_plugin_skip()

void gui2::dialogs::modal_dialog::set_allow_plugin_skip ( const bool allow_plugin_skip )

inline

Definition at line 180 of file modal_dialog.hpp.

References allow_plugin_skip_.

Referenced by gui2::dialogs::loading_screen::loading_screen().

◆ set_always_save_fields()

void gui2::dialogs::modal_dialog::set_always_save_fields ( const bool always_save_fields )

inline

Definition at line 175 of file modal_dialog.hpp.

References always_save_fields_.

Referenced by gui2::dialogs::preferences_dialog::pre_show().

◆ set_show_even_without_video()

void gui2::dialogs::modal_dialog::set_show_even_without_video ( const bool show_even_without_video )

inline

Definition at line 185 of file modal_dialog.hpp.

References show_even_without_video_.

◆ show()

bool gui2::dialogs::modal_dialog::show ( const unsigned auto_close_time = 0 )

Shows the window.

Parameters

auto_close_time The time in ms after which the dialog will automatically close, if 0 it doesn't close.

Note: the timeout is a minimum time and there's no guarantee about how fast it closes after the minimum.

Returns: Whether the final retval_ == retval::OK

Definition at line 51 of file modal_dialog.cpp.

References allow_plugin_skip_, always_save_fields_, plugins_manager::any_running(), c, gui2::CANCEL, DBG_DP, finalize_fields(), plugins_manager::get(), gui2::window::get_retval(), video::headless(), init_fields(), cursor::NORMAL, gui2::OK, plugins_context::play_slice(), post_show(), pre_show(), plugins_context::set_accessor_string(), plugins_context::set_callback(), gui2::window::set_retval(), gui2::window::show(), show_even_without_video_, and window_id().

Referenced by gui2::dialogs::preferences_dialog::add_hotkey_callback(), editor::context_manager::apply_mask_dialog(), BOOST_AUTO_TEST_CASE(), gui2::dialogs::title_screen::button_callback_cores(), gui2::dialogs::title_screen::button_callback_multiplayer(), ng::depcheck::manager::change_era_dialog(), ng::depcheck::manager::change_scenario_dialog(), editor::context_manager::create_mask_to_dialog(), editor::editor_controller::custom_tods_dialog(), quit_confirmation::default_prompt(), gui2::dialogs::story_viewer::display(), events::console_handler::do_choose_level(), hotkey::command_executor::do_execute_command(), editor::editor_controller::do_execute_command(), do_gameloop(), gui2::dialogs::migrate_version_selection::execute(), gui2::dialogs::game_load::execute(), gui2::dialogs::bookmark_create::execute(), editor::context_manager::generate_map_dialog(), gui2::dialogs::title_screen::hotkey_callback_select_tests(), editor::initialize_addon(), editor::context_manager::load_map_dialog(), manage_addons(), wb::manager::options_dlg(), gui2::dialogs::mp_create_game::post_show(), playmp_controller::process_network_side_drop_impl(), events::menu_handler::save_map(), editor::context_manager::save_map_as_dialog(), editor::context_manager::save_scenario_as_dialog(), sp::select_campaign(), ng::create_engine::select_campaign_difficulty(), gui2::dialogs::custom_tod::select_file(), gui2::dialogs::editor_edit_unit::select_file(), gui2::dialogs::editor_edit_pbl::select_icon_file(), gui2::dialogs::units_dialog::set_show_dismiss(), gui2::dialogs::units_dialog::set_show_favorite(), gui2::dialogs::units_dialog::set_show_rename(), gui2::dialogs::units_dialog::set_show_variations(), events::mouse_handler::show_attack_dialog(), savegame::loadgame::show_difficulty_dialog(), gui2::dialogs::mp_join_game::show_flg_select(), lua_gui2::show_menu(), gui2::show_message(), gui2::dialogs::title_screen::show_preferences(), savegame::savegame::show_save_dialog(), savegame::oos_savegame::show_save_dialog(), prefs::show_theme_dialog(), gui2::show_transient_message(), gui2::menu_button::signal_handler_left_button_click(), gui2::multimenu_button::signal_handler_left_button_click(), gui2::combobox::signal_handler_left_button_down(), editor::editor_controller::unit_editor_dialog(), gui2::dialogs::mp_lobby::user_dialog_callback(), and addons_client::wait_for_transfer_done().

◆ window_id()

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

privatepure virtual

The ID of the window to build.

Usually set by REGISTER_DIALOG.

Referenced by modal_dialog(), and show().

Friends And Related Function Documentation

◆ get_modal_dialog_id

std::string get_modal_dialog_id ( const modal_dialog & dialog )

friend

Special helper function to get the id of the window.

This is used in the unit tests, but these implementation details shouldn't be used in the normal code.

Definition at line 178 of file test_gui2.cpp.

Member Data Documentation

◆ allow_plugin_skip_

bool gui2::dialogs::modal_dialog::allow_plugin_skip_

private

Allow plugins to skip through the dialog? Most dialogs install a plugins context to allow plugins to accept whatever the dialog is offering and continue.

Some dialogs, especially those that install their own plugins context, may want to disable this.

Definition at line 355 of file modal_dialog.hpp.

Referenced by set_allow_plugin_skip(), and show().

◆ always_save_fields_

bool gui2::dialogs::modal_dialog::always_save_fields_

private

Always save the fields upon closing.

Normally fields are only saved when the retval::OK button is pressed. With this flag set is always saves. Be careful with the flag since it also updates upon canceling, which can be a problem when the field sets a preference.

Definition at line 333 of file modal_dialog.hpp.

Referenced by set_always_save_fields(), and show().

◆ fields_

std::vector<std::unique_ptr<class field_base> > gui2::dialogs::modal_dialog::fields_

private

Contains the automatically managed fields.

Since the fields are automatically managed and there are no search functions defined we don't offer access to the vector. If access is needed the creator should store a copy of the pointer.

Definition at line 342 of file modal_dialog.hpp.

Referenced by finalize_fields(), init_fields(), register_bool(), register_field(), register_integer(), register_label(), and register_text().

◆ focus_

std::string gui2::dialogs::modal_dialog::focus_

private

Contains the widget that should get the focus when the window is shown.

Definition at line 347 of file modal_dialog.hpp.

Referenced by init_fields(), and register_text().

◆ show_even_without_video_

bool gui2::dialogs::modal_dialog::show_even_without_video_

private

Show the dialog even with –nogui? Some dialogs need to be shown even when –nogui is specified if the game is being driven by a plugin.

Those dialogs allow the plugin to styled_widget them by creating a plugin context in pre_show().

Definition at line 362 of file modal_dialog.hpp.

Referenced by set_show_even_without_video(), and show().

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

gui/dialogs/modal_dialog.hpp
gui/dialogs/modal_dialog.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ modal_dialog()

◆ ~modal_dialog()

Member Function Documentation

◆ finalize_fields()

◆ init_fields()

◆ post_show()

◆ pre_show()

◆ register_bool() [1/2]

◆ register_bool() [2/2]

◆ register_field()

◆ register_image()

◆ register_integer() [1/2]

◆ register_integer() [2/2]

◆ register_label()

◆ register_text() [1/2]

◆ register_text() [2/2]

◆ set_allow_plugin_skip()

◆ set_always_save_fields()

◆ set_show_even_without_video()

◆ show()

◆ window_id()

Friends And Related Function Documentation

◆ get_modal_dialog_id

Member Data Documentation

◆ allow_plugin_skip_

◆ always_save_fields_

◆ fields_

◆ focus_

◆ show_even_without_video_