vtkKWProgressGauge Class Reference

a horizontal progress bar widget More...

#include <vtkKWProgressGauge.h>

Inheritance diagram for vtkKWProgressGauge:

[legend]Collaboration diagram for vtkKWProgressGauge:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWProgressGauge, vtkKWCompositeWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	ConfigureCallback ()
virtual void	SetValue (double value)
virtual double	GetValue ()
virtual void	SetWidth (int width)
virtual int	GetWidth ()
virtual void	SetHeight (int height)
virtual int	GetHeight ()
virtual void	ExpandHeightOn ()
virtual void	ExpandHeightOff ()
virtual void	SetExpandHeight (int)
virtual int	GetExpandHeight ()
virtual void	SetMinimumHeight (int height)
virtual int	GetMinimumHeight ()
virtual void	SetBarColor (double r, double g, double b)
virtual void	SetBarColor (double rgb[3])
virtual double *	GetBarColor ()
virtual void	GetBarColor (double data[3])
Static Public Member Functions
vtkKWProgressGauge *	New ()
Protected Member Functions
	vtkKWProgressGauge ()
	~vtkKWProgressGauge ()
virtual void	Redraw ()
Protected Attributes
int	Width
int	Height
int	MinimumHeight
double	BarColor [3]
double	Value
int	ExpandHeight
vtkKWCanvas *	Canvas

---

Detailed Description

a horizontal progress bar widget

A simple widget used for displaying a progress bar with a percent value text in the center of the widget.

Definition at line 28 of file vtkKWProgressGauge.h.

---

Constructor & Destructor Documentation

vtkKWProgressGauge::vtkKWProgressGauge (   )  [protected]

vtkKWProgressGauge::~vtkKWProgressGauge (   )  [protected]

---

Member Function Documentation

vtkKWProgressGauge* vtkKWProgressGauge::New (   )  [static]

Reimplemented from vtkKWCompositeWidget.

vtkKWProgressGauge::vtkTypeRevisionMacro (  vtkKWProgressGauge  , vtkKWCompositeWidget  )

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

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWProgressGauge::Create (  vtkKWApplication *  app  )  [virtual]

Create the widget. Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWProgressGauge::SetValue (  double  value  )  [virtual]

Set/Get the percentage displayed. This number is clamped to be betwen 0.0 and 100.0

virtual double vtkKWProgressGauge::GetValue (   )  [virtual]

Set/Get the percentage displayed. This number is clamped to be betwen 0.0 and 100.0

virtual void vtkKWProgressGauge::SetWidth (  int  width  )  [virtual]

Set/Get the width and height of the widget The height parameter is ignored is ExpandHeight is set. Reimplemented from vtkKWFrame.

virtual int vtkKWProgressGauge::GetWidth (   )  [virtual]

Set/Get the width and height of the widget The height parameter is ignored is ExpandHeight is set. Reimplemented from vtkKWFrame.

virtual void vtkKWProgressGauge::SetHeight (  int  height  )  [virtual]

Set/Get the width and height of the widget The height parameter is ignored is ExpandHeight is set. Reimplemented from vtkKWFrame.

virtual int vtkKWProgressGauge::GetHeight (   )  [virtual]

Set/Get the width and height of the widget The height parameter is ignored is ExpandHeight is set. Reimplemented from vtkKWFrame.

virtual void vtkKWProgressGauge::ExpandHeightOn (   )  [virtual]

Set/Get if the height of the gauge should be automatically adjusted to fill the available vertical space. The widget should be packed accordingly to expand automatically. Check MinimumHeight too.

virtual void vtkKWProgressGauge::ExpandHeightOff (   )  [virtual]

Set/Get if the height of the gauge should be automatically adjusted to fill the available vertical space. The widget should be packed accordingly to expand automatically. Check MinimumHeight too.

virtual void vtkKWProgressGauge::SetExpandHeight (  int   )  [virtual]

Set/Get if the height of the gauge should be automatically adjusted to fill the available vertical space. The widget should be packed accordingly to expand automatically. Check MinimumHeight too.

virtual int vtkKWProgressGauge::GetExpandHeight (   )  [virtual]

Set/Get if the height of the gauge should be automatically adjusted to fill the available vertical space. The widget should be packed accordingly to expand automatically. Check MinimumHeight too.

virtual void vtkKWProgressGauge::SetMinimumHeight (  int  height  )  [virtual]

Set/Get the minimum height of the widget This value is ignored if ExpandHeight is set to Off. If set to On, it will make sure that the height computed from the available vertical space is not smaller than this minimum height.

virtual int vtkKWProgressGauge::GetMinimumHeight (   )  [virtual]

Set/Get the minimum height of the widget This value is ignored if ExpandHeight is set to Off. If set to On, it will make sure that the height computed from the available vertical space is not smaller than this minimum height.

virtual void vtkKWProgressGauge::SetBarColor (  double  r, double  g, double  b )  [virtual]

Set the color of the progress bar, the default is blue.

virtual void vtkKWProgressGauge::SetBarColor (  double  rgb[3]  )  [inline, virtual]

Set the color of the progress bar, the default is blue. Definition at line 75 of file vtkKWProgressGauge.h.

virtual double* vtkKWProgressGauge::GetBarColor (   )  [virtual]

Set the color of the progress bar, the default is blue.

virtual void vtkKWProgressGauge::GetBarColor (  double  data[3]  )  [virtual]

Set the color of the progress bar, the default is blue.

virtual void vtkKWProgressGauge::ConfigureCallback (   )  [virtual]

Callbacks

virtual void vtkKWProgressGauge::Redraw (   )  [protected, virtual]

---

Member Data Documentation

int vtkKWProgressGauge::Width [protected]

Definition at line 89 of file vtkKWProgressGauge.h.

int vtkKWProgressGauge::Height [protected]

Definition at line 90 of file vtkKWProgressGauge.h.

int vtkKWProgressGauge::MinimumHeight [protected]

Definition at line 91 of file vtkKWProgressGauge.h.

double vtkKWProgressGauge::BarColor[3] [protected]

Definition at line 92 of file vtkKWProgressGauge.h.

double vtkKWProgressGauge::Value [protected]

Definition at line 93 of file vtkKWProgressGauge.h.

int vtkKWProgressGauge::ExpandHeight [protected]

Definition at line 94 of file vtkKWProgressGauge.h.

vtkKWCanvas* vtkKWProgressGauge::Canvas [protected]

Definition at line 96 of file vtkKWProgressGauge.h.

---

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

• GUI/Widgets/vtkKWProgressGauge.h

---