vtkKWScale Class Reference

a scale (slider) widget More...

#include <vtkKWScale.h>

Inheritance diagram for vtkKWScale:

[legend]Collaboration diagram for vtkKWScale:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWScale, vtkKWCoreWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	UpdateEnableState ()
virtual void	SetRange (double min, double max)
virtual void	SetRange (const double *range)
virtual double *	GetRange ()
virtual void	GetRange (double &, double &)
virtual void	GetRange (double[2])
virtual double	GetRangeMin ()
virtual double	GetRangeMax ()
virtual void	SetValue (double v)
virtual double	GetValue ()
virtual void	SetResolution (double r)
virtual double	GetResolution ()
virtual void	SetOrientation (int)
virtual int	GetOrientation ()
virtual void	SetOrientationToHorizontal ()
virtual void	SetOrientationToVertical ()
virtual void	GetTroughColor (double *r, double *g, double *b)
virtual double *	GetTroughColor ()
virtual void	SetTroughColor (double r, double g, double b)
virtual void	SetTroughColor (double rgb[3])
virtual void	SetWidth (int width)
virtual int	GetWidth ()
virtual void	SetLength (int length)
virtual int	GetLength ()
virtual void	SetSliderLength (int length)
virtual int	GetSliderLength ()
virtual void	SetValueVisibility (int)
virtual int	GetValueVisibility ()
virtual void	ValueVisibilityOn ()
virtual void	ValueVisibilityOff ()
virtual void	SetTickInterval (double val)
virtual double	GetTickInterval ()
virtual void	SetLabelText (const char *)
virtual const char *	GetLabelText ()
virtual void	SetCommand (vtkObject *object, const char *method)
virtual void	SetStartCommand (vtkObject *object, const char *method)
virtual void	SetEndCommand (vtkObject *object, const char *method)
virtual void	InvokeCommand ()
virtual void	InvokeStartCommand ()
virtual void	InvokeEndCommand ()
virtual void	SetDisableCommands (int)
virtual int	GetDisableCommands ()
virtual void	DisableCommandsOn ()
virtual void	DisableCommandsOff ()
virtual void	SetClampValue (int)
virtual int	GetClampValue ()
virtual void	ClampValueOn ()
virtual void	ClampValueOff ()
virtual int	GetDisableScaleValueCallback ()
virtual void	SetDisableScaleValueCallback (int)
virtual void	DisableScaleValueCallbackOn ()
virtual void	DisableScaleValueCallbackOff ()
virtual void	ScaleValueCallback (double num)
Static Public Member Functions
vtkKWScale *	New ()
Protected Member Functions
	vtkKWScale ()
	~vtkKWScale ()
void	Bind ()
void	UnBind ()
virtual void	UpdateRange ()
virtual void	UpdateResolution ()
virtual void	UpdateValue ()
virtual void	UpdateOrientation ()
Protected Attributes
int	DisableCommands
int	DisableScaleValueCallback
int	ClampValue
char *	Command
char *	StartCommand
char *	EndCommand
char *	EntryCommand
double	Value
double	Resolution
double	Range [2]
int	Orientation
Friends
class	vtkKWScaleWithEntry

---

Detailed Description

a scale (slider) widget

A widget that repsentes a scale (or slider).

See also:

vtkKWScaleWithEntry

Definition at line 33 of file vtkKWScale.h.

---

Constructor & Destructor Documentation

vtkKWScale::vtkKWScale (   )  [protected]

vtkKWScale::~vtkKWScale (   )  [protected]

---

Member Function Documentation

vtkKWScale* vtkKWScale::New (   )  [static]

Reimplemented from vtkKWCoreWidget.

vtkKWScale::vtkTypeRevisionMacro (  vtkKWScale  , vtkKWCoreWidget  )

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

Reimplemented from vtkKWCoreWidget.

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

Create the widget. Reimplemented from vtkKWCoreWidget.

virtual void vtkKWScale::SetRange (  double  min, double  max )  [virtual]

