4 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License
8 // as published by the Free Software Foundation; either version 2
9 // of the License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 #ifndef SUPERTUX_MENU_H
21 #define SUPERTUX_MENU_H
33 #include "video/surface.hpp"
34 #include "video/font.hpp"
35 #include "mousecursor.hpp"
37 bool confirm_dialog(Surface* background, std::string text);
39 /* Kinds of menu items */
51 MN_HL, /* horizontal line */
59 MenuItem(MenuItemKind kind, int id = -1);
67 std::vector<std::string> list; // list of values for a STRINGSELECT item
68 size_t selected; // currently selected item
72 void set_help(const std::string& help_text);
74 void change_text (const std::string& text);
75 void change_input(const std::string& text);
77 static MenuItem* create(MenuItemKind kind, const std::string& text,
78 int init_toggle, Menu* target_menu, int id, int key);
80 std::string get_input_with_symbol(bool active_item); // returns the text with an input symbol
83 /// copy-construction not allowed
84 MenuItem(const MenuItem& ) { assert(false); }
85 /// assignment not allowed
86 void operator= (const MenuItem& ) { assert(false); }
88 /// keyboard key or joystick button
89 bool input_flickering;
95 static std::vector<Menu*> last_menus;
97 /** Pointers to all currently available menus, used to handle repositioning on window resize */
98 static std::list<Menu*> all_menus;
100 static Menu* previous;
101 static Menu* current_;
103 static void pop_current();
106 /** Set the current menu, if pmenu is NULL, hide the current menu */
107 static void set_current(Menu* pmenu);
109 static void push_current(Menu* pmenu);
111 static void recalc_pos();
113 /** Return the current active menu or NULL if none is active */
114 static Menu* current()
120 /* Action done on the menu */
122 MENU_ACTION_NONE = -1,
133 /** Number of the item that got 'hit' (ie. pressed) in the last
134 event()/update() call, -1 if none */
137 // position of the menu (ie. center of the menu, not top/left)
141 /** input event for the menu (up, down, left, right, etc.) */
142 MenuAction menuaction;
144 /* input implementation variables */
145 int delete_character;
147 float menu_repeat_time;
150 static Font* default_font;
151 static Font* active_font;
152 static Font* inactive_font;
153 static Font* label_font;
154 static Font* field_font;
156 std::vector<MenuItem*> items;
162 MenuItem* add_label(const std::string& text);
163 MenuItem* add_entry(int id, const std::string& text);
164 MenuItem* add_toggle(int id, const std::string& text, bool toggled = false);
165 MenuItem* add_inactive(int id, const std::string& text);
166 MenuItem* add_back(const std::string& text);
167 MenuItem* add_submenu(const std::string& text, Menu* submenu, int id = -1);
168 MenuItem* add_controlfield(int id, const std::string& text,
169 const std::string& mapping = "");
170 MenuItem* add_string_select(int id, const std::string& text);
172 virtual void menu_action(MenuItem* item);
176 /** Remove all entries from the menu */
179 /** Return the index of the menu item that was 'hit' (ie. the user
180 clicked on it) in the last event() call */
183 MenuItem& get_item(int index)
185 return *(items[index]);
187 MenuItem& get_item_by_id(int id);
188 const MenuItem& get_item_by_id(int id) const;
190 int get_active_item_id();
191 void set_active_item(int id);
193 void draw(DrawingContext& context);
194 void set_pos(float x, float y, float rw = 0, float rh = 0);
196 void event(const SDL_Event& event);
198 bool is_toggled(int id) const;
199 void set_toggled(int id, bool toggled);
201 Menu* get_parent() const;
204 void additem(MenuItem* pmenu_item);
205 float get_width() const;
206 float get_height() const;
209 void check_controlfield_change_event(const SDL_Event& event);
210 void draw_item(DrawingContext& context, int index);
211 float effect_progress;
212 float effect_start_time;
216 std::auto_ptr<Surface> checkbox;
217 std::auto_ptr<Surface> checkbox_checked;
218 std::auto_ptr<Surface> back;
219 std::auto_ptr<Surface> arrow_left;
220 std::auto_ptr<Surface> arrow_right;