SuperTuxKart
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
GUIEngine::ModalDialog Class Reference

Abstract base class representing a modal dialog. More...

#include <modaldialog.hpp>

Inheritance diagram for GUIEngine::ModalDialog:
Inheritance graph
[legend]

Public Member Functions

bool isInited ()
 Because C++ doesn't support constructor delegation... More...
 
virtual EventPropagation processEvent (const std::string &eventSource)
 Returns whether to block event propagation (usually, you will want to block events you processed)
 
irr::gui::IGUIWindow * getIrrlichtElement ()
 
virtual bool onEscapePressed ()
 Override to change what happens on escape pressed.
 
virtual void onUpdate (float dt)
 Override to be notified of updates.
 
virtual void beforeAddingWidgets ()
 Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)
 
virtual void load ()
 
virtual void init ()
 Optional callback invoked after widgets have been add()ed.
 
virtual int getWidth ()
 Implementing callback from AbstractTopLevelContainer.
 
virtual int getHeight ()
 Implementing callback from AbstractTopLevelContainer.
 
bool fadeBackground () const
 
bool isMyIrrChild (irr::gui::IGUIElement *widget) const
 
- Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
WidgetgetWidget (const char *name)
 This function returns a widget by name if that widget is found. More...
 
WidgetgetWidget (const int id)
 This function returns a widget by irrlicht ID if that widget is found. More...
 
template<typename T >
T * getWidget (const char *name)
 This function searches and returns a widget by name, cast as specified type, if that widget is found and the type is correct. More...
 
WidgetgetFirstWidget (PtrVector< Widget > *within_vector=NULL)
 This function returns the first widget found in within_vector. More...
 
WidgetgetLastWidget (PtrVector< Widget > *within_vector=NULL)
 This function returns the last widget found in within_vector. More...
 
void elementsWereDeleted (PtrVector< Widget > *within_vector=NULL)
 This function is called when screen is removed. More...
 
bool isMyChild (Widget *widget) const
 This function checks if a widget is a child of the container. More...
 

Static Public Member Functions

static void dismiss ()
 
static void onEnterPressed ()
 
static ModalDialoggetCurrent ()
 
static bool isADialogActive ()
 
- Static Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
static WidgetgetWidget (const char *name, PtrVector< Widget > *within_vector)
 This function returns a widget by name if that widget is found in within_vector. More...
 
static WidgetgetWidget (const int id, PtrVector< Widget > *within_vector)
 This function returns a widget by irrlicht ID if that widget is found. More...
 

Protected Member Functions

 ModalDialog (const float percentWidth, const float percentHeight, ModalDialogLocation location=MODAL_DIALOG_LOCATION_CENTER)
 Creates a modal dialog with given percentage of screen width and height.
 
void loadFromFile (const char *xmlFile)
 Load a XML file to create the dialog from. More...
 
virtual void onEnterPressedInternal ()
 
void clearWindow ()
 
virtual void loadedFromFile ()
 Callback invoked when the dialog was loaded from the XML file (if the constructor that takes a XML file as argument is used)
 
void doInit ()
 
- Protected Member Functions inherited from GUIEngine::AbstractTopLevelContainer
void addWidgetsRecursively (PtrVector< Widget > &widgets, Widget *parent=NULL)
 This function adds a list of widgets recursively, effectively creating the hierarchy of widgets. More...
 

Protected Attributes

irr::gui::IGUIWindow * m_irrlicht_window
 
irr::core::rect< irr::s32 > m_area
 
bool m_fade_background
 
InputManager::InputDriverMode m_previous_mode
 
- Protected Attributes inherited from GUIEngine::AbstractTopLevelContainer
PtrVector< Widget, HOLD > m_widgets
 the widgets in this screen
 
Widgetm_first_widget
 AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g. More...
 
Widgetm_last_widget
 AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g. More...
 

Private Attributes

ModalDialogLocation m_dialog_location
 
float m_percent_width
 
float m_percent_height
 
bool m_init
 

Additional Inherited Members

- Public Attributes inherited from GUIEngine::SkinWidgetContainer
int m_skin_x
 
int m_skin_y
 
int m_skin_w
 
int m_skin_h
 
bool m_skin_dest_areas_inited
 
bool m_skin_dest_areas_yflip_inited
 
int m_skin_dest_x
 
int m_skin_dest_y
 
int m_skin_dest_x2
 
int m_skin_dest_y2
 
core::rect< s32 > m_skin_dest_area_left
 
core::rect< s32 > m_skin_dest_area_center
 
core::rect< s32 > m_skin_dest_area_right
 
core::rect< s32 > m_skin_dest_area_top
 
core::rect< s32 > m_skin_dest_area_bottom
 
core::rect< s32 > m_skin_dest_area_top_left
 
core::rect< s32 > m_skin_dest_area_top_right
 
core::rect< s32 > m_skin_dest_area_bottom_left
 
core::rect< s32 > m_skin_dest_area_bottom_right
 
core::rect< s32 > m_skin_dest_area_left_yflip
 
core::rect< s32 > m_skin_dest_area_center_yflip
 
core::rect< s32 > m_skin_dest_area_right_yflip
 
core::rect< s32 > m_skin_dest_area_top_yflip
 
core::rect< s32 > m_skin_dest_area_bottom_yflip
 
core::rect< s32 > m_skin_dest_area_top_left_yflip
 
core::rect< s32 > m_skin_dest_area_top_right_yflip
 
core::rect< s32 > m_skin_dest_area_bottom_left_yflip
 
core::rect< s32 > m_skin_dest_area_bottom_right_yflip
 
short m_skin_r
 
short m_skin_g
 
short m_skin_b
 

Detailed Description

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)

Member Function Documentation

◆ isInited()

bool GUIEngine::ModalDialog::isInited ( )
inline

Because C++ doesn't support constructor delegation...

◆ loadFromFile()

void ModalDialog::loadFromFile ( const char *  xmlFile)
protected

Load a XML file to create the dialog from.

Note
This method automatically calls Widget::add() on each widget

The documentation for this class was generated from the following files: