Public API Reference

                 

---

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:

List of all members.

Public Methods
	csHintManager (csApp *iApp)
	Initialize the hint manager object.
	~csHintManager ()
	Destroy the hint manager.
void	FreeAll ()
	Free all hints.
void	FreeItem (void *Item)
	Correctly free hint store objects.
void	Add (const char *iText, csComponent *iComp)
	Add a new hint.
void	Remove (csComponent *iComp)
	Remove the hint (if any) associated with this component.
void	HandleEvent (iEvent &Event)
	Examine a mouse event.
void	SetTimeout (csTicks iTimeout)
	Set hints timeout.
void	SetFont (iFont *iNewFont, int iSize)
	Set the font and font size for hints.
Static Public Methods
int	Compare (void *const &Item1, void *const &Item2)
	Compare two hints (by csComponent's).
int	CompareKey (void *const &Item, csComponent *const &key)
	Compare a hint with a csComponent.
csArrayCmp< void *, csComponent * >	KeyCmp (csComponent *c)
	Return a functor wrapping CompareKey() for a given csComponent.

---

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 72 of file cshints.h.

---

Constructor & Destructor Documentation

csHintManager::csHintManager (  csApp *    iApp )

Initialize the hint manager object.

csHintManager::~csHintManager (    )

Destroy the hint manager.

---

Member Function Documentation

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

Add a new hint. Referenced by csApp::HintAdd().

int csHintManager::Compare (  void *const &    Item1, void *const &    Item2 )  [static]

Compare two hints (by csComponent's).

int csHintManager::CompareKey (  void *const &    Item, csComponent *const &    key )  [static]

Compare a hint with a csComponent.

void csHintManager::FreeAll (    )

Free all hints.

void csHintManager::FreeItem (  void *    Item )

Correctly free hint store objects.

void csHintManager::HandleEvent (  iEvent &    Event )

Examine a mouse event.

csArrayCmp<void*,csComponent*> csHintManager::KeyCmp (  csComponent *    c )  [inline, static]

Return a functor wrapping CompareKey() for a given csComponent. Definition at line 111 of file cshints.h.

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 120 of file cshints.h.

---

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

• csws/cshints.h

---