The Battle for Wesnoth  1.17.8+dev
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
gui2::dialogs::modal_dialog Class Referenceabstract

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...
 
windowget_window ()
 Returns a pointer to the dialog's window. More...
 
const windowget_window () const
 
int get_retval () const
 Returns the cached window exit code. 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 ()
 
void finish_build (const builder_window::window_resolution &)
 
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 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 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 widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::find_at. More...
 
dialogs::modal_dialogdialog ()
 Inherited from widget. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &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...
 
void 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 (const std::string &linked_group_id) const
 
void set_exit_hook (std::function< bool(window &)> func)
 Sets the window's exit hook. More...
 
void set_exit_hook_ok_only (std::function< bool(window &)> func)
 
const event::distributorget_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 SDL_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 SDL_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 gridget_grid () const
 
gridget_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_stringget_label () const
 
virtual void set_label (const t_string &label)
 
virtual void set_use_markup (bool use_markup)
 
bool get_use_markup () const
 
const t_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< canvas > & get_canvases ()
 
canvasget_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
 
widgetoperator= (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
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
void set_parent (widget *parent)
 
widgetparent ()
 
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)
 
SDL_Rect calculate_blitting_rectangle () const
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle () const
 Calculates the clipping rectangle of the widget. More...
 
void draw_background ()
 Draws the background of a widget. More...
 
void draw_children ()
 Draws the children of a widget. More...
 
void draw_foreground ()
 Draws the foreground of the widget. More...
 
SDL_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
 
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)
 
- 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_executorset_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
 
void register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &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)
 
- 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...
 
virtual void render ()
 Perform any internal rendering necessary to prepare the drawable. 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_boolregister_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_boolregister_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_integerregister_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_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
field_textregister_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_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
field_labelregister_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_labelregister_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...
 
void set_config (resolution_definition_ptr config)
 
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, const char *delimiters=" \\) 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 pointlayout_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_drawableoperator= (const top_level_drawable &)
 
 top_level_drawable (top_level_drawable &&)
 
top_level_drawableoperator= (top_level_drawable &&)
 

Private Member Functions

virtual const std::string & window_id () const =0
 The ID of the window to build. More...
 
virtual void pre_show (window &window)
 Actions to be taken before showing the window. More...
 
virtual void post_show (window &window)
 Actions to be taken after the window has been shown. More...
 
virtual void init_fields ()
 Initializes all fields in the dialog and set the keyboard focus. More...
 
virtual void finalize_fields (const bool save_fields)
 When the dialog is closed with the OK status saves all fields. More...
 

Private Attributes

int retval_
 The window's exit code (return value). More...
 
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  status { status::NEW, status::SHOWING, status::REQUEST_CLOSE, status::CLOSED }
 The status of the window. More...
 
enum  show_mode { show_mode::none, show_mode::modal, show_mode::modeless, show_mode::tooltip }
 
