vtkKWBalloonHelpManager Class Reference

a "balloon help " manager class More...

#include <vtkKWBalloonHelpManager.h>

Inheritance diagram for vtkKWBalloonHelpManager:

[legend]Collaboration diagram for vtkKWBalloonHelpManager:

[legend]List of all members.

[NOHEADER]
virtual void	SetCurrentWidget (vtkKWWidget *widget)
vtkKWWidget *	CurrentWidget
[NOHEADER]
virtual void	SetAfterTimerId (const char *)
char *	AfterTimerId
Public Member Functions
	vtkTypeRevisionMacro (vtkKWBalloonHelpManager, vtkKWObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetVisibility (int)
virtual int	GetVisibility ()
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()
virtual void	SetDelay (int)
virtual int	GetDelay ()
virtual void	AddBindings (vtkKWWidget *widget)
virtual void	RemoveBindings (vtkKWWidget *widget)
virtual void	TriggerCallback (vtkKWWidget *widget)
virtual void	DisplayCallback (vtkKWWidget *widget)
virtual void	CancelCallback ()
virtual void	WithdrawCallback ()
Static Public Member Functions
vtkKWBalloonHelpManager *	New ()
Protected Member Functions
	vtkKWBalloonHelpManager ()
	~vtkKWBalloonHelpManager ()
virtual void	CreateBalloon ()
virtual int	ApplicationInExit ()
Protected Attributes
int	Visibility
int	Delay
vtkKWTopLevel *	TopLevel
vtkKWLabel *	Label

---

Detailed Description

a "balloon help " manager class

vtkKWBalloonHelpManager is a class that provides functionality to display balloon help (tooltips) for an application. An instance of this class is created in the vtkKWApplication class. When the balloon help string of a vtkKWWidget is set, the balloon help manager instance of the widget's application is called to set up bindings automatically for this widget (see AddBindings()). These bindings will trigger the manager callbacks to display the balloon help string appropriately.

See also:

vtkKWApplication vtkKWWidget

Definition at line 38 of file vtkKWBalloonHelpManager.h.

---

Constructor & Destructor Documentation

vtkKWBalloonHelpManager::vtkKWBalloonHelpManager (   )  [protected]

vtkKWBalloonHelpManager::~vtkKWBalloonHelpManager (   )  [protected]

---

Member Function Documentation

vtkKWBalloonHelpManager* vtkKWBalloonHelpManager::New (   )  [static]

Reimplemented from vtkKWObject.

vtkKWBalloonHelpManager::vtkTypeRevisionMacro (  vtkKWBalloonHelpManager  , vtkKWObject  )

void vtkKWBalloonHelpManager::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented from vtkKWObject.

virtual void vtkKWBalloonHelpManager::SetVisibility (  int   )  [virtual]

Set/Get balloon help visibility for all the widgets bound to this helper.

virtual int vtkKWBalloonHelpManager::GetVisibility (   )  [virtual]

Set/Get balloon help visibility for all the widgets bound to this helper.

virtual void vtkKWBalloonHelpManager::VisibilityOn (   )  [virtual]

Set/Get balloon help visibility for all the widgets bound to this helper.

virtual void vtkKWBalloonHelpManager::VisibilityOff (   )  [virtual]

Set/Get balloon help visibility for all the widgets bound to this helper.

virtual void vtkKWBalloonHelpManager::SetDelay (  int   )  [virtual]

Set the delay for the balloon help in milliseconds.

virtual int vtkKWBalloonHelpManager::GetDelay (   )  [virtual]

Set the delay for the balloon help in milliseconds.

virtual void vtkKWBalloonHelpManager::AddBindings (  vtkKWWidget *  widget  )  [virtual]

Add/remove bindings for a given widget, effectively providing balloon help feature for this widget. On the widget side, one has to set the balloon help string or image.

virtual void vtkKWBalloonHelpManager::RemoveBindings (  vtkKWWidget *  widget  )  [virtual]

Add/remove bindings for a given widget, effectively providing balloon help feature for this widget. On the widget side, one has to set the balloon help string or image.

virtual void vtkKWBalloonHelpManager::TriggerCallback (  vtkKWWidget *  widget  )  [virtual]

Callbacks.

virtual void vtkKWBalloonHelpManager::DisplayCallback (  vtkKWWidget *  widget  )  [virtual]

Callbacks.

virtual void vtkKWBalloonHelpManager::CancelCallback (   )  [virtual]

Callbacks.

virtual void vtkKWBalloonHelpManager::WithdrawCallback (   )  [virtual]

Callbacks.

virtual void vtkKWBalloonHelpManager::SetCurrentWidget (  vtkKWWidget *  widget  )  [protected, virtual]

virtual void vtkKWBalloonHelpManager::SetAfterTimerId (  const char *   )  [protected, virtual]

virtual void vtkKWBalloonHelpManager::CreateBalloon (   )  [protected, virtual]

Create the UI.

virtual int vtkKWBalloonHelpManager::ApplicationInExit (   )  [protected, virtual]

Return true if the application is exiting, i.e. if it is not safe to perform anything (balloon help is an asynchronous process)

---

Member Data Documentation

int vtkKWBalloonHelpManager::Visibility [protected]

Definition at line 79 of file vtkKWBalloonHelpManager.h.

int vtkKWBalloonHelpManager::Delay [protected]

Definition at line 80 of file vtkKWBalloonHelpManager.h.

vtkKWTopLevel* vtkKWBalloonHelpManager::TopLevel [protected]

Definition at line 82 of file vtkKWBalloonHelpManager.h.

vtkKWLabel* vtkKWBalloonHelpManager::Label [protected]

Definition at line 83 of file vtkKWBalloonHelpManager.h.

vtkKWWidget* vtkKWBalloonHelpManager::CurrentWidget [protected]

The widget which balloon help is currently being displayed or pending. Definition at line 88 of file vtkKWBalloonHelpManager.h.

char* vtkKWBalloonHelpManager::AfterTimerId [protected]

The Id of the Tk 'after' timer that will display the balloon help after some delay. Definition at line 95 of file vtkKWBalloonHelpManager.h.

---

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

• GUI/Widgets/vtkKWBalloonHelpManager.h

---