Emergency 20 Dokumentation  4.2.0
em5::ToolTipWindow Class Reference

EMERGENCY 5 tooltip window. More...

#include <ToolTipWindow.h>

Inheritance diagram for em5::ToolTipWindow:
qsf::GuiDocument

Public Member Functions

 ToolTipWindow (qsf::GuiContext &guiContext)
 
virtual ~ToolTipWindow ()
 
void updateText (const std::string &text, const glm::ivec2 &mousePosition)
 
void updatePosition (const glm::ivec2 &mousePosition)
 
void activate ()
 
void deactivate (bool withFadeOut)
 
bool isFadeOutEnabled () const
 
void enabledFadeOut (bool enable)
 
float getFadeOutTimeInSeconds () const
 
void setFadeOutTimeInSeconds (float fadeTime)
 
bool isShowDelayEnabled () const
 
void enabledShowDelay (bool enable)
 
float getShowDelayInSeconds () const
 
void setShowDelayInSeconds (float delayTime)
 
- 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 processEvent (const std::string &eventKey, Rocket::Core::Event &event)
 
virtual void processViewportDimensionsChanged (int width, int height)
 

Friends

class ToolTipManager
 

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

Constructor & Destructor Documentation

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

Member Function Documentation

void em5::ToolTipWindow::activate ( )
void em5::ToolTipWindow::deactivate ( bool  withFadeOut)
void em5::ToolTipWindow::enabledFadeOut ( bool  enable)
void em5::ToolTipWindow::enabledShowDelay ( bool  enable)
float em5::ToolTipWindow::getFadeOutTimeInSeconds ( ) const
float em5::ToolTipWindow::getShowDelayInSeconds ( ) const
bool em5::ToolTipWindow::isFadeOutEnabled ( ) const
bool em5::ToolTipWindow::isShowDelayEnabled ( ) const
void em5::ToolTipWindow::setFadeOutTimeInSeconds ( float  fadeTime)
void em5::ToolTipWindow::setShowDelayInSeconds ( float  delayTime)
void em5::ToolTipWindow::updatePosition ( const glm::ivec2 &  mousePosition)
void em5::ToolTipWindow::updateText ( const std::string &  text,
const glm::ivec2 &  mousePosition 
)

Friends And Related Function Documentation

friend class ToolTipManager
friend

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