src/modalMenu.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef MODALMENU_HEADER
  21 #define MODALMENU_HEADER
  22
  23 #include "irrlichttypes_extrabloated.h"
  24 #ifdef HAVE_TOUCHSCREENGUI
  25 #include "touchscreengui.h"
  26 #endif
  27
  28 class GUIModalMenu;
  29
  30 class IMenuManager
  31 {
  32 public:
  33         // A GUIModalMenu calls these when this class is passed as a parameter
  34         virtual void createdMenu(gui::IGUIElement *menu) = 0;
  35         virtual void deletingMenu(gui::IGUIElement *menu) = 0;
  36 };
  37
  38 /*
  39         Remember to drop() the menu after creating, so that it can
  40         remove itself when it wants to.
  41 */
  42
  43 class GUIModalMenu : public gui::IGUIElement
  44 {
  45 public:
  46         GUIModalMenu(gui::IGUIEnvironment* env,
  47                         gui::IGUIElement* parent, s32 id,
  48                         IMenuManager *menumgr):
  49                 IGUIElement(gui::EGUIET_ELEMENT, env, parent, id,
  50                                 core::rect<s32>(0,0,100,100))
  51         {
  52                 //m_force_regenerate_gui = false;
  53
  54                 m_menumgr = menumgr;
  55                 m_allow_focus_removal = false;
  56                 m_screensize_old = v2u32(0,0);
  57
  58                 setVisible(true);
  59                 Environment->setFocus(this);
  60                 m_menumgr->createdMenu(this);
  61         }
  62         virtual ~GUIModalMenu()
  63         {
  64                 m_menumgr->deletingMenu(this);
  65         }
  66
  67         void allowFocusRemoval(bool allow)
  68         {
  69                 m_allow_focus_removal = allow;
  70         }
  71
  72         bool canTakeFocus(gui::IGUIElement *e)
  73         {
  74                 return (e && (e == this || isMyChild(e))) || m_allow_focus_removal;
  75         }
  76
  77         void draw()
  78         {
  79                 if(!IsVisible)
  80                         return;
  81
  82                 video::IVideoDriver* driver = Environment->getVideoDriver();
  83                 v2u32 screensize = driver->getScreenSize();
  84                 if(screensize != m_screensize_old /*|| m_force_regenerate_gui*/)
  85                 {
  86                         m_screensize_old = screensize;
  87                         regenerateGui(screensize);
  88                         //m_force_regenerate_gui = false;
  89                 }
  90
  91                 drawMenu();
  92         }
  93
  94         /*
  95                 This should be called when the menu wants to quit.
  96
  97                 WARNING: THIS DEALLOCATES THE MENU FROM MEMORY. Return
  98                 immediately if you call this from the menu itself.
  99
 100                 (More precisely, this decrements the reference count.)
 101         */
 102         void quitMenu()
 103         {
 104                 allowFocusRemoval(true);
 105                 // This removes Environment's grab on us
 106                 Environment->removeFocus(this);
 107                 m_menumgr->deletingMenu(this);
 108                 this->remove();
 109 #ifdef HAVE_TOUCHSCREENGUI
 110                 if (g_touchscreengui)
 111                         g_touchscreengui->show();
 112 #endif
 113         }
 114
 115         void removeChildren()
 116         {
 117                 const core::list<gui::IGUIElement*> &children = getChildren();
 118                 core::list<gui::IGUIElement*> children_copy;
 119                 for(core::list<gui::IGUIElement*>::ConstIterator
 120                                 i = children.begin(); i != children.end(); i++)
 121                 {
 122                         children_copy.push_back(*i);
 123                 }
 124                 for(core::list<gui::IGUIElement*>::Iterator
 125                                 i = children_copy.begin();
 126                                 i != children_copy.end(); i++)
 127                 {
 128                         (*i)->remove();
 129                 }
 130         }
 131
 132         virtual void regenerateGui(v2u32 screensize) = 0;
 133         virtual void drawMenu() = 0;
 134         virtual bool preprocessEvent(const SEvent& event) { return false; };
 135         virtual bool OnEvent(const SEvent& event) { return false; };
 136         virtual bool pausesGame(){ return false; } // Used for pause menu
 137
 138 protected:
 139         //bool m_force_regenerate_gui;
 140         v2u32 m_screensize_old;
 141 private:
 142         IMenuManager *m_menumgr;
 143         // This might be necessary to expose to the implementation if it
 144         // wants to launch other menus
 145         bool m_allow_focus_removal;
 146 };
 147
 148
 149 #endif
 150