Emergency 20 Dokumentation  4.2.0
em5::GuiHotReloadSupport Class Reference

A base class which adds GUI hot reloading support to an GUI document. More...

#include <GuiHotReloadSupport.h>

Inheritance diagram for em5::GuiHotReloadSupport:
qsf::GuiDocument em5::AccountInfo em5::DebugEventBox em5::FreeplayFailedWindow em5::IngameFreeplayEndWindow em5::IngameLoadSaveWindow em5::IngameMainEventSuccessWindow em5::IngameOnlineHighscoreWindow em5::MainMenuWindowBase em5::MessageBox em5::MultiplayerHelpWindow

Public Member Functions

 GuiHotReloadSupport (qsf::GuiContext &guiContext)
 Default constructor. More...
 
virtual ~GuiHotReloadSupport ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::GuiDocument
 GuiDocument (GuiContext &guiContext)
 Constructor. More...
 
 GuiDocument (GuiContext &guiContext, Rocket::Core::ElementDocument &rocketCoreElementDocument)
 Constructor. More...
 
virtual ~GuiDocument ()
 Destructor. More...
 
GuiContextgetGuiContext () const
 Return the document's owning GUI context. More...
 
Rocket::Core::ElementDocument * getRocketCoreElementDocument () const
 Return the document's libRocket document. More...
 
bool loadByFilename (const std::string &filename)
 Load the document from an RML file. More...
 
void unload ()
 Use this method if you want to change a documents .rml file at runtime. More...
 
void show ()
 Show the document. More...
 
void showFocused ()
 Show the document focused. More...
 
void showModal ()
 Show the document modal. More...
 
void hide ()
 Hide the document. More...
 
bool isVisible () const
 Check if the document is currently visible. More...
 
void setVisible (bool visible)
 Show/hide the document. More...
 
void pullToFront ()
 Pull the document to the front. More...
 
Rocket::Core::Element * findElementById (const std::string &elementId) const
 Find an element inside the document by its case-sensitive ID. More...
 
void registerNewButton (const std::string &buttonId, const std::string &event, const std::string &eventKey)
 Register a new button. More...
 
virtual void toggleVisibility ()
 Toggle visibility. More...
 
virtual void processEvent (const std::string &eventKey, Rocket::Core::Event &event)
 
virtual void processViewportDimensionsChanged (int width, int height)
 

Protected Member Functions

virtual void onReloadGui ()
 Gets called when the GUI should be reloaded. More...
 
virtual bool onDocumentPreShow ()
 
virtual void onDocumentPreHide ()
 
- Protected Member Functions inherited from qsf::GuiDocument
void createEmptyDocument ()
 

Additional Inherited Members

- Static Public Member Functions inherited from qsf::GuiDocument
static Rocket::Core::EventListener * createEventListener (const std::string &eventKey)
 Create an event listener. More...
 
static GuiDocumentgetGuiDocumentByRocketCoreElement (Rocket::Core::Element *element)
 Return a QSF GUI document instance by using a given libRocket element instance. More...
 

Detailed Description

A base class which adds GUI hot reloading support to an GUI document.

Remarks
That GUI hot reloading works a derived class has to implement onDocumentPreShow/onDocumentPreHide (If the derived class wants to react on pre show/hide) instead of the private virtual qsf::GuiDocument methods onPreShow/onPreHide

Constructor & Destructor Documentation

em5::GuiHotReloadSupport::GuiHotReloadSupport ( qsf::GuiContext guiContext)
explicit

Default constructor.

Parameters
[in]guiContextThe GUI context to which the GUI document belongs to
virtual em5::GuiHotReloadSupport::~GuiHotReloadSupport ( )
virtual

Destructor.

Member Function Documentation


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