Emergency 20 Dokumentation  4.2.0
em5::ObjectiveWindow Class Reference

Objective window. More...

#include <ObjectiveWindow.h>

Inheritance diagram for em5::ObjectiveWindow:
qsf::GuiDocument

Public Member Functions

 ObjectiveWindow (qsf::GuiContext &guiContext)
 
virtual ~ObjectiveWindow ()
 
void enableButton (bool state)
 Enable an button. More...
 
void blinkButton (bool blink)
 Let an button blink. More...
 
void clear ()
 Removes any shown objectives and events. More...
 
const DefaultObjectiveWindowDataSourcegetDefaultObjectiveWindowDataSource () const
 Return the default objective window data source. More...
 
void setObjectiveWindowDataSource (ObjectiveWindowDataSource *objectiveWindowDataSource)
 Set objective window data source. More...
 
void triggerRefresh ()
 Trigger GUI refresh. More...
 
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)
 

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

Objective window.

Constructor & Destructor Documentation

em5::ObjectiveWindow::ObjectiveWindow ( qsf::GuiContext guiContext)
explicit
virtual em5::ObjectiveWindow::~ObjectiveWindow ( )
virtual

Member Function Documentation

void em5::ObjectiveWindow::blinkButton ( bool  blink)

Let an button blink.

Parameters
[in]blinkIndicates if the button should blink or not
void em5::ObjectiveWindow::clear ( )

Removes any shown objectives and events.

void em5::ObjectiveWindow::enableButton ( bool  state)

Enable an button.

Parameters
[in]stateIndicates if the button should enabled or not
const DefaultObjectiveWindowDataSource& em5::ObjectiveWindow::getDefaultObjectiveWindowDataSource ( ) const

Return the default objective window data source.

Returns
The default objective window data source
virtual void em5::ObjectiveWindow::processEvent ( const std::string &  eventKey,
Rocket::Core::Event &  event 
)
overridevirtual

Reimplemented from qsf::GuiDocument.

void em5::ObjectiveWindow::setObjectiveWindowDataSource ( ObjectiveWindowDataSource objectiveWindowDataSource)

Set objective window data source.

Parameters
[in]objectiveWindowDataSourceObjective window data source to use, if null pointer the EMERGENCY 5 default implementation will be used, the instance must stay valid as long as it's referenced (the objective window doesn't take over the memory ownership)
void em5::ObjectiveWindow::triggerRefresh ( )

Trigger GUI refresh.


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