src/gui/menu.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_GUI_MENU_HPP
  18 #define HEADER_SUPERTUX_GUI_MENU_HPP
  19
  20 #include <list>
  21 #include <memory>
  22 #include <SDL.h>
  23
  24 #include "gui/mousecursor.hpp"
  25 #include "video/font.hpp"
  26
  27 bool confirm_dialog(Surface* background, std::string text);
  28
  29 /* Kinds of menu items */
  30 enum MenuItemKind {
  31   MN_ACTION,
  32   MN_GOTO,
  33   MN_TOGGLE,
  34   MN_BACK,
  35   MN_INACTIVE,
  36   MN_TEXTFIELD,
  37   MN_NUMFIELD,
  38   MN_CONTROLFIELD,
  39   MN_STRINGSELECT,
  40   MN_LABEL,
  41   MN_HL /* horizontal line */
  42 };
  43
  44 class Menu;
  45
  46 class MenuItem
  47 {
  48 public:
  49   MenuItem(MenuItemKind kind, int id = -1);
  50   MenuItemKind kind;
  51   int id;   // item id
  52   bool toggled;
  53   std::string text;
  54   std::string input;
  55   std::string help;
  56
  57   std::vector<std::string> list; // list of values for a STRINGSELECT item
  58   size_t selected; // currently selected item
  59
  60   Menu* target_menu;
  61
  62   void set_help(const std::string& help_text);
  63
  64   void change_text (const std::string& text);
  65   void change_input(const std::string& text);
  66
  67   static MenuItem* create(MenuItemKind kind, const std::string& text,
  68                           int init_toggle, Menu* target_menu, int id, int key);
  69
  70   std::string get_input_with_symbol(bool active_item);   // returns the text with an input symbol
  71
  72 private:
  73   /// keyboard key or joystick button
  74   bool input_flickering;
  75
  76 private:
  77   MenuItem(const MenuItem&);
  78   MenuItem& operator=(const MenuItem&);
  79 };
  80
  81 class Menu
  82 {
  83   static Color default_color;
  84   static Color active_color;
  85   static Color inactive_color;
  86   static Color label_color;
  87   static Color field_color;
  88 private:
  89   static std::vector<Menu*> last_menus;
  90
  91   /** Pointers to all currently available menus, used to handle repositioning on window resize */
  92   static std::list<Menu*>   all_menus;
  93
  94   static Menu* previous;
  95   static Menu* current_;
  96
  97 public:
  98   /** Set the current menu, if pmenu is NULL, hide the current menu */
  99   static void set_current(Menu* pmenu);
 100
 101   static void push_current(Menu* pmenu);
 102   static void pop_current();
 103
 104   static void recalc_pos();
 105
 106   /** Return the current active menu or NULL if none is active */
 107   static Menu* current()
 108   {
 109     return current_;
 110   }
 111
 112 private:
 113   /* Action done on the menu */
 114   enum MenuAction {
 115     MENU_ACTION_NONE = -1,
 116     MENU_ACTION_UP,
 117     MENU_ACTION_DOWN,
 118     MENU_ACTION_LEFT,
 119     MENU_ACTION_RIGHT,
 120     MENU_ACTION_HIT,
 121     MENU_ACTION_INPUT,
 122     MENU_ACTION_REMOVE,
 123     MENU_ACTION_BACK
 124   };
 125
 126   /** Number of the item that got 'hit' (ie. pressed) in the last
 127       event()/update() call, -1 if none */
 128   int hit_item;
 129
 130   // position of the menu (ie. center of the menu, not top/left)
 131   float pos_x;
 132   float pos_y;
 133
 134   /** input event for the menu (up, down, left, right, etc.) */
 135   MenuAction menuaction;
 136
 137   /* input implementation variables */
 138   int   delete_character;
 139   char  mn_input_char;
 140   float menu_repeat_time;
 141
 142   bool close;
 143
 144 public:
 145   std::vector<MenuItem*> items;
 146
 147   Menu();
 148   virtual ~Menu();
 149
 150   MenuItem* add_hl();
 151   MenuItem* add_label(const std::string& text);
 152   MenuItem* add_entry(int id, const std::string& text);
 153   MenuItem* add_toggle(int id, const std::string& text, bool toggled = false);
 154   MenuItem* add_inactive(int id, const std::string& text);
 155   MenuItem* add_back(const std::string& text);
 156   MenuItem* add_submenu(const std::string& text, Menu* submenu, int id = -1);
 157   MenuItem* add_controlfield(int id, const std::string& text,
 158                              const std::string& mapping = "");
 159   MenuItem* add_string_select(int id, const std::string& text);
 160
 161   virtual void menu_action(MenuItem* item);
 162
 163   void update();
 164
 165   /** Remove all entries from the menu */
 166   void clear();
 167
 168   /** Return the index of the menu item that was 'hit' (ie. the user
 169       clicked on it) in the last event() call */
 170   int check ();
 171
 172   MenuItem& get_item(int index)
 173   {
 174     return *(items[index]);
 175   }
 176   MenuItem& get_item_by_id(int id);
 177   const MenuItem& get_item_by_id(int id) const;
 178
 179   int get_active_item_id();
 180   void set_active_item(int id);
 181
 182   void draw(DrawingContext& context);
 183   void set_pos(float x, float y, float rw = 0, float rh = 0);
 184
 185   void event(const SDL_Event& event);
 186
 187   bool is_toggled(int id) const;
 188   void set_toggled(int id, bool toggled);
 189
 190   Menu* get_parent() const;
 191
 192 protected:
 193   void additem(MenuItem* pmenu_item);
 194   float get_width() const;
 195   float get_height() const;
 196
 197 private:
 198   void check_controlfield_change_event(const SDL_Event& event);
 199   void draw_item(DrawingContext& context, int index);
 200   float effect_progress;
 201   float effect_start_time;
 202   int arrange_left;
 203   int active_item;
 204
 205   std::auto_ptr<Surface> checkbox;
 206   std::auto_ptr<Surface> checkbox_checked;
 207   std::auto_ptr<Surface> back;
 208   std::auto_ptr<Surface> arrow_left;
 209   std::auto_ptr<Surface> arrow_right;
 210 };
 211
 212 #endif
 213
 214 /* EOF */