Set the range for this scale.

virtual void vtkKWScale::SetRange (  const double *  range  )  [inline, virtual]

Set the range for this scale. Definition at line 46 of file vtkKWScale.h.

virtual double* vtkKWScale::GetRange (   )  [virtual]

Set the range for this scale.

virtual void vtkKWScale::GetRange (  double &  , double &  )  [virtual]

Set the range for this scale.

virtual void vtkKWScale::GetRange (  double  [2]  )  [virtual]

Set the range for this scale.

virtual double vtkKWScale::GetRangeMin (   )  [inline, virtual]

Set the range for this scale. Definition at line 49 of file vtkKWScale.h.

virtual double vtkKWScale::GetRangeMax (   )  [inline, virtual]

Set the range for this scale. Definition at line 50 of file vtkKWScale.h.

virtual void vtkKWScale::SetValue (  double  v  )  [virtual]

Set/Get the value of the scale.

virtual double vtkKWScale::GetValue (   )  [virtual]

Set/Get the value of the scale.

virtual void vtkKWScale::SetResolution (  double  r  )  [virtual]

Method to set/get the resolution of the slider. The range or the value of the scale are not snapped to this resolution. The range and the value can be any floating point number. Think of the slider and the resolution as a way to set the value interactively using nice clean steps (power of 10 for example). The entry associated to the scale can be used to set the value to anything within the range, despite the resolution, allowing the user to enter a precise value that could not be reached given the resolution.

virtual double vtkKWScale::GetResolution (   )  [virtual]

Method to set/get the resolution of the slider. The range or the value of the scale are not snapped to this resolution. The range and the value can be any floating point number. Think of the slider and the resolution as a way to set the value interactively using nice clean steps (power of 10 for example). The entry associated to the scale can be used to set the value to anything within the range, despite the resolution, allowing the user to enter a precise value that could not be reached given the resolution.

virtual void vtkKWScale::SetOrientation (  int   )  [virtual]

Set/Get the orientation type. For widgets that can lay themselves out with either a horizontal or vertical orientation, such as scales, this option specifies which orientation should be used. Valid constants can be found in vtkKWTkOptions::OrientationType.

virtual int vtkKWScale::GetOrientation (   )  [virtual]

Set/Get the orientation type. For widgets that can lay themselves out with either a horizontal or vertical orientation, such as scales, this option specifies which orientation should be used. Valid constants can be found in vtkKWTkOptions::OrientationType.

virtual void vtkKWScale::SetOrientationToHorizontal (   )  [inline, virtual]

Set/Get the orientation type. For widgets that can lay themselves out with either a horizontal or vertical orientation, such as scales, this option specifies which orientation should be used. Valid constants can be found in vtkKWTkOptions::OrientationType. Definition at line 79 of file vtkKWScale.h.

virtual void vtkKWScale::SetOrientationToVertical (   )  [inline, virtual]

Set/Get the orientation type. For widgets that can lay themselves out with either a horizontal or vertical orientation, such as scales, this option specifies which orientation should be used. Valid constants can be found in vtkKWTkOptions::OrientationType. Definition at line 81 of file vtkKWScale.h.

virtual void vtkKWScale::GetTroughColor (  double *  r, double *  g, double *  b )  [virtual]

Set/Get the trough color, i.e. the color to use for the rectangular trough areas in widgets such as scrollbars and scales.

virtual double* vtkKWScale::GetTroughColor (   )  [virtual]

Set/Get the trough color, i.e. the color to use for the rectangular trough areas in widgets such as scrollbars and scales.

virtual void vtkKWScale::SetTroughColor (  double  r, double  g, double  b )  [virtual]

Set/Get the trough color, i.e. the color to use for the rectangular trough areas in widgets such as scrollbars and scales.

virtual void vtkKWScale::SetTroughColor (  double  rgb[3]  )  [inline, virtual]

Set/Get the trough color, i.e. the color to use for the rectangular trough areas in widgets such as scrollbars and scales. Definition at line 91 of file vtkKWScale.h.

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

