The Battle for Wesnoth  1.15.12+dev
Public Member Functions | Private Member Functions | List of all members
gui2::dialogs::mp_alerts_options Class Reference

A Preferences subdialog permitting to configure the sounds and notifications generated in response to various mp lobby / game events. More...

#include <mp_alerts_options.hpp>

Inheritance diagram for gui2::dialogs::mp_alerts_options:

Public Member Functions

 mp_alerts_options ()
 Constructor. More...
 
- 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...
 
windowget_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 display function. More...
 
virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::dialogs::modal_dialog
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 Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< windowwindow_
 The window object build for this dialog. More...
 

Detailed Description

A Preferences subdialog permitting to configure the sounds and notifications generated in response to various mp lobby / game events.

Key Type MandatoryDescription
_label label yes Item name.
_sound toggle_button yes Toggles whether to play the item sound.
_notif toggle_button yes Toggles whether to give a notification.
_lobby toggle_button yes Toggles whether to take actions for this item when in the lobby.

Definition at line 33 of file mp_alerts_options.hpp.

Constructor & Destructor Documentation

◆ mp_alerts_options()

gui2::dialogs::mp_alerts_options::mp_alerts_options ( )

Constructor.

Definition at line 92 of file mp_alerts_options.cpp.

Member Function Documentation

◆ post_show()

void gui2::dialogs::mp_alerts_options::post_show ( window window)
overrideprivatevirtual

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 from gui2::dialogs::modal_dialog.

Definition at line 125 of file mp_alerts_options.cpp.

◆ pre_show()

void gui2::dialogs::mp_alerts_options::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
windowThe window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 96 of file mp_alerts_options.cpp.

References _(), desktop::notifications::available(), gui2::event::connect_signal_mouse_left_click(), i, gui2::widget::invisible, mp_ui_alerts::items, gui2::dialogs::revert_to_default_pref_values(), gui2::styled_widget::set_tooltip(), gui2::widget::set_visible(), and gui2::dialogs::setup_item().

◆ window_id()

virtual const std::string& gui2::dialogs::mp_alerts_options::window_id ( ) const
overrideprivatevirtual

The display function.

See modal_dialog for more information.

Implements gui2::dialogs::modal_dialog.


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