a horizontal progress bar widget More...
#include <vtkKWProgressGauge.h>
Public Types | |
| typedef vtkKWCompositeWidget | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | ConfigureCallback () |
Static Public Member Functions | |
| static vtkKWProgressGauge * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkKWProgressGauge * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkKWProgressGauge () | |
| ~vtkKWProgressGauge () | |
| virtual void | CreateWidget () |
| virtual void | Redraw () |
Protected Attributes | |
| int | Width |
| int | Height |
| int | MinimumHeight |
| double | BarColor [3] |
| double | Value |
| int | ExpandHeight |
| int | PrimaryGaugePosition |
| vtkKWCanvas * | Canvas |
| vtkKWProgressGaugeInternals * | Internals |
|
| |
| enum | { GaugePositionTop = 0, GaugePositionBottom } |
| virtual void | SetValue (double value) |
| virtual double | GetValue () |
| virtual void | SetNthValue (int rank, double value) |
| virtual double | GetNthValue (int rank) |
| 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]) |
| virtual void | SetPrimaryGaugePosition (int) |
| virtual int | GetPrimaryGaugePosition () |
| virtual void | SetPrimaryGaugePositionToTop () |
| virtual void | SetPrimaryGaugePositionToBottom () |
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 29 of file vtkKWProgressGauge.h.
Reimplemented from vtkKWCompositeWidget.
Definition at line 34 of file vtkKWProgressGauge.h.
| anonymous enum |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
Definition at line 99 of file vtkKWProgressGauge.h.
| vtkKWProgressGauge::vtkKWProgressGauge | ( | ) | [protected] |
| vtkKWProgressGauge::~vtkKWProgressGauge | ( | ) | [protected] |
| static vtkKWProgressGauge* vtkKWProgressGauge::New | ( | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual const char* vtkKWProgressGauge::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static int vtkKWProgressGauge::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual int vtkKWProgressGauge::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static vtkKWProgressGauge* vtkKWProgressGauge::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| void vtkKWProgressGauge::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| virtual void vtkKWProgressGauge::SetValue | ( | double | value | ) | [virtual] |
Set/Get the percentage displayed for the primary progress gauge. This number is clamped between 0.0 and 100.0. Note: setting the progress to zero resets the gauge to its nominal blank appearance.
| virtual double vtkKWProgressGauge::GetValue | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::SetNthValue | ( | int | rank, | |
| double | value | |||
| ) | [virtual] |
Set/Get the percentage displayed for the primary (ranked 0) and the secondary progress gauges. If rank = 0, calling this method is the same as calling the SetValue method. This number is clamped between 0.0 and 100.0. Note: setting the progress to zero resets the gauge to its nominal blank appearance. All progress gauges are stacked vertically on top of each other, with the lower rank at the top by default (this can be changed with the SetPrimaryGaugePosition method). Space for the primary gauge (ranked 0) is always allocated. It is not for secondary gauges which value is 0.0 unless a higher rank gauge is != 0.0.
| virtual double vtkKWProgressGauge::GetNthValue | ( | int | rank | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::SetWidth | ( | int | width | ) | [virtual] |
Set/Get the width and height of the widget. The height parameter is ignored if ExpandHeight is set to On.
Reimplemented from vtkKWFrame.
| virtual int vtkKWProgressGauge::GetWidth | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
Reimplemented from vtkKWFrame.
| virtual void vtkKWProgressGauge::SetHeight | ( | int | height | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
Reimplemented from vtkKWFrame.
| virtual int vtkKWProgressGauge::GetHeight | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
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 the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::SetExpandHeight | ( | int | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual int vtkKWProgressGauge::GetExpandHeight | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| 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, the height computed from the available vertical space will not be any smaller than this minimum height.
| virtual int vtkKWProgressGauge::GetMinimumHeight | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::SetBarColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
Set/Get the color of the progress bar, the default is blue.
| virtual void vtkKWProgressGauge::SetBarColor | ( | double | rgb[3] | ) | [inline, virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
Definition at line 90 of file vtkKWProgressGauge.h.
| virtual double* vtkKWProgressGauge::GetBarColor | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::GetBarColor | ( | double | data[3] | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::SetPrimaryGaugePosition | ( | int | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual int vtkKWProgressGauge::GetPrimaryGaugePosition | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::SetPrimaryGaugePositionToTop | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::SetPrimaryGaugePositionToBottom | ( | ) | [virtual] |
Set/Get the position of the primary gauge (rank 0). If on top, higher rank are stacked below. If at the bottom, higher rank are stacked on top. BTX
| virtual void vtkKWProgressGauge::ConfigureCallback | ( | ) | [virtual] |
Callbacks. Internal, do not use.
| virtual void vtkKWProgressGauge::CreateWidget | ( | ) | [protected, virtual] |
Create the widget.
Reimplemented from vtkKWCompositeWidget.
| virtual void vtkKWProgressGauge::Redraw | ( | ) | [protected, virtual] |
int vtkKWProgressGauge::Width [protected] |
Definition at line 125 of file vtkKWProgressGauge.h.
int vtkKWProgressGauge::Height [protected] |
Definition at line 126 of file vtkKWProgressGauge.h.
int vtkKWProgressGauge::MinimumHeight [protected] |
Definition at line 127 of file vtkKWProgressGauge.h.
double vtkKWProgressGauge::BarColor[3] [protected] |
Definition at line 128 of file vtkKWProgressGauge.h.
double vtkKWProgressGauge::Value [protected] |
Definition at line 129 of file vtkKWProgressGauge.h.
int vtkKWProgressGauge::ExpandHeight [protected] |
Definition at line 130 of file vtkKWProgressGauge.h.
int vtkKWProgressGauge::PrimaryGaugePosition [protected] |
Definition at line 131 of file vtkKWProgressGauge.h.
vtkKWCanvas* vtkKWProgressGauge::Canvas [protected] |
Definition at line 133 of file vtkKWProgressGauge.h.
vtkKWProgressGaugeInternals* vtkKWProgressGauge::Internals [protected] |
PIMPL Encapsulation for STL containers
Reimplemented from vtkKWCoreWidget.
Definition at line 137 of file vtkKWProgressGauge.h.
1.6.1
