stk-code_catmod/src/guiengine/modaldialog.hpp
2014-04-23 19:03:23 -04:00

146 lines
4.7 KiB
C++

// SuperTuxKart - a fun racing game with go-kart
// Copyright (C) 2009-2013 Marianne Gagnon
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 3
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#ifndef HEADER_MODAL_DIALOG_HPP
#define HEADER_MODAL_DIALOG_HPP
#include <IGUIWindow.h>
#include "utils/ptr_vector.hpp"
#include "guiengine/abstract_top_level_container.hpp"
//#include "guiengine/event_handler.hpp"
//#include "guiengine/layout_manager.hpp"
#include "guiengine/skin.hpp"
#include "input/input_manager.hpp"
#include "utils/leak_check.hpp"
//class PlayerProfile;
/**
* \ingroup guiengine
*/
namespace GUIEngine
{
class Widget;
class TextBoxWidget;
class ButtonWidget;
enum ModalDialogLocation
{
MODAL_DIALOG_LOCATION_CENTER = 0,
MODAL_DIALOG_LOCATION_BOTTOM = 1
};
/**
* \brief Abstract base class representing a modal dialog.
* Only once instance at a time (if you create a 2nd the first will be destroyed).
* You can call static function 'dismiss' to simply close current dialog (so you don't
* need to keep track of instances yourself)
* \ingroup guiengine
*/
class ModalDialog : public SkinWidgetContainer, public AbstractTopLevelContainer
{
private:
ModalDialogLocation m_dialog_location;
float m_percent_width, m_percent_height;
bool m_init;
protected:
irr::gui::IGUIWindow* m_irrlicht_window;
irr::core::rect< irr::s32 > m_area;
bool m_fade_background;
InputManager::InputDriverMode m_previous_mode;
/**
* \brief Creates a modal dialog with given percentage of screen width and height
*/
ModalDialog(const float percentWidth, const float percentHeight,
ModalDialogLocation location = MODAL_DIALOG_LOCATION_CENTER);
/** \brief Load a XML file to create the dialog from
* \note This method automatically calls Widget::add() on each widget
*/
void loadFromFile(const char* xmlFile);
virtual void onEnterPressedInternal();
void clearWindow();
/** \brief Callback invoked when the dialog was loaded from the XML file (if the constructor
* that takes a XML file as argument is used)
*/
virtual void loadedFromFile() {}
void doInit();
public:
LEAK_CHECK()
/** Because C++ doesn't support constructor delegation... */
bool isInited() {return m_init;}
virtual ~ModalDialog();
/** Returns whether to block event propagation (usually, you will want to block events you processed) */
virtual EventPropagation processEvent(const std::string& eventSource){ return EVENT_LET; }
irr::gui::IGUIWindow* getIrrlichtElement()
{
return m_irrlicht_window;
}
static void dismiss();
static void onEnterPressed();
static ModalDialog* getCurrent();
static bool isADialogActive();
/** Override to change what happens on escape pressed */
virtual bool onEscapePressed() { return true; }
/** Override to be notified of updates */
virtual void onUpdate(float dt) { }
/**
* \brief Optional callback invoked very early, before widgets have been added (contrast with
* init(), which is invoked afer widgets were added)
*/
virtual void beforeAddingWidgets() {}
virtual void load() {}
/** \brief Optional callback invoked after widgets have been add()ed */
virtual void init() {}
/**
* \brief Implementing callback from AbstractTopLevelContainer
*/
virtual int getWidth() { return m_area.getWidth(); }
/**
* \brief Implementing callback from AbstractTopLevelContainer
*/
virtual int getHeight() { return m_area.getHeight(); }
bool fadeBackground() const { return m_fade_background; }
bool isMyIrrChild(irr::gui::IGUIElement* widget) const { return m_irrlicht_window->isMyChild(widget); }
};
}
#endif