- Public Types inherited from gui2::widget
enum  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
enum  debug_border { debug_border::none, debug_border::outline, debug_border::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  mouse_behavior { mouse_behavior::all, mouse_behavior::hit, mouse_behavior::none }
 The behavior of the mouse events. More...
 
- Static Public Member Functions inherited from gui2::window
static windowwindow_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:

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

◆ ~modal_dialog()

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

Member Function Documentation

◆ finalize_fields()

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

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

Saving only happens if a callback handler is installed.

Parameters
save_fieldsDoes the value in the fields need to be saved?

Definition at line 254 of file modal_dialog.cpp.

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

Referenced by show().

◆ get_retval()

int gui2::dialogs::modal_dialog::get_retval ( ) const
inline

◆ get_window() [1/2]

window* gui2::dialogs::modal_dialog::get_window ( )
inline

Returns a pointer to the dialog's window.

Will be null if it hasn't been built yet.

Definition at line 177 of file modal_dialog.hpp.

Referenced by gui2::dialogs::statistics_dialog::add_damage_row(), gui2::dialogs::statistics_dialog::add_hits_row(), gui2::dialogs::mp_staging::add_side_to_team_node(), gui2::dialogs::statistics_dialog::add_stat_row(), gui2::dialogs::addon_manager::apply_filters(), gui2::dialogs::title_screen::button_callback_cores(), gui2::dialogs::title_screen::button_callback_multiplayer(), gui2::dialogs::lobby_player_info::check_status_button_callback(), gui2::dialogs::mp_join_game::close_faction_select_dialog_if_open(), gui2::dialogs::mp_connect::current_selection(), gui2::dialogs::unit_attack::damage_calc_callback(), gui2::dialogs::game_load::delete_button_callback(), gui2::dialogs::unit_recall::dismiss_unit(), gui2::dialogs::mp_create_game::display_games_of_type(), gui2::dialogs::story_viewer::display_part(), gui2::dialogs::game_load::display_savegame(), gui2::dialogs::game_load::display_savegame_internal(), gui2::dialogs::editor_generate_map::do_generator_selected(), gui2::dialogs::story_viewer::draw_floating_image(), gui2::dialogs::mp_lobby::enter_game(), gui2::dialogs::addon_manager::execute_action_on_selected_addon(), gui2::dialogs::addon_manager::fetch_addons_list(), gui2::dialogs::unit_recruit::filter_text_changed(), gui2::dialogs::log_settings::filter_text_changed(), gui2::dialogs::unit_recall::filter_text_changed(), gui2::dialogs::game_load::filter_text_changed(), gui2::dialogs::story_viewer::flag_stack_as_dirty(), gui2::dialogs::mp_join_game::generate_side_list(), gui2::dialogs::addon_manager::get_name_filter_visibility(), gui2::dialogs::addon_manager::get_status_filter_visibility(), gui2::dialogs::addon_manager::get_tag_filter_visibility(), gui2::dialogs::drop_down_menu::get_toggle_states(), gui2::dialogs::addon_manager::get_type_filter_visibility(), gui2::dialogs::game_load::handle_dir_select(), gui2::dialogs::synched_choice_wait::handle_generic_event(), gui2::dialogs::mp_change_control::handle_nicks_list_item_clicked(), gui2::dialogs::mp_change_control::handle_sides_list_item_clicked(), gui2::dialogs::mp_change_control::highlight_side_nick(), gui2::dialogs::addon_manager::install_addon(), gui2::dialogs::game_load::key_press_callback(), gui2::dialogs::lobby_player_info::kick_ban_button_callback(), gui2::dialogs::lobby_player_info::kick_button_callback(), gui2::dialogs::unit_advance::list_item_clicked(), gui2::dialogs::unit_recruit::list_item_clicked(), gui2::dialogs::unit_list::list_item_clicked(), gui2::dialogs::unit_recall::list_item_clicked(), gui2::dialogs::addon_manager::load_addon_list(), gui2::dialogs::drop_down_menu::mouse_up_callback(), gui2::dialogs::story_viewer::nav_button_callback(), gui2::dialogs::mp_join_game::network_handler(), gui2::dialogs::mp_staging::network_handler(), gui2::dialogs::addon_manager::on_addon_select(), gui2::dialogs::file_dialog::on_bookmark_add_cmd(), gui2::dialogs::file_dialog::on_bookmark_del_cmd(), gui2::dialogs::file_dialog::on_bookmark_selected(), gui2::dialogs::faction_select::on_faction_select(), gui2::dialogs::mp_create_game::on_filter_change(), gui2::dialogs::mp_create_game::on_game_select(), gui2::dialogs::faction_select::on_leader_select(), gui2::dialogs::addon_manager::on_order_changed(), gui2::dialogs::statistics_dialog::on_primary_list_select(), gui2::dialogs::mp_create_game::on_random_faction_mode_select(), gui2::dialogs::file_dialog::on_row_selected(), gui2::dialogs::statistics_dialog::on_scenario_select(), gui2::dialogs::addon_manager::on_selected_version_change(), gui2::dialogs::mp_connect::on_server_add(), gui2::dialogs::mp_connect::on_server_delete(), gui2::dialogs::mp_connect::on_server_select(), gui2::dialogs::game_stats::on_tab_select(), gui2::dialogs::mp_create_game::on_tab_select(), gui2::dialogs::mp_staging::on_team_select(), gui2::dialogs::edit_text::on_text_change(), gui2::dialogs::help_browser::on_topic_select(), gui2::dialogs::addon_manager::order_addons(), gui2::dialogs::game_load::populate_game_list(), gui2::dialogs::file_dialog::process_fileview_submit(), gui2::dialogs::file_dialog::process_textbox_submit(), gui2::dialogs::faction_select::profile_button_callback(), gui2::dialogs::file_dialog::refresh_fileview(), gui2::dialogs::addon_manager::reload_list_and_reselect_item(), gui2::dialogs::unit_recall::rename_unit(), gui2::dialogs::mp_report::report_reason_changed(), gui2::dialogs::mp_report::reportee_changed(), gui2::dialogs::select_orb_colors::reset_orb_toggle(), gui2::dialogs::screenshot_notification::save_screenshot(), gui2::dialogs::mp_connect::select_first_match(), gui2::dialogs::select_orb_colors::setup_orb_group(), gui2::dialogs::select_orb_colors::setup_orb_toggle(), gui2::dialogs::mp_create_game::show_description(), gui2::dialogs::mp_lobby::skip_replay_changed_callback(), gui2::dialogs::lobby_player_info::start_whisper_button_callback(), gui2::dialogs::lobby_player_info::stopgame_button_callback(), gui2::dialogs::file_dialog::sync_bookmarks_bar(), gui2::dialogs::mp_create_game::sync_with_depcheck(), gui2::dialogs::server_info::tab_switch_callback(), gui2::dialogs::game_version::tab_switch_callback(), gui2::dialogs::story_viewer::update(), gui2::dialogs::mp_create_game::update_details(), gui2::dialogs::mp_create_game::update_games_list(), gui2::dialogs::custom_tod::update_lawful_bonus(), gui2::dialogs::faction_select::update_leader_image(), gui2::dialogs::statistics_dialog::update_lists(), gui2::dialogs::mp_create_game::update_map_settings(), gui2::dialogs::mp_lobby::update_selected_game(), gui2::dialogs::custom_tod::update_selected_tod_info(), gui2::dialogs::mp_staging::update_status_label_and_buttons(), gui2::dialogs::title_screen::update_tip(), and gui2::dialogs::custom_tod::update_tod_display().

◆ get_window() [2/2]

const window* gui2::dialogs::modal_dialog::get_window ( ) const
inline

Definition at line 181 of file modal_dialog.hpp.

◆ init_fields()

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

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

Parameters
windowThe window which has been shown.

Definition at line 239 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 ( window window)
privatevirtual

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the OK has been pressed).

