Emergency 20 Dokumentation  4.2.0
em5::CommandWindow Class Reference

EMERGENCY 5 in-game command window. More...

#include <CommandWindow.h>

Inheritance diagram for em5::CommandWindow:
qsf::GuiDocument

Public Member Functions

 CommandWindow (qsf::GuiContext &guiContext)
 
void enableButton (const qsf::StringHash commandId, bool enabled)
 Enable a button. More...
 
void enableAllButtons (bool enabled)
 Enable all buttons. More...
 
void blinkButton (const qsf::StringHash commandId, bool blink)
 Let an button blink. More...
 
uint32 getNumberOfActiveButtons () const
 Return the number of active buttons. More...
 
void activateButtonByIndex (int index)
 
void deactivateButtons ()
 
virtual void processEvent (const std::string &eventKey, Rocket::Core::Event &event) override
 
- 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 processViewportDimensionsChanged (int width, int height)
 

Public Attributes

boost::signals2::signal< void()> NumberOfActiveButtonsChanged
 

Static Public Attributes

static qsf::StringHash HELP_BUTTON_ID
 

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 in-game command window.

Constructor & Destructor Documentation

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

Member Function Documentation

void em5::CommandWindow::activateButtonByIndex ( int  index)
void em5::CommandWindow::blinkButton ( const qsf::StringHash  commandId,
bool  blink 
)

Let an button blink.

Parameters
[in]commandIdThe command id of the button set the blink state
[in]blinkIndicates if the button should blink or not
void em5::CommandWindow::deactivateButtons ( )
void em5::CommandWindow::enableAllButtons ( bool  enabled)

Enable all buttons.

Parameters
[in]stateIndicates if all buttons should be enabled or not
void em5::CommandWindow::enableButton ( const qsf::StringHash  commandId,
bool  enabled 
)

Enable a button.

Parameters
[in]commandIdThe command id of the button
[in]stateIndicates if the button should be enabled or not
uint32 em5::CommandWindow::getNumberOfActiveButtons ( ) const

Return the number of active buttons.

virtual void em5::CommandWindow::processEvent ( const std::string &  eventKey,
Rocket::Core::Event &  event 
)
overridevirtual

Reimplemented from qsf::GuiDocument.

Member Data Documentation

qsf::StringHash em5::CommandWindow::HELP_BUTTON_ID
static
boost::signals2::signal<void ()> em5::CommandWindow::NumberOfActiveButtonsChanged

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