Emergency 20 Dokumentation  4.2.0
em5::EmergencyGui Class Reference

EMERGENCY 5 GUI instance to handle the game-specific user interface. More...

#include <EmergencyGui.h>

Inheritance diagram for em5::EmergencyGui:
qsf::UniqueInstance< EmergencyGui >

Public Member Functions

 EmergencyGui (qsf::RenderWindow &renderWindow)
 Constructor. More...
 
virtual ~EmergencyGui ()
 Destructor. More...
 
void startupMenus ()
 Load and startup menus. More...
 
void startupGenericDebugGui (const std::string &guiDocumentName)
 Load the given libRocket document as an alternative to the EMERGENCY 5 main menu. More...
 
void showLogoScreen ()
 Show the logo screen. More...
 
void showMainMenu ()
 Show the main menu, create one if no one exist yet. More...
 
void hideMainMenu ()
 Hide the main menu. More...
 
void showStartMenu (bool installed=true)
 Show the start menu, create one if no one exist yet. More...
 
void hideStartMenu ()
 Hide the start menu. More...
 
LoadingScreengetLoadingScreen ()
 Return the LoadingScreen instance. More...
 
bool isLoadingScreenVisible () const
 Return whether the loading screen is currently shown. More...
 
void showLoadingScreen ()
 Show a loading screen, create one if no one exist yet. More...
 
void hideLoadingScreen ()
 Hide the loading screen. More...
 
void showIngameHud ()
 Show the ingame HUD. More...
 
void hideIngameHud ()
 Hide the ingame HUD. More...
 
void hideTooltip ()
 Hide tooltip. More...
 
void showTooltip ()
 Show tooltip. More...
 
qsf::GuiContextgetGuiContext () const
 Return the GUI context. More...
 
MainMenuManagergetMainMenuManager ()
 Return the main menu manager instance. More...
 
StartMenuManagergetStartMenuManager () const
 Return the start menu manager instance. More...
 
IngameHudgetIngameHud () const
 Return the in-game HUD instance. More...
 
IngameHudtryGetIngameHud () const
 
PatchUpdateProgressDialoggetPatchUpdateProgressDialog () const
 Return the patch update progress dialog. More...
 
void showMouseCursor (bool show)
 Show or hide software mouse cursor. More...
 
void setMouseCursor (const std::string &cursorName)
 Change current mouse cursor. More...
 
void resetMouseCursor ()
 Resets the current mouse cursor to default. More...
 
void showModalMessageBox (const std::string &title, const std::string &text, const std::string &buttonTrueText, const std::string &buttonFalseText, const boost::function< void(bool)> &callback)
 Open a standard message box with two buttons as modal window. More...
 
void showModalMessageBox (const std::string &title, const std::string &text, const std::string &buttonTrueText, const std::string &buttonFalseText, float autoFalseTime, const boost::function< void(bool)> &callback)
 Open a standard message box with two buttons as modal window which close after "autoFalseTime" with a false command. More...
 
void showModalMessageBox (const std::string &title, const std::string &text, const std::string &buttonText, const boost::function< void(bool)> &callback)
 Open a standard message box with one button as modal window, with callback. More...
 
void showModalMessageBox (const std::string &title, const std::string &text, const std::string &buttonText)
 Open a standard message box with one button as modal window, no callback. More...
 
void abortModalMessageBox ()
 Abort the modal dialog. More...
 
void setContentAuthenticationWindowVisible (bool visible) const
 
void setCloudSynchronisationWindowVisible (bool visible) const
 
void showPatchUpdateProgressDialog ()
 Shows the patch update progress dialog window. More...
 
ToolTipManagergetToolTipManager () const
 

Additional Inherited Members

- Static Public Member Functions inherited from qsf::UniqueInstance< EmergencyGui >
static EmergencyGui * getInstance ()
 Return the global unique instance. More...
 
static EmergencyGui & getInstanceSafe ()
 Return the global unique instance. More...
 
- Protected Member Functions inherited from qsf::UniqueInstance< EmergencyGui >
 UniqueInstance ()
 Default constructor. More...
 
virtual ~UniqueInstance ()
 Destructor. More...
 

Detailed Description

EMERGENCY 5 GUI instance to handle the game-specific user interface.

Constructor & Destructor Documentation

em5::EmergencyGui::EmergencyGui ( qsf::RenderWindow renderWindow)
explicit

Constructor.

Parameters
[in]renderWindowRender window to assign the GUI context to
virtual em5::EmergencyGui::~EmergencyGui ( )
virtual

Destructor.

