The Battle for Wesnoth  1.17.0-dev
theme_list.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014 - 2021
3  by Iris Morelle <shadowm2006@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 struct theme_info;
21 
22 namespace gui2::dialogs
23 {
24 
25 /**
26  * @ingroup GUIWindowDefinitionWML
27  *
28  * Dialog for selecting a GUI theme.
29  * Key |Type |Mandatory|Description
30  * ------------------|--------------|---------|-----------
31  * themes | @ref listbox |yes |Listbox displaying user choices.
32  * name | control |yes |Widget which shows a theme item name.
33  * description | control |yes |Widget which shows a theme item description.
34  */
35 class theme_list : public modal_dialog
36 {
37 public:
38  explicit theme_list(const std::vector<theme_info>& themes,
39  int selection = -1);
40 
41  /**
42  * Returns the selected item index after displaying.
43  * @return -1 if the dialog was canceled.
44  */
45  int selected_index() const
46  {
47  return index_;
48  }
49 
50  /** Sets the initially selected item index (-1 by default). */
52  {
53  index_ = index;
54  }
55 
56 private:
57  int index_;
58 
59  std::vector<theme_info> themes_;
60 
61  virtual const std::string& window_id() const override;
62 
63  virtual void pre_show(window& window) override;
64 
65  virtual void post_show(window& window) override;
66 };
67 } // namespace dialogs
Dialog for selecting a GUI theme.
Definition: theme_list.hpp:35
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
Definition: theme_list.cpp:64
std::vector< theme_info > themes_
Definition: theme_list.hpp:59
void set_selected_index(int index)
Sets the initially selected item index (-1 by default).
Definition: theme_list.hpp:51
int selected_index() const
Returns the selected item index after displaying.
Definition: theme_list.hpp:45
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: theme_list.cpp:34
std::size_t index(const std::string &str, const std::size_t index)
Codepoint index corresponding to the nth character in a UTF-8 string.
Definition: unicode.cpp:72
Abstract base class for all modal dialogs.
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65
virtual const std::string & window_id() const override
The id of the window to build.
theme_list(const std::vector< theme_info > &themes, int selection=-1)
Definition: theme_list.cpp:29