Emergency 20 Dokumentation  4.2.0
em5::MouseCursorManager Class Reference

Manager for handling mouse cursors via libRocket. More...

#include <MouseCursorManager.h>

Inheritance diagram for em5::MouseCursorManager:

Public Member Functions

 MouseCursorManager (qsf::GuiContext &guiContext)
 Constructor. More...
 
virtual ~MouseCursorManager ()
 Destructor. More...
 
void startup ()
 Doing initialization (loading the mouse cursor document) More...
 
void setMouseCursor (const std::string &cursorName)
 Sets the cursor identified by the name as the new current mouse cursor. More...
 
void resetMouseCursor ()
 Resets the mouse cursor to its default. More...
 
void showCursor (bool show)
 Show hide the mouse cursor. More...
 

Detailed Description

Manager for handling mouse cursors via libRocket.

Constructor & Destructor Documentation

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

Constructor.

Parameters
[in]guiContextThe GUI context for which the cursors should be managed
virtual em5::MouseCursorManager::~MouseCursorManager ( )
virtual

Destructor.

Member Function Documentation

void em5::MouseCursorManager::resetMouseCursor ( )

Resets the mouse cursor to its default.

void em5::MouseCursorManager::setMouseCursor ( const std::string &  cursorName)

Sets the cursor identified by the name as the new current mouse cursor.

void em5::MouseCursorManager::showCursor ( bool  show)

Show hide the mouse cursor.

Note
  • For ease-of-use: The method is using reference counting, meaning if you make the cursor two times invisible, you need to make it two times visible in order to see the mouse cursor
void em5::MouseCursorManager::startup ( )

Doing initialization (loading the mouse cursor document)


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