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 Types
typedef vtkKWCoreWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWScale *	New ()
static int	IsTypeOf (const char *type)
static vtkKWScale *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWScale ()
	~vtkKWScale ()
virtual void	CreateWidget ()
virtual void	InvokeScaleCommand (const char *command, double value)
virtual void	InvokeCommand (double value)
virtual void	InvokeStartCommand (double value)
virtual void	InvokeEndCommand (double value)
Protected Attributes
int	DisableScaleValueCallback
int	ClampValue
double	Value
double	Resolution
double	Range [2]
int	Orientation
int	DisableCommands
char *	Command
char *	StartCommand
char *	EndCommand
Friends
class	vtkKWScaleWithEntry

enum	{ ScaleValueChangingEvent = 10000, ScaleValueChangedEvent, ScaleValueStartChangingEvent }
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	GetBackgroundColor (double r, double g, double *b)
virtual double *	GetBackgroundColor ()
virtual void	SetBackgroundColor (double r, double g, double b)
virtual void	SetBackgroundColor (double rgb[3])
virtual void	GetForegroundColor (double r, double g, double *b)
virtual double *	GetForegroundColor ()
virtual void	SetForegroundColor (double r, double g, double b)
virtual void	SetForegroundColor (double rgb[3])
virtual void	SetHighlightThickness (int)
virtual int	GetHighlightThickness ()
virtual void	GetActiveBackgroundColor (double r, double g, double *b)
virtual double *	GetActiveBackgroundColor ()
virtual void	SetActiveBackgroundColor (double r, double g, double b)
virtual void	SetActiveBackgroundColor (double rgb[3])
virtual void	SetBorderWidth (int)
virtual int	GetBorderWidth ()
virtual void	SetRelief (int)
virtual int	GetRelief ()
virtual void	SetReliefToRaised ()
virtual void	SetReliefToSunken ()
virtual void	SetReliefToFlat ()
virtual void	SetReliefToRidge ()
virtual void	SetReliefToSolid ()
virtual void	SetReliefToGroove ()
virtual void	SetFont (const char *font)
virtual const char *	GetFont ()
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	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)
virtual void	ButtonPressCallback ()
virtual void	ButtonReleaseCallback ()
void	Bind ()
void	UnBind ()
virtual void	UpdateRange ()
virtual void	UpdateResolution ()
virtual void	UpdateValue ()
virtual void	UpdateOrientation ()

Detailed Description

a scale (slider) widget

A widget that repsentes a scale (or slider).

See also:: vtkKWScaleWithEntry

Events:: vtkKWScale::ScaleValueChangingEvent vtkKWScale::ScaleValueStartChangingEvent vtkKWScale::ScaleValueChangedEvent

Definition at line 35 of file vtkKWScale.h.

Member Typedef Documentation

typedef vtkKWCoreWidget vtkKWScale::Superclass

Reimplemented from vtkKWCoreWidget.

Definition at line 40 of file vtkKWScale.h.

Member Enumeration Documentation

anonymous enum

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

Enumerator:

ScaleValueChangingEvent
ScaleValueChangedEvent
ScaleValueStartChangingEvent

Definition at line 264 of file vtkKWScale.h.

Constructor & Destructor Documentation

vtkKWScale::vtkKWScale ( ) [protected]

vtkKWScale::~vtkKWScale ( ) [protected]

Member Function Documentation

static vtkKWScale* vtkKWScale::New ( ) [static]

Reimplemented from vtkKWCoreWidget.

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

Reimplemented from vtkKWCoreWidget.

static int vtkKWScale::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWCoreWidget.

virtual int vtkKWScale::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWCoreWidget.

static vtkKWScale* vtkKWScale::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWCoreWidget.

void vtkKWScale::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

Definition at line 46 of file vtkKWScale.h.

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

Definition at line 49 of file vtkKWScale.h.

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Set/Get the background color of the widget.

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

Definition at line 77 of file vtkKWScale.h.

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

Set/Get the foreground color of the widget.

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

Definition at line 86 of file vtkKWScale.h.

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

Set/Get the highlight thickness, a non-negative value indicating the width of the highlight rectangle to draw around the outside of the widget when it has the input focus.

