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

#include <modaldialog.hpp>

Inheritance diagram for GUIEngine::ModalDialog:

[legend]

Public Member Functions
bool	isInited ()
	Because C++ doesn't support constructor delegation...

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

virtual bool	enableScreenPadding () const

Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
virtual int	getWidth ()=0

virtual int	getHeight ()=0

Widget *	getWidget (const char *name)
	This function returns a widget by name if that widget is found.

Widget *	getWidget (const int id)
	This function returns a widget by irrlicht ID if that widget is found.

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.

Widget *	getFirstWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the first widget found in within_vector.

Widget *	getLastWidget (PtrVector< Widget > *within_vector=NULL)
	This function returns the last widget found in within_vector.

void	elementsWereDeleted (PtrVector< Widget > *within_vector=NULL)
	This function is called when screen is removed.

bool	isMyChild (Widget *widget) const
	This function checks if a widget is a child of the container.

virtual bool	enableScreenPadding () const

Static Public Member Functions
static void	dismiss ()

static void	onEnterPressed ()

static ModalDialog *	getCurrent ()

static bool	isADialogActive ()

Static Public Member Functions inherited from GUIEngine::AbstractTopLevelContainer
static Widget *	getWidget (const char name, PtrVector< Widget > within_vector)
	This function returns a widget by name if that widget is found in within_vector.

static Widget *	getWidget (const int id, PtrVector< Widget > *within_vector)
	This function returns a widget by irrlicht ID if that widget is found.

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.

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.

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

Widget *	m_first_widget
	AbstractTopLevelContainer is generally able to determine its first widget just fine, but in highly complex screens (e.g.

Widget *	m_last_widget
	AbstractTopLevelContainer is generally able to determine its last widget just fine, but in highly complex screens (e.g.

Private Attributes
ModalDialogLocation	m_dialog_location

float	m_percent_width

float	m_percent_height

bool	m_init

bool	m_was_resizable

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

◆ beforeAddingWidgets()

virtual void GUIEngine::ModalDialog::beforeAddingWidgets ( )

inlinevirtual

Optional callback invoked very early, before widgets have been added (contrast with init(), which is invoked afer widgets were added)

Reimplemented in AchievementProgressDialog, CustomCameraSettingsDialog, CustomVideoSettingsDialog, InitAndroidDialog, MultitouchSettingsDialog, NetworkPlayerDialog, PlayerRankingsDialog, ServerConfigurationDialog, ServerInfoDialog, SplitscreenPlayerDialog, UserInfoDialog, AddonsLoading, AddonsPack, KartColorSliderDialog, and RacePausedDialog.

◆ enableScreenPadding()

virtual bool GUIEngine::ModalDialog::enableScreenPadding ( ) const

inlinevirtual

Reimplemented from GUIEngine::AbstractTopLevelContainer.

◆ getHeight()

virtual int GUIEngine::ModalDialog::getHeight ( )

inlinevirtual

Implementing callback from AbstractTopLevelContainer.

Implements GUIEngine::AbstractTopLevelContainer.

◆ getWidth()

virtual int GUIEngine::ModalDialog::getWidth ( )

inlinevirtual

Implementing callback from AbstractTopLevelContainer.

Implements GUIEngine::AbstractTopLevelContainer.

◆ init()

virtual void GUIEngine::ModalDialog::init ( )

inlinevirtual

Optional callback invoked after widgets have been add()ed.

Reimplemented in AchievementProgressDialog, NetworkPlayerDialog, ServerConfigurationDialog, UserInfoDialog, AddonsLoading, AddonsPack, MessageDialog, and RacePausedDialog.

◆ load()

virtual void GUIEngine::ModalDialog::load ( )

inlinevirtual

Reimplemented in MessageDialog.

◆ loadedFromFile()

virtual void GUIEngine::ModalDialog::loadedFromFile ( )

inlineprotectedvirtual

Callback invoked when the dialog was loaded from the XML file (if the constructor that takes a XML file as argument is used)

Reimplemented in MessageDialog, and RacePausedDialog.

◆ 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

◆ onEnterPressedInternal()

void ModalDialog::onEnterPressedInternal ( )

protectedvirtual

Reimplemented in RecoveryDialog, and ServerInfoDialog.

◆ onEscapePressed()

virtual bool GUIEngine::ModalDialog::onEscapePressed ( )

inlinevirtual

Override to change what happens on escape pressed.

Reimplemented in AchievementProgressDialog, ChangePasswordDialog, CustomCameraSettingsDialog, GhostReplayInfoDialog, InitAndroidDialog, NetworkPlayerDialog, PlayerRankingsDialog, RecoveryDialog, ServerConfigurationDialog, ServerInfoDialog, SplitscreenPlayerDialog, UserInfoDialog, VoteDialog, AddonsLoading, AddonsPack, and ConfirmResolutionDialog.

◆ onUpdate()

virtual void GUIEngine::ModalDialog::onUpdate ( float dt )

inlinevirtual

◆ processEvent()

virtual EventPropagation GUIEngine::ModalDialog::processEvent ( const std::string & eventSource )

inlinevirtual

Returns whether to block event propagation (usually, you will want to block events you processed)

Reimplemented in AddonsLoading, AddonsPack, EnterAddressDialog, AddDeviceDialog, ChangePasswordDialog, CustomCameraSettingsDialog, CustomVideoSettingsDialog, GhostReplayInfoDialog, HighScoreInfoDialog, InitAndroidDialog, MultitouchSettingsDialog, PressAKeyDialog, RecoveryDialog, RegistrationDialog, SelectChallengeDialog, ServerInfoDialog, UserInfoDialog, VoteDialog, ConfirmResolutionDialog, DebugSliderDialog, GeneralTextFieldDialog, KartColorSliderDialog, MessageDialog, RacePausedDialog, TutorialMessageDialog, AchievementProgressDialog, NetworkPlayerDialog, PlayerRankingsDialog, ServerConfigurationDialog, and SplitscreenPlayerDialog.

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

guiengine/modaldialog.hpp
guiengine/modaldialog.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ beforeAddingWidgets()

◆ enableScreenPadding()

◆ getHeight()

◆ getWidth()

◆ init()

◆ load()

◆ loadedFromFile()

◆ loadFromFile()

◆ onEnterPressedInternal()

◆ onEscapePressed()

◆ onUpdate()

◆ processEvent()