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 bool confirm_dialog(Surface* background, std::string text);
  32
  33 class Menu
  34 {
  35   static Color default_color;
  36   static Color active_color;
  37   static Color inactive_color;
  38   static Color label_color;
  39   static Color field_color;
  40
  41 private:
  42   /* Action done on the menu */
  43   enum MenuAction {
  44     MENU_ACTION_NONE = -1,
  45     MENU_ACTION_UP,
  46     MENU_ACTION_DOWN,
  47     MENU_ACTION_LEFT,
  48     MENU_ACTION_RIGHT,
  49     MENU_ACTION_HIT,
  50     MENU_ACTION_INPUT,
  51     MENU_ACTION_REMOVE,
  52     MENU_ACTION_BACK
  53   };
  54
  55 public:
  56   Menu();
  57   virtual ~Menu();
  58
  59   MenuItem* add_hl();
  60   MenuItem* add_label(const std::string& text);
  61   MenuItem* add_entry(int id, const std::string& text);
  62   MenuItem* add_toggle(int id, const std::string& text, bool toggled = false);
  63   MenuItem* add_inactive(int id, const std::string& text);
  64   MenuItem* add_back(const std::string& text);
  65   MenuItem* add_submenu(const std::string& text, int submenu, int id = -1);
  66   MenuItem* add_controlfield(int id, const std::string& text,
  67                              const std::string& mapping = "");
  68   MenuItem* add_string_select(int id, const std::string& text);
  69
  70   virtual void menu_action(MenuItem* item);
  71
  72   void update();
  73
  74   /** Remove all entries from the menu */
  75   void clear();
  76
  77   virtual void check_menu() =0;
  78
  79   MenuItem& get_item(int index)
  80   {
  81     return *(items[index]);
  82   }
  83
  84   MenuItem& get_item_by_id(int id);
  85   const MenuItem& get_item_by_id(int id) const;
  86
  87   int get_active_item_id();
  88   void set_active_item(int id);
  89
  90   void draw(DrawingContext& context);
  91   void set_pos(float x, float y, float rw = 0, float rh = 0);
  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 protected:
  99   /** Return the index of the menu item that was 'hit' (ie. the user
 100       clicked on it) in the last event() call */
 101   int check ();
 102
 103   MenuItem* add_item(std::unique_ptr<MenuItem> menu_item);
 104   float get_width() const;
 105   float get_height() const;
 106
 107 private:
 108   void check_controlfield_change_event(const SDL_Event& event);
 109   void draw_item(DrawingContext& context, int index);
 110
 111 private:
 112   /** Number of the item that got 'hit' (ie. pressed) in the last
 113       event()/update() call, -1 if none */
 114   int hit_item;
 115
 116   // position of the menu (ie. center of the menu, not top/left)
 117   Vector pos;
 118
 119   /** input event for the menu (up, down, left, right, etc.) */
 120   MenuAction menuaction;
 121
 122   /* input implementation variables */
 123   int   delete_character;
 124   char  mn_input_char;
 125   float menu_repeat_time;
 126
 127 public:
 128   bool close;
 129
 130   std::vector<std::unique_ptr<MenuItem> > items;
 131
 132 public:
 133   float effect_progress;
 134   float effect_start_time;
 135
 136 private:
 137   int arrange_left;
 138   int active_item;
 139 };
 140
 141 #endif
 142
 143 /* EOF */