Member Function Documentation

void em5::EmergencyGui::abortModalMessageBox ( )

Abort the modal dialog.

qsf::GuiContext & em5::EmergencyGui::getGuiContext ( ) const
inline

Return the GUI context.

Returns
Reference to the GUI context, do not destroy the instance
IngameHud & em5::EmergencyGui::getIngameHud ( ) const
inline

Return the in-game HUD instance.

Returns
Reference to the in-game HUD instance, do not destroy the instance
LoadingScreen& em5::EmergencyGui::getLoadingScreen ( )

Return the LoadingScreen instance.

Returns
Reference to the LoadingScreen instance, do not destroy the instance
MainMenuManager& em5::EmergencyGui::getMainMenuManager ( )

Return the main menu manager instance.

Returns
Reference to the main menu manager instance, do not destroy the instance
PatchUpdateProgressDialog & em5::EmergencyGui::getPatchUpdateProgressDialog ( ) const
inline

Return the patch update progress dialog.

StartMenuManager & em5::EmergencyGui::getStartMenuManager ( ) const
inline

Return the start menu manager instance.

Returns
Reference to the start menu manager instance, do not destroy the instance
ToolTipManager & em5::EmergencyGui::getToolTipManager ( ) const
inline
void em5::EmergencyGui::hideIngameHud ( )

Hide the ingame HUD.

void em5::EmergencyGui::hideLoadingScreen ( )

Hide the loading screen.

void em5::EmergencyGui::hideMainMenu ( )

Hide the main menu.

Remarks
Use this for a dummy main menu
void em5::EmergencyGui::hideStartMenu ( )

Hide the start menu.

void em5::EmergencyGui::hideTooltip ( )

Hide tooltip.

bool em5::EmergencyGui::isLoadingScreenVisible ( ) const

Return whether the loading screen is currently shown.

void em5::EmergencyGui::resetMouseCursor ( )

Resets the current mouse cursor to default.

void em5::EmergencyGui::setCloudSynchronisationWindowVisible ( bool  visible) const
void em5::EmergencyGui::setContentAuthenticationWindowVisible ( bool  visible) const
void em5::EmergencyGui::setMouseCursor ( const std::string &  cursorName)

Change current mouse cursor.

void em5::EmergencyGui::showIngameHud ( )

Show the ingame HUD.

void em5::EmergencyGui::showLoadingScreen ( )

Show a loading screen, create one if no one exist yet.

void em5::EmergencyGui::showLogoScreen ( )

Show the logo screen.

void em5::EmergencyGui::showMainMenu ( )

Show the main menu, create one if no one exist yet.

Remarks
Use this for a dummy main menu
void em5::EmergencyGui::showModalMessageBox ( const std::string &  title,
const std::string &  text,
const std::string &  buttonTrueText,
const std::string &  buttonFalseText,
const boost::function< void(bool)> &  callback 
)

Open a standard message box with two buttons as modal window.

void em5::EmergencyGui::showModalMessageBox ( const std::string &  title,
const std::string &  text,
const std::string &  buttonTrueText,
const std::string &  buttonFalseText,
float  autoFalseTime,
const boost::function< void(bool)> &  callback 
)

Open a standard message box with two buttons as modal window which close after "autoFalseTime" with a false command.

void em5::EmergencyGui::showModalMessageBox ( const std::string &  title,
const std::string &  text,
const std::string &  buttonText,
const boost::function< void(bool)> &  callback 
)

Open a standard message box with one button as modal window, with callback.

void em5::EmergencyGui::showModalMessageBox ( const std::string &  title,
const std::string &  text,
const std::string &  buttonText 
)

Open a standard message box with one button as modal window, no callback.

void em5::EmergencyGui::showMouseCursor ( bool  show)

Show or hide software mouse cursor.

void em5::EmergencyGui::showPatchUpdateProgressDialog ( )

Shows the patch update progress dialog window.

void em5::EmergencyGui::showStartMenu ( bool  installed = true)

Show the start menu, create one if no one exist yet.

void em5::EmergencyGui::showTooltip ( )

Show tooltip.

void em5::EmergencyGui::startupGenericDebugGui ( const std::string &  guiDocumentName)

Load the given libRocket document as an alternative to the EMERGENCY 5 main menu.

Parameters
[in]guiDocumentNameUTF-8 virtual filename of the document to load
Remarks
Use this for testing a GUI document in development.
void em5::EmergencyGui::startupMenus ( )

Load and startup menus.

IngameHud * em5::EmergencyGui::tryGetIngameHud ( ) const
inline

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