Emergency 20 Dokumentation  4.2.0
em5::PatchUpdateProgressDialog Class Reference

Patch update pregress dialog GUI window. More...

#include <PatchUpdateProgressDialog.h>

Inheritance diagram for em5::PatchUpdateProgressDialog:
qsf::GuiDocument

Public Types

enum  AnimationState { NONE, BUTTON_OUT, PROGRESS_IN }
 

Public Member Functions

 PatchUpdateProgressDialog (qsf::GuiContext &guiContext)
 Constructor. More...
 
virtual ~PatchUpdateProgressDialog ()
 Destructor. More...
 
void setPercentage (float percentage)
 Set the progressbar percentage. More...
 
void setCompletePercentage (float percentage)
 Set the complete progressbar progressbar percentage. More...
 
virtual bool onPreShow () override
 Called before show. 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

Patch update pregress dialog GUI window.

Member Enumeration Documentation

Enumerator
NONE 
BUTTON_OUT 
PROGRESS_IN 

Constructor & Destructor Documentation

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

Constructor.

virtual em5::PatchUpdateProgressDialog::~PatchUpdateProgressDialog ( )
virtual

Destructor.

Member Function Documentation

virtual bool em5::PatchUpdateProgressDialog::onPreShow ( )
overridevirtual

Called before show.

Returns
"true" to show the document, "false" to suppress the show request
Note
  • This method gives you the opportunity to manipulate the document before it will show
  • The default implementation is empty and returns true

Reimplemented from qsf::GuiDocument.

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

Reimplemented from qsf::GuiDocument.

void em5::PatchUpdateProgressDialog::setCompletePercentage ( float  percentage)

Set the complete progressbar progressbar percentage.

Parameters
[in]percentagePercentage between 0.0 and 1.0
void em5::PatchUpdateProgressDialog::setPercentage ( float  percentage)

Set the progressbar percentage.

Parameters
[in]percentagePercentage between 0.0 and 1.0

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