CrystalSpace

Public API Reference

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

csHint Class Reference
[Floating hints]

This component will display "floating hints", which will vanish as soon as you move the mouse or press a key. More...

#include <cshints.h>

Inheritance diagram for csHint:

csComponent List of all members.

Public Methods

 csHint (csComponent *iParent, const char *iText, iFont *Font=0)
 Create a floating hint with an text string.

virtual ~csHint ()
 Cleanup before destruction.

virtual void Draw ()
 Draw the hint object.

virtual bool PreHandleEvent (iEvent &Event)
 Handle all events before any others get a chance to eat it.

virtual void SetText (const char *iText)
 Set the text of the hint (also resizes the window).


Detailed Description

This component will display "floating hints", which will vanish as soon as you move the mouse or press a key.

A object of this class is automatically created by csComponent class when it detects that the mouse is unmoved for some time over some non-focused component that has an associated hint.

Definition at line 45 of file cshints.h.


Constructor & Destructor Documentation

csHint::csHint csComponent   iParent,
const char *    iText,
iFont   Font = 0
 

Create a floating hint with an text string.

virtual csHint::~csHint   [virtual]
 

Cleanup before destruction.


Member Function Documentation

virtual void csHint::Draw   [virtual]
 

Draw the hint object.

Reimplemented from csComponent.

virtual bool csHint::PreHandleEvent iEvent   Event [virtual]
 

Handle all events before any others get a chance to eat it.

Reimplemented from csComponent.

virtual void csHint::SetText const char *    iText [virtual]
 

Set the text of the hint (also resizes the window).

Reimplemented from csComponent.


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