Emergency 20 Dokumentation  4.2.0
em5::VehicleOrderWindow Class Reference

Vehicle order window. More...

#include <VehicleOrderWindow.h>

Inheritance diagram for em5::VehicleOrderWindow:
qsf::GuiDocument

Public Types

enum  VehicleOrderWindowButton { VEHICLEORDERWINDOW_ORDER, VEHICLEORDERWINDOW_BACK, VEHICLEORDERWINDOW_HELP, VEHICLEORDERWINDOW_CLOSE }
 

Public Member Functions

 VehicleOrderWindow (qsf::GuiContext &guiContext)
 
virtual ~VehicleOrderWindow ()
 
void setMaximumOrderNumber (uint32 maximumOrderNumber)
 
void setupWindow (const OrderInfo &orderInfo)
 Rebuild the window for the given orderInfo. More...
 
void enableButton (VehicleOrderWindowButton buttonId, bool state)
 Let an button blink. More...
 
void enableCloseButton (bool enable)
 Enable or disable close button. More...
 
void blinkButton (VehicleOrderWindowButton buttonId, bool blink)
 Let an button blink. More...
 
void enablePersonalModification (bool enable)
 Enables if the player can change the amount of personal in the ordered vehicle. More...
 
void startOrderMode (bool hideWindow=false)
 Start an oder unit command mode for the current order info. More...
 
void closedViaEscapeKey ()
 
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)
 

Static Public Attributes

static const int MAX_NUMBER_OF_PASSENGER
 

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 order window.

Note

Member Enumeration Documentation

Enumerator
VEHICLEORDERWINDOW_ORDER 
VEHICLEORDERWINDOW_BACK 
VEHICLEORDERWINDOW_HELP 
VEHICLEORDERWINDOW_CLOSE 

Constructor & Destructor Documentation

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

Member Function Documentation

void em5::VehicleOrderWindow::blinkButton ( VehicleOrderWindowButton  buttonId,
bool  blink 
)

Let an button blink.

Parameters
[in]buttonIdThe ID of the button which should blink
[in]blinkIndicates if the button should blink or not
void em5::VehicleOrderWindow::closedViaEscapeKey ( )
void em5::VehicleOrderWindow::enableButton ( VehicleOrderWindowButton  buttonId,
bool  state 
)

Let an button blink.

Parameters
[in]buttonIdThe ID of the button which should enabled
[in]stateIndicates if the button should enabled or not
void em5::VehicleOrderWindow::enableCloseButton ( bool  enable)

Enable or disable close button.

void em5::VehicleOrderWindow::enablePersonalModification ( bool  enable)

Enables if the player can change the amount of personal in the ordered vehicle.

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

Reimplemented from qsf::GuiDocument.

void em5::VehicleOrderWindow::setMaximumOrderNumber ( uint32  maximumOrderNumber)
void em5::VehicleOrderWindow::setupWindow ( const OrderInfo orderInfo)

Rebuild the window for the given orderInfo.

void em5::VehicleOrderWindow::startOrderMode ( bool  hideWindow = false)

Start an oder unit command mode for the current order info.

Member Data Documentation

const int em5::VehicleOrderWindow::MAX_NUMBER_OF_PASSENGER
static

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