The Battle for Wesnoth  1.17.0-dev
mp_alerts_options.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014 - 2021
3  by Chris Beck <render787@gmail.com>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #pragma once
17 
19 
20 namespace gui2::dialogs
21 {
22 
23 /**
24  * @ingroup GUIWindowDefinitionWML
25  *
26  * A Preferences subdialog permitting to configure the sounds and notifications generated in response to various mp lobby / game events.
27  * Key |Type |Mandatory|Description
28  * ------------------|---------------|---------|-----------
29  * _label | @ref label |yes |Item name.
30  * _sound | toggle_button |yes |Toggles whether to play the item sound.
31  * _notif | toggle_button |yes |Toggles whether to give a notification.
32  * _lobby | toggle_button |yes |Toggles whether to take actions for this item when in the lobby.
33  */
35 {
36 public:
37  /** Constructor. */
39 
40  /**
41  * The display function.
42  *
43  * See @ref modal_dialog for more information.
44  */
46 
47 private:
48  virtual const std::string& window_id() const override;
49 
50  virtual void pre_show(window& window) override;
51 
52  virtual void post_show(window& window) override;
53 };
54 
55 } // namespace dialogs
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
virtual const std::string & window_id() const override
The display function.
A Preferences subdialog permitting to configure the sounds and notifications generated in response to...
Abstract base class for all modal dialogs.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65