CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

csHintManager Class Reference
[Floating hints]

The "hint manager" keeps track of all hints and associated components, and creates the appropiate csHint when it detects mouse is not moved for too long time. More...

#include <cshints.h>

Inheritance diagram for csHintManager:

csVector csBasicVector List of all members.

Public Methods

 csHintManager (csApp *iApp)
 Initialize the hint manager object. More...

virtual ~csHintManager ()
 Destroy the hint manager. More...

virtual bool FreeItem (void *Item)
 Override FreeItem to correctly free hint store objects. More...

virtual int Compare (void *Item1, void *Item2, int Mode) const
 Compare two hints (by csComponent's). More...

virtual int CompareKey (void *Item, const void *Key, int Mode) const
 Compare a hint with a csComponent. More...

void Add (const char *iText, csComponent *iComp)
 Add a new hint. More...

void Remove (csComponent *iComp)
 Remove the hint (if any) associated with this component. More...

void HandleEvent (iEvent &Event)
 Examine a mouse event. More...

void SetTimeout (csTicks iTimeout)
 Set hints timeout. More...

void SetFont (iFont *iNewFont, int iSize)
 Set the font and font size for hints. More...


Detailed Description

The "hint manager" keeps track of all hints and associated components, and creates the appropiate csHint when it detects mouse is not moved for too long time.

Definition at line 71 of file cshints.h.


Constructor & Destructor Documentation

csHintManager::csHintManager csApp   iApp
 

Initialize the hint manager object.

virtual csHintManager::~csHintManager   [virtual]
 

Destroy the hint manager.


Member Function Documentation

void csHintManager::Add const char *    iText,
csComponent   iComp
 

Add a new hint.

Referenced by csApp::HintAdd.

virtual int csHintManager::Compare void *    Item1,
void *    Item2,
int    Mode
const [virtual]
 

Compare two hints (by csComponent's).

Reimplemented from csVector.

virtual int csHintManager::CompareKey void *    Item,
const void *    Key,
int    Mode
const [virtual]
 

Compare a hint with a csComponent.

Reimplemented from csVector.

virtual bool csHintManager::FreeItem void *    Item [virtual]
 

Override FreeItem to correctly free hint store objects.

Reimplemented from csVector.

void csHintManager::HandleEvent iEvent   Event
 

Examine a mouse event.

void csHintManager::Remove csComponent   iComp
 

Remove the hint (if any) associated with this component.

void csHintManager::SetFont iFont   iNewFont,
int    iSize
 

Set the font and font size for hints.

void csHintManager::SetTimeout csTicks    iTimeout [inline]
 

Set hints timeout.

Definition at line 114 of file cshints.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14