Set/Get the narrow dimension of scale. For vertical scales this is the trough's width; for horizontal scales this is the trough's height. In pixel.

virtual int vtkKWScale::GetWidth (   )  [virtual]

Set/Get the narrow dimension of scale. For vertical scales this is the trough's width; for horizontal scales this is the trough's height. In pixel.

virtual void vtkKWScale::SetLength (  int  length  )  [virtual]

Set/Get the desired long dimension of the scale. For vertical scales this is the scale's height, for horizontal scales it is the scale's width. In pixel.

virtual int vtkKWScale::GetLength (   )  [virtual]

Set/Get the desired long dimension of the scale. For vertical scales this is the scale's height, for horizontal scales it is the scale's width. In pixel.

virtual void vtkKWScale::SetSliderLength (  int  length  )  [virtual]

Set/Get the size of the slider, measured in screen units along the slider's long dimension.

virtual int vtkKWScale::GetSliderLength (   )  [virtual]

Set/Get the size of the slider, measured in screen units along the slider's long dimension.

virtual void vtkKWScale::SetValueVisibility (  int   )  [virtual]

Set/Get the visibility of the value on top of the slider.

virtual int vtkKWScale::GetValueVisibility (   )  [virtual]

Set/Get the visibility of the value on top of the slider.

virtual void vtkKWScale::ValueVisibilityOn (   )  [virtual]

Set/Get the visibility of the value on top of the slider.

virtual void vtkKWScale::ValueVisibilityOff (   )  [virtual]

Set/Get the visibility of the value on top of the slider.

virtual void vtkKWScale::SetTickInterval (  double  val  )  [virtual]

Method to set/get the tick interval. Determines the spacing between numerical tick marks displayed below or to the left of the slider. If 0, no tick marks will be displayed.

virtual double vtkKWScale::GetTickInterval (   )  [virtual]

Method to set/get the tick interval. Determines the spacing between numerical tick marks displayed below or to the left of the slider. If 0, no tick marks will be displayed.

virtual void vtkKWScale::SetLabelText (  const char *   )  [virtual]

Set/Get the sting to display as a label for the scale. For vertical scales the label is displayed just to the right of the top end of the scale. For horizontal scales the label is displayed just above the left end of the scale. If the option is specified as an empty string, no label is displayed. The position of the label can not be changed. For more elaborated options, check vtkKWScaleWithEntry

virtual const char* vtkKWScale::GetLabelText (   )  [virtual]

Set/Get the sting to display as a label for the scale. For vertical scales the label is displayed just to the right of the top end of the scale. For horizontal scales the label is displayed just above the left end of the scale. If the option is specified as an empty string, no label is displayed. The position of the label can not be changed. For more elaborated options, check vtkKWScaleWithEntry

virtual void vtkKWScale::SetCommand (  vtkObject *  object, const char *  method )  [virtual]

Specifies commands to associate with the widget. The first argument is the object that will have the method called on it. The second argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is evaluated as a simple command.

virtual void vtkKWScale::SetStartCommand (  vtkObject *  object, const char *  method )  [virtual]

Specifies commands to associate with the widget. The first argument is the object that will have the method called on it. The second argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is evaluated as a simple command.

virtual void vtkKWScale::SetEndCommand (  vtkObject *  object, const char *  method )  [virtual]

Specifies commands to associate with the widget. The first argument is the object that will have the method called on it. The second argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is evaluated as a simple command.

virtual void vtkKWScale::InvokeCommand (   )  [virtual]

Specifies commands to associate with the widget. The first argument is the object that will have the method called on it. The second argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is evaluated as a simple command.

virtual void vtkKWScale::InvokeStartCommand (   )  [virtual]

Specifies commands to associate with the widget. The first argument is the object that will have the method called on it. The second argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is evaluated as a simple command.

virtual void vtkKWScale::InvokeEndCommand (   )  [virtual]