Parameters
windowThe window which has been shown.

Reimplemented in gui2::dialogs::mp_lobby, gui2::dialogs::wml_message_base, gui2::dialogs::loading_screen, gui2::dialogs::message, gui2::dialogs::drop_down_menu, gui2::dialogs::simple_item_selector, gui2::dialogs::campaign_selection, gui2::dialogs::unit_create, gui2::dialogs::preferences_dialog, gui2::dialogs::game_cache_options, gui2::dialogs::sp_options_configure, gui2::dialogs::network_transmission, gui2::dialogs::campaign_difficulty, gui2::dialogs::game_stats, gui2::dialogs::unit_recall, gui2::dialogs::depcheck_select_new, gui2::dialogs::theme_list, gui2::dialogs::custom_tod, gui2::dialogs::mp_method_selection, gui2::dialogs::addon_uninstall_list, gui2::dialogs::core_selection, gui2::dialogs::unit_attack, gui2::dialogs::unit_list, gui2::dialogs::select_orb_colors, gui2::dialogs::addon_connect, gui2::dialogs::mp_staging, gui2::dialogs::mp_alerts_options, gui2::dialogs::mp_create_game, gui2::dialogs::story_viewer, gui2::dialogs::log_settings, gui2::dialogs::mp_change_control, gui2::dialogs::lobby_player_info, gui2::dialogs::editor_edit_side, gui2::dialogs::faction_select, gui2::dialogs::mp_login, gui2::dialogs::language_selection, gui2::dialogs::outro, gui2::dialogs::mp_join_game, gui2::dialogs::mp_report, gui2::dialogs::label_settings, gui2::dialogs::unit_recruit, gui2::dialogs::addon_auth, gui2::dialogs::unit_advance, and gui2::dialogs::migrate_version_selection.

