src/menu.h

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
   5 //
   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.
  10 //
  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.
  15 //
  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.
  19
  20 #ifndef SUPERTUX_MENU_H
  21 #define SUPERTUX_MENU_H
  22
  23 #include <SDL.h>
  24 #include <vector>
  25 #include <stack>
  26 #include "texture.h"
  27 #include "timer.h"
  28 #include "type.h"
  29 #include "mousecursor.h"
  30
  31 /* Kinds of menu items */
  32 enum MenuItemKind {
  33   MN_ACTION,
  34   MN_GOTO,
  35   MN_TOGGLE,
  36   MN_BACK,
  37   MN_DEACTIVE,
  38   MN_TEXTFIELD,
  39   MN_NUMFIELD,
  40   MN_CONTROLFIELD,
  41   MN_STRINGSELECT,
  42   MN_LABEL,
  43   MN_HL, /* horizontal line */
  44 };
  45
  46 class Menu;
  47
  48 class MenuItem
  49 {
  50 public:
  51   MenuItemKind kind;
  52   int toggled;
  53   char *text;
  54   char *input;
  55   string_list_type* list;
  56   Menu* target_menu;
  57
  58   void change_text (const char *text);
  59   void change_input(const char *text);
  60
  61   static MenuItem* create(MenuItemKind kind, const char *text, int init_toggle, Menu* target_menu);
  62 };
  63
  64 class Menu
  65 {
  66 private:
  67   static std::stack<Menu*> last_menus;
  68   static Menu* current_;
  69
  70   static void push_current(Menu* pmenu);
  71   static void pop_current();
  72 public:
  73   /** Set the current menu, if pmenu is NULL, hide the current menu */
  74   static void set_current(Menu* pmenu);
  75
  76   /** Return the current active menu or NULL if none is active */
  77   static Menu* current() { return current_; }
  78
  79 private:
  80   /* Action done on the menu */
  81   enum MenuAction {
  82     MENU_ACTION_NONE = -1,
  83     MENU_ACTION_UP,
  84     MENU_ACTION_DOWN,
  85     MENU_ACTION_LEFT,
  86     MENU_ACTION_RIGHT,
  87     MENU_ACTION_HIT,
  88     MENU_ACTION_INPUT,
  89     MENU_ACTION_REMOVE
  90   };
  91
  92   // position of the menu (ie. center of the menu, not top/left)
  93   int pos_x;
  94   int pos_y;
  95   bool has_backitem;
  96
  97   /** input event for the menu (up, down, left, right, etc.) */
  98   MenuAction menuaction;
  99
 100   /* input implementation variables */
 101   int delete_character;
 102   char mn_input_char;
 103
 104   int width();
 105   int height();
 106
 107 public:
 108   Timer effect;
 109   int arrange_left;
 110   int active_item;
 111
 112   std::vector<MenuItem> item;
 113
 114   Menu();
 115   ~Menu();
 116
 117   void additem(MenuItem* pmenu_item);
 118   void additem(MenuItemKind kind, const std::string& text, int init_toggle, Menu* target_menu);
 119   void action ();
 120
 121   /** Remove all entries from the menu */
 122   void clear();
 123
 124   /** Check, if the value of the active menu item has changed. FIXME:
 125       Somebody should document the exact meaning of this function a
 126       bit more */
 127   int  check  ();
 128
 129   void draw   ();
 130   void draw_item(int index, int menu_width, int menu_height);
 131   void set_pos(int x, int y, float rw = 0, float rh = 0);
 132
 133   /** translate a SDL_Event into a menu_action */
 134   void event(SDL_Event& event);
 135 };
 136
 137 extern Surface* checkbox;
 138 extern Surface* checkbox_checked;
 139 extern Surface* back;
 140 extern Surface* arrow_left;
 141 extern Surface* arrow_right;
 142
 143 extern Menu* contrib_menu;
 144 extern Menu* contrib_subset_menu;
 145 extern Menu* main_menu;
 146 extern Menu* game_menu;
 147 extern Menu* worldmap_menu;
 148 extern Menu* options_menu;
 149 extern Menu* options_controls_menu;
 150 extern Menu* highscore_menu;
 151 extern Menu* load_game_menu;
 152 extern Menu* save_game_menu;
 153
 154 #endif /*SUPERTUX_MENU_H*/
 155
 156 /* Local Variables: */
 157 /* mode: c++ */
 158 /* End: */