virtual int vtkKWScale::GetHighlightThickness ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Set/Get the active background color of the widget. An element (a widget or portion of a widget) is active if the mouse cursor is positioned over the element and pressing a mouse button will cause some action to occur.

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

Definition at line 106 of file vtkKWScale.h.

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

Set/Get the border width, a non-negative value indicating the width of the 3-D border to draw around the outside of the widget (if such a border is being drawn; the Relief option typically determines this).

virtual int vtkKWScale::GetBorderWidth ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Set/Get the 3-D effect desired for the widget. The value indicates how the interior of the widget should appear relative to its exterior. Valid constants can be found in vtkKWOptions::ReliefType.

virtual int vtkKWScale::GetRelief ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetReliefToRaised ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetReliefToSunken ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetReliefToFlat ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetReliefToRidge ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetReliefToSolid ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetReliefToGroove ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetFont ( const char * font ) [virtual]

Specifies the font to use when drawing text inside the widget. You can use predefined font names (e.g. 'system'), or you can specify a set of font attributes with a platform-independent name, for example, 'times 12 bold'. In this example, the font is specified with a three element list: the first element is the font family, the second is the size, the third is a list of style parameters (normal, bold, roman, italic, underline, overstrike). Example: 'times 12 {bold italic}'. The Times, Courier and Helvetica font families are guaranteed to exist and will be matched to the corresponding (closest) font on your system. If you are familiar with the X font names specification, you can also describe the font that way (say, '*times-medium-r-*-*-12*').

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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 vtkKWOptions::OrientationType.

virtual int vtkKWScale::GetOrientation ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetOrientationToHorizontal ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::SetOrientationToVertical ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

Definition at line 165 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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

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

virtual int vtkKWScale::GetValueVisibility ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::ValueVisibilityOn ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::ValueVisibilityOff ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Set/Get the string 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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Specifies commands to associate with the widget. 'Command' is invoked when the widget value is changing (i.e. during user interaction). 'StartCommand' is invoked at the beginning of a user interaction with the widget (when a mouse button is pressed over the widget for example). 'EndCommand' is invoked at the end of the user interaction with the widget (when the mouse button is released for example). The need for a 'Command', 'StartCommand' and 'EndCommand' can be explained as follows: 'EndCommand' can be used to be notified about any changes made to this widget *after* the corresponding user interaction has been performed (say, after releasing the mouse button that was dragging a slider, or after clicking on a checkbutton). 'Command' can be set *additionally* to be notified about the intermediate changes that occur *during* the corresponding user interaction (say, *while* dragging a slider). While setting 'EndCommand' is enough to be notified about any changes, setting 'Command' is an application-specific choice that is likely to depend on how fast you want (or can) answer to rapid changes occuring during a user interaction, if any. 'StartCommand' is rarely used but provides an opportunity for the application to modify its state and prepare itself for user-interaction; in that case, the 'EndCommand' is usually set in a symmetric fashion to set the application back to its previous state. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the command: - the current value: int (if Resolution is integer); double otherwise Note: the 'int' signature is for convenience, so that the command can be set to a callback accepting 'int'. In doubt, implement the callback using a 'double' signature that will accept both 'int' and 'double'.

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::DisableCommandsOn ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::DisableCommandsOff ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::ClampValueOn ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::ClampValueOff ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual int vtkKWScale::GetDisableScaleValueCallback ( ) [virtual]

Callbacks. Internal, do not use.

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::DisableScaleValueCallbackOn ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::DisableScaleValueCallbackOff ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::ButtonPressCallback ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

virtual void vtkKWScale::ButtonReleaseCallback ( ) [virtual]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Create the widget.

Reimplemented from vtkKWCoreWidget.

void vtkKWScale::Bind ( ) [protected]

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

void vtkKWScale::UnBind ( ) [protected]

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Update internal widgets value

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX

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

Events. The ScaleValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's slider), the ScaleValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ScaleValueChangedEvent is invoked at the end of an interaction with the widget. They are similar in concept as the 'Command', 'StartCommand', and 'EndCommand' callbacks but can be used by multiple listeners/observers at a time. The following parameters are also passed as client data: - the current value: double BTX