Definition at line 234 of file modal_dialog.cpp.

Referenced by show().

◆ pre_show()

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

Actions to be taken before showing the window.

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

Parameters
windowThe window to be shown.

Reimplemented in gui2::dialogs::file_dialog, gui2::dialogs::wml_message_double, gui2::dialogs::mp_lobby, gui2::dialogs::wml_message_base, gui2::dialogs::editor_resize_map, gui2::dialogs::loading_screen, gui2::dialogs::message, gui2::dialogs::drop_down_menu, gui2::dialogs::simple_item_selector, gui2::dialogs::campaign_selection, gui2::dialogs::unit_create, gui2::dialogs::addon_manager, gui2::dialogs::game_version, gui2::dialogs::preferences_dialog, gui2::dialogs::game_cache_options, gui2::dialogs::wml_error, gui2::dialogs::sp_options_configure, gui2::dialogs::network_transmission, gui2::dialogs::campaign_difficulty, gui2::dialogs::edit_text, gui2::dialogs::editor_edit_label, gui2::dialogs::game_stats, gui2::dialogs::unit_recall, gui2::dialogs::screenshot_notification, gui2::dialogs::depcheck_select_new, gui2::dialogs::folder_create, gui2::dialogs::theme_list, gui2::dialogs::custom_tod, gui2::dialogs::mp_method_selection, gui2::dialogs::addon_uninstall_list, gui2::dialogs::editor_generate_map, gui2::dialogs::core_selection, gui2::dialogs::unit_attack, gui2::dialogs::unit_list, gui2::dialogs::game_load, gui2::dialogs::select_orb_colors, gui2::dialogs::addon_connect, gui2::dialogs::mp_connect, gui2::dialogs::formula_debugger, gui2::dialogs::mp_staging, gui2::dialogs::story_viewer, gui2::dialogs::editor_edit_scenario, gui2::dialogs::mp_alerts_options, gui2::dialogs::mp_create_game, gui2::dialogs::editor_edit_side, gui2::dialogs::gamestate_inspector, gui2::dialogs::log_settings, gui2::dialogs::mp_change_control, gui2::dialogs::lobby_player_info, gui2::dialogs::faction_select, gui2::dialogs::mp_login, gui2::dialogs::language_selection, gui2::dialogs::outro, gui2::dialogs::hotkey_bind, gui2::dialogs::mp_join_game, gui2::dialogs::server_info, gui2::dialogs::attack_predictions, gui2::dialogs::end_credits, gui2::dialogs::mp_match_history, gui2::dialogs::mp_report, gui2::dialogs::transient_message, gui2::dialogs::unit_recruit, gui2::dialogs::label_settings, gui2::dialogs::addon_auth, gui2::dialogs::synched_choice_wait, gui2::dialogs::help_browser, gui2::dialogs::terrain_layers, gui2::dialogs::statistics_dialog, gui2::dialogs::install_dependencies, gui2::dialogs::generator_settings, gui2::dialogs::chat_log, gui2::dialogs::lua_interpreter, gui2::dialogs::unit_advance, and gui2::dialogs::migrate_version_selection.

