1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*
* Copyright (C) 2002-2025 by the Widelands Development Team
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*
*/
#ifndef WL_UI_FSMENU_MENU_H
#define WL_UI_FSMENU_MENU_H
#include "ui_basic/box.h"
#include "ui_basic/button.h"
#include "ui_basic/window.h"
namespace FsMenu {
class MainMenu;
class MenuCapsule;
constexpr int kPadding = 4;
constexpr double kDefaultColumnWidthFactor = 1.0 / 3;
/**
* Base for a menu. Takes care of padding. Use this to freely implement your own layout by adding
* your content into header_box and main_box
*/
class BaseMenu : public UI::Panel {
public:
BaseMenu(MenuCapsule&, const std::string& title);
MenuCapsule& get_capsule() {
return capsule_;
}
virtual void reactivated() {
}
private:
UI::Box horizontal_padding_box_, vertical_padding_box_;
protected:
void layout() override;
// Hides the parent window, deleting this panel immediately.
// The main menu's Continue buttons are updated in case a new savegame or map was created.
void return_to_main_menu();
UI::Box main_box_, header_box_;
uint32_t standard_height_;
MenuCapsule& capsule_;
};
/**
* A Menu which provides a two column layout below the header_box_. Add your content to
* TwoColumnsMenu::left_column_box_ and TwoColumnsMenu::right_column_box_
*/
class TwoColumnsMenu : public BaseMenu {
public:
TwoColumnsMenu(MenuCapsule&,
const std::string& title,
double right_column_width_factor = kDefaultColumnWidthFactor);
protected:
void layout() override;
UI::Box content_box_, left_column_box_, right_column_box_;
int right_column_width_;
private:
/// right column width = get_w * factor. rest goes to left column (minus some padding)
double right_column_width_factor_;
};
/**
* A two column menu which provides a "Back"-button at the bottom of the right column. Add your
* content to TwoColumnsBasicNavigationMenu::left_column_box_ and
* TwoColumnsBasicNavigationMenu::right_column_content_box_
*/
class TwoColumnsBasicNavigationMenu : public TwoColumnsMenu {
public:
TwoColumnsBasicNavigationMenu(MenuCapsule&,
const std::string& title,
double right_column_width_factor = kDefaultColumnWidthFactor);
protected:
void layout() override;
virtual void clicked_back();
/// Handle keypresses
bool handle_key(bool down, SDL_Keysym code) override;
UI::Box right_column_content_box_, button_box_;
UI::Button back_;
};
/**
* A two column menu which provides a "Back"-button and a "Ok"-button at the bottom of the right
* column. Add your content to TwoColumnsFullNavigationMenu::left_column_box_ and
* TwoColumnsFullNavigationMenu::right_column_content_box_
*/
class TwoColumnsFullNavigationMenu : public TwoColumnsBasicNavigationMenu {
public:
TwoColumnsFullNavigationMenu(MenuCapsule&,
const std::string& title,
double right_column_width_factor = kDefaultColumnWidthFactor);
~TwoColumnsFullNavigationMenu() override;
protected:
void layout() override;
virtual void clicked_ok() = 0;
/// Handle keypresses
bool handle_key(bool down, SDL_Keysym code) override;
UI::Button ok_;
};
/**
* Singleton class owned by the MainMenu. A MenuCapsule can hold one or more BaseMenus which
* are stacked on top of each other so that only the top of the stack is visible to the user.
*/
class MenuCapsule : public UI::Window {
public:
explicit MenuCapsule(MainMenu&);
~MenuCapsule() override = default;
UI::Window::WindowLayoutID window_layout_id() const override {
return UI::Window::WindowLayoutID::kFsMenuDefault;
}
MainMenu& menu() const {
return fsmm_;
}
// Remove and free all panels
void clear_content();
void layout() override;
void think() override;
void die() override;
void on_death(UI::Panel*) override;
bool handle_key(bool down, SDL_Keysym) override;
void draw(RenderTarget&) override;
// Should be called only by BaseMenu ctor
void add(BaseMenu&, const std::string& title);
private:
struct Entry {
std::string title;
BaseMenu* panel;
UI::Button* button;
UI::Panel* icon;
UI::Panel* spacer1;
UI::Panel* spacer2;
void cleanup(bool all);
};
UI::Box box_;
std::vector<Entry> visible_menus_;
MainMenu& fsmm_;
bool should_die_{false};
};
} // namespace FsMenu
#endif // end of include guard: WL_UI_FSMENU_MENU_H
|