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 "math/vector.hpp"
  25 #include "video/color.hpp"
  26 #include "video/surface_ptr.hpp"
  27
  28 class DrawingContext;
  29 class MenuItem;
  30
  31 class Menu
  32 {
  33   static Color default_color;
  34   static Color active_color;
  35   static Color inactive_color;
  36   static Color label_color;
  37   static Color field_color;
  38
  39 private:
  40   /* Action done on the menu */
  41   enum MenuAction {
  42     MENU_ACTION_NONE = -1,
  43     MENU_ACTION_UP,
  44     MENU_ACTION_DOWN,
  45     MENU_ACTION_LEFT,
  46     MENU_ACTION_RIGHT,
  47     MENU_ACTION_HIT,
  48     MENU_ACTION_INPUT,
  49     MENU_ACTION_REMOVE,
  50     MENU_ACTION_BACK
  51   };
  52
  53 public:
  54   Menu();
  55   virtual ~Menu();
  56
  57   MenuItem* add_hl();
  58   MenuItem* add_label(const std::string& text);
  59   MenuItem* add_entry(int id, const std::string& text);
  60   MenuItem* add_toggle(int id, const std::string& text, bool toggled = false);
  61   MenuItem* add_inactive(int id, const std::string& text);
  62   MenuItem* add_back(const std::string& text);
  63   MenuItem* add_submenu(const std::string& text, int submenu);
  64   MenuItem* add_controlfield(int id, const std::string& text,
  65                              const std::string& mapping = "");
  66   MenuItem* add_string_select(int id, const std::string& text);
  67
  68   virtual void menu_action(MenuItem* item) = 0;
  69
  70   void process_input();
  71
  72   /** Perform actions to bring the menu up to date with configuration changes */
  73   virtual void refresh() {}
  74
  75   /** Remove all entries from the menu */
  76   void clear();
  77
  78   MenuItem& get_item(int index)
  79   {
  80     return *(items[index]);
  81   }
  82
  83   MenuItem& get_item_by_id(int id);
  84   const MenuItem& get_item_by_id(int id) const;
  85
  86   int get_active_item_id();
  87   void set_active_item(int id);
  88
  89   void draw(DrawingContext& context);
  90   Vector get_center_pos() const { return pos; }
  91   void set_center_pos(float x, float y);
  92
  93   void event(const SDL_Event& event);
  94
  95   bool is_toggled(int id) const;
  96   void set_toggled(int id, bool toggled);
  97
  98   float get_width() const;
  99   float get_height() const;
 100
 101   virtual void on_window_resize();
 102
 103 protected:
 104   MenuItem* add_item(std::unique_ptr<MenuItem> menu_item);
 105
 106 private:
 107   void process_action(MenuAction menuaction);
 108   void check_controlfield_change_event(const SDL_Event& event);
 109   void draw_item(DrawingContext& context, int index);
 110
 111 private:
 112   // position of the menu (ie. center of the menu, not top/left)
 113   Vector pos;
 114
 115   /* input implementation variables */
 116   int   delete_character;
 117   char  mn_input_char;
 118   float menu_repeat_time;
 119
 120 public:
 121   std::vector<std::unique_ptr<MenuItem> > items;
 122
 123 private:
 124   int arrange_left;
 125   int active_item;
 126 };
 127
 128 #endif
 129
 130 /* EOF */