Definition at line 229 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,
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
idId of the widget, same value as in WML.
mandatoryIs the widget mandatory or mandatory.
callback_load_valueThe callback function to set the initial value of the widget.
callback_save_valueThe 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_changeWhen the value of the widget changes this callback is called.
initial_fire
Returns
Pointer to the created widget.

Definition at line 129 of file modal_dialog.cpp.

References fields_.

Referenced by gui2::dialogs::game_delete::game_delete(), gui2::dialogs::mp_host_game_prompt::mp_host_game_prompt(), and set_show_even_without_video().

◆ register_bool() [2/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
idId of the widget, same value as in WML.
mandatoryIs the widget mandatory or mandatory.
linked_variableThe variable the widget is linked to. See field::field for more information.
callback_changeWhen the value of the widget changes this callback is called.
initial_fire
Returns
Pointer to the created widget.

Definition at line 149 of file modal_dialog.cpp.

References fields_.

◆ 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
argsArguments to forward to the field constructor.

Definition at line 120 of file modal_dialog.cpp.

References fields_.

Referenced by set_show_even_without_video().

◆ 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 334 of file modal_dialog.hpp.

References 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 162 of file modal_dialog.cpp.

References fields_.

Referenced by gui2::dialogs::editor_edit_label::register_color_component(), and set_show_even_without_video().

◆ 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 175 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
idId of the widget, same value as in WML.
mandatoryIs the widget mandatory or optional.
textThe text for the label.
use_markupWhether or not use markup for the label.

Definition at line 218 of file modal_dialog.cpp.

References fields_.

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

◆ 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 185 of file modal_dialog.cpp.

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

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

◆ 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 203 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 197 of file modal_dialog.hpp.

References allow_plugin_skip_.

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

◆ set_always_save_fields()

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

Definition at line 192 of file modal_dialog.hpp.

References always_save_fields_.

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

◆ set_show_even_without_video()

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

◆ show()

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

Shows the window.

Parameters
auto_close_timeThe 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 65 of file modal_dialog.cpp.

References allow_plugin_skip_, always_save_fields_, plugins_manager::any_running(), DBG_DP, DOUBLE_CLICK_EVENT, 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(), retval_, plugins_context::set_callback(), gui2::window::show(), and show_even_without_video_.

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(), events::menu_handler::current_unit(), quit_confirmation::default_prompt(), gui2::dialogs::story_viewer::display(), events::console_handler::do_choose_level(), do_gameloop(), gui2::dialogs::migrate_version_selection::execute(), gui2::dialogs::game_load::execute(), editor::context_manager::generate_map_dialog(), editor::context_manager::load_map_dialog(), manage_addons(), wb::manager::options_dlg(), gui2::dialogs::mp_create_game::post_show(), turn_info::process_network_data(), events::menu_handler::recall(), events::menu_handler::recruit(), 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(), events::mouse_handler::show_attack_dialog(), savegame::loadgame::show_difficulty_dialog(), gui2::dialogs::mp_join_game::show_flg_select(), hotkey::command_executor::show_menu(), lua_gui2::show_menu(), gui2::show_message(), savegame::savegame::show_save_dialog(), savegame::oos_savegame::show_save_dialog(), preferences::show_theme_dialog(), gui2::show_transient_message(), gui2::menu_button::signal_handler_left_button_click(), gui2::multimenu_button::signal_handler_left_button_click(), editor::mouse_action_map_label::up_left(), 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.

Implemented in gui2::dialogs::file_dialog, gui2::dialogs::wml_message_double, gui2::dialogs::wml_message_right, gui2::dialogs::message, gui2::dialogs::wml_message_left, gui2::dialogs::mp_lobby, gui2::dialogs::editor_resize_map, gui2::dialogs::loading_screen, gui2::dialogs::drop_down_menu, gui2::dialogs::simple_item_selector, gui2::dialogs::campaign_selection, gui2::dialogs::title_screen, gui2::dialogs::unit_create, gui2::dialogs::addon_manager, gui2::dialogs::network_transmission, gui2::dialogs::game_version, gui2::dialogs::preferences_dialog, gui2::dialogs::game_cache_options, gui2::dialogs::wml_error, gui2::dialogs::sp_options_configure, gui2::dialogs::campaign_difficulty, gui2::dialogs::game_save_oos, gui2::dialogs::editor_edit_label, gui2::dialogs::edit_text, gui2::dialogs::game_stats, gui2::dialogs::unit_recall, gui2::dialogs::screenshot_notification, gui2::dialogs::depcheck_select_new, gui2::dialogs::folder_create, gui2::dialogs::theme_list, gui2::dialogs::custom_tod, gui2::dialogs::mp_method_selection, gui2::dialogs::addon_uninstall_list, gui2::dialogs::editor_generate_map, gui2::dialogs::game_load, gui2::dialogs::core_selection, gui2::dialogs::editor_edit_side, gui2::dialogs::editor_new_map, gui2::dialogs::unit_attack, gui2::dialogs::edit_label, gui2::dialogs::unit_list, gui2::dialogs::depcheck_confirm_change, gui2::dialogs::formula_debugger, gui2::dialogs::select_orb_colors, gui2::dialogs::addon_connect, gui2::dialogs::mp_connect, gui2::dialogs::game_save_message, gui2::dialogs::gamestate_inspector, gui2::dialogs::mp_join_game_password_prompt, gui2::dialogs::mp_staging, gui2::dialogs::story_viewer, gui2::dialogs::editor_edit_scenario, gui2::dialogs::mp_alerts_options, gui2::dialogs::mp_create_game, gui2::dialogs::log_settings, gui2::dialogs::mp_change_control, gui2::dialogs::lobby_player_info, gui2::dialogs::faction_select, gui2::dialogs::mp_login, gui2::dialogs::language_selection, gui2::dialogs::outro, gui2::dialogs::hotkey_bind, gui2::dialogs::mp_join_game, gui2::dialogs::server_info, gui2::dialogs::attack_predictions, gui2::dialogs::end_credits, gui2::dialogs::lua_interpreter, gui2::dialogs::mp_match_history, gui2::dialogs::mp_report, gui2::dialogs::chat_log, gui2::dialogs::generator_settings, gui2::dialogs::mp_host_game_prompt, gui2::dialogs::transient_message, gui2::dialogs::unit_recruit, gui2::dialogs::game_delete, gui2::dialogs::game_save, gui2::dialogs::label_settings, gui2::dialogs::addon_auth, gui2::dialogs::synched_choice_wait, gui2::dialogs::help_browser, gui2::dialogs::surrender_quit, gui2::dialogs::terrain_layers, gui2::dialogs::addon_license_prompt, gui2::dialogs::statistics_dialog, gui2::dialogs::install_dependencies, gui2::dialogs::migrate_version_selection, and gui2::dialogs::unit_advance.

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

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 163 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 384 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 362 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 371 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 376 of file modal_dialog.hpp.

Referenced by init_fields(), and register_text().

◆ retval_

int gui2::dialogs::modal_dialog::retval_
private

The window's exit code (return value).

We keep a copy here so it may be accessed even after the dialog is closed and the window object is destroyed.

This value is initially set to 0 (retval::NONE) meaning the dialog was not shown. After show returns, it will hold the most recent retval of the window object, including any modifications made in post_show.

Definition at line 352 of file modal_dialog.hpp.

Referenced by get_retval(), and show().

◆ 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 391 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: