Emergency 20 Dokumentation  4.2.0
em5::OverlayWindow Class Reference

EMERGENCY 5 overlay window base class. More...

#include <OverlayWindow.h>

Inheritance diagram for em5::OverlayWindow:
qsf::GuiDocument em5::BuildingOverlayWindow em5::StatusOverlayWindow

Public Member Functions

 OverlayWindow (qsf::GuiContext &guiContext)
 
 OverlayWindow (qsf::GuiContext &guiContext, Rocket::Core::ElementDocument &rocketCoreElementDocument)
 
virtual ~OverlayWindow ()
 
bool isEnabled () const
 
void setEnabled (bool enabled)
 
- 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)
 

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...
 
- Protected Member Functions inherited from qsf::GuiDocument
void createEmptyDocument ()
 

Detailed Description

EMERGENCY 5 overlay window base class.

Constructor & Destructor Documentation

em5::OverlayWindow::OverlayWindow ( qsf::GuiContext guiContext)
explicit
em5::OverlayWindow::OverlayWindow ( qsf::GuiContext guiContext,
Rocket::Core::ElementDocument &  rocketCoreElementDocument 
)
explicit
virtual em5::OverlayWindow::~OverlayWindow ( )
virtual

Member Function Documentation

bool em5::OverlayWindow::isEnabled ( ) const
inline
void em5::OverlayWindow::setEnabled ( bool  enabled)

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