Specifies commands to associate with the widget. The first argument is the object that will have the method called on it. The second argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is evaluated as a simple command.

virtual void vtkKWScale::SetDisableCommands (  int   )  [virtual]

Set/get whether the above commands should be called or not. This make it easier to disable the commands while setting the scale value for example.

virtual int vtkKWScale::GetDisableCommands (   )  [virtual]

Set/get whether the above commands should be called or not. This make it easier to disable the commands while setting the scale value for example.

virtual void vtkKWScale::DisableCommandsOn (   )  [virtual]

Set/get whether the above commands should be called or not. This make it easier to disable the commands while setting the scale value for example.

virtual void vtkKWScale::DisableCommandsOff (   )  [virtual]

Set/get whether the above commands should be called or not. This make it easier to disable the commands while setting the scale value for example.

virtual void vtkKWScale::UpdateEnableState (   )  [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc. Reimplemented from vtkKWWidget.

virtual void vtkKWScale::SetClampValue (  int   )  [virtual]

Turn on/off the automatic clamping of the end values when the user types a value beyond the range. Default is on.

virtual int vtkKWScale::GetClampValue (   )  [virtual]

Turn on/off the automatic clamping of the end values when the user types a value beyond the range. Default is on.

virtual void vtkKWScale::ClampValueOn (   )  [virtual]

Turn on/off the automatic clamping of the end values when the user types a value beyond the range. Default is on.

virtual void vtkKWScale::ClampValueOff (   )  [virtual]

Turn on/off the automatic clamping of the end values when the user types a value beyond the range. Default is on.

virtual int vtkKWScale::GetDisableScaleValueCallback (   )  [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWScale::SetDisableScaleValueCallback (  int   )  [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWScale::DisableScaleValueCallbackOn (   )  [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWScale::DisableScaleValueCallbackOff (   )  [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWScale::ScaleValueCallback (  double  num  )  [virtual]

Callbacks. Internal, do not use.

void vtkKWScale::Bind (   )  [protected]

Bind/Unbind all components so that values can be changed, but no command will be called.

void vtkKWScale::UnBind (   )  [protected]

Bind/Unbind all components so that values can be changed, but no command will be called.

virtual void vtkKWScale::UpdateRange (   )  [protected, virtual]

Update internal widgets value

virtual void vtkKWScale::UpdateResolution (   )  [protected, virtual]

Update internal widgets value

virtual void vtkKWScale::UpdateValue (   )  [protected, virtual]

Update internal widgets value

virtual void vtkKWScale::UpdateOrientation (   )  [protected, virtual]

Update internal widgets value

---

Friends And Related Function Documentation

friend class vtkKWScaleWithEntry [friend]

Definition at line 226 of file vtkKWScale.h.

---

Member Data Documentation

int vtkKWScale::DisableCommands [protected]

Definition at line 202 of file vtkKWScale.h.

int vtkKWScale::DisableScaleValueCallback [protected]

Definition at line 203 of file vtkKWScale.h.

int vtkKWScale::ClampValue [protected]

Definition at line 204 of file vtkKWScale.h.

char* vtkKWScale::Command [protected]

Definition at line 206 of file vtkKWScale.h.

char* vtkKWScale::StartCommand [protected]

Definition at line 207 of file vtkKWScale.h.

char* vtkKWScale::EndCommand [protected]

Definition at line 208 of file vtkKWScale.h.

char* vtkKWScale::EntryCommand [protected]

Definition at line 209 of file vtkKWScale.h.

double vtkKWScale::Value [protected]

Definition at line 211 of file vtkKWScale.h.

double vtkKWScale::Resolution [protected]

Definition at line 212 of file vtkKWScale.h.

double vtkKWScale::Range[2] [protected]

Definition at line 213 of file vtkKWScale.h.

int vtkKWScale::Orientation [protected]

Definition at line 215 of file vtkKWScale.h.

---

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

• GUI/Widgets/vtkKWScale.h

---