Emergency 20 Dokumentation  4.2.0
em5::VehicleSelectionWindow Class Reference

Vehicle selection window. More...

#include <VehicleSelectionWindow.h>

Inheritance diagram for em5::VehicleSelectionWindow:
qsf::GuiDocument

Public Member Functions

 VehicleSelectionWindow (qsf::GuiContext &guiContext)
 
virtual ~VehicleSelectionWindow ()
 
void enableItem (uint32 itemId, bool state)
 Let an item in the list blink. More...
 
void enableCloseButton (bool enable)
 Enable or disable the close button. More...
 
void blinkItem (uint32 itemId, bool blink)
 Let an item in the list blink. More...
 
units::Department getCurrentDepartment () const
 Return the current department string. More...
 
void resetCurrentDepartment ()
 Reset the current department string. More...
 
void setupWindow (units::Department department, float scrollTo=0.0f)
 Build up all the content for the window by hand. More...
 
void selectUnitByIndex (int i)
 
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

Vehicle selection window.

Note

Constructor & Destructor Documentation

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

Member Function Documentation

void em5::VehicleSelectionWindow::blinkItem ( uint32  itemId,
bool  blink 
)

Let an item in the list blink.

Parameters
[in]itemIdThe ID of the item which should blink
[in]blinkIndicates if the item should blink or not
void em5::VehicleSelectionWindow::enableCloseButton ( bool  enable)

Enable or disable the close button.

void em5::VehicleSelectionWindow::enableItem ( uint32  itemId,
bool  state 
)

Let an item in the list blink.

Parameters
[in]itemIdThe ID of the item which should enabled
[in]stateIndicates if the item should enabled or not
units::Department em5::VehicleSelectionWindow::getCurrentDepartment ( ) const

Return the current department string.

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

Reimplemented from qsf::GuiDocument.

void em5::VehicleSelectionWindow::resetCurrentDepartment ( )

Reset the current department string.

void em5::VehicleSelectionWindow::selectUnitByIndex ( int  i)
void em5::VehicleSelectionWindow::setupWindow ( units::Department  department,
float  scrollTo = 0.0f 
)

Build up all the content for the window by hand.


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