vtkKWScaleWithEntry Class Reference

a scale widget with a label and entry More...

#include <vtkKWScaleWithEntry.h>

Inheritance diagram for vtkKWScaleWithEntry:

[legend]

Collaboration diagram for vtkKWScaleWithEntry:

[legend]

List of all members.

Public Types
typedef vtkKWScaleWithLabel	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetLabelText (const char *)
virtual void	SetLabelAndEntryPositionToTop ()
virtual void	SetBalloonHelpString (const char *str)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWScaleWithEntry *	New ()
static int	IsTypeOf (const char *type)
static vtkKWScaleWithEntry *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWScaleWithEntry ()
	~vtkKWScaleWithEntry ()
virtual void	CreateWidget ()
virtual void	InvokeEntryCommand (double value)
virtual void	Pack ()
virtual void	CreateEntry ()
Protected Attributes
int	PopupMode
int	RangeVisibility
char *	EntryCommand
int	EntryVisibility
int	EntryPosition
int	ExpandEntry
vtkKWTopLevel *	TopLevel
vtkKWPushButton *	PopupPushButton
vtkKWLabel *	RangeMinLabel
vtkKWLabel *	RangeMaxLabel

enum	{ EntryPositionDefault = 0, EntryPositionTop, EntryPositionBottom, EntryPositionLeft, EntryPositionRight }
virtual void	SetRange (double min, double max)
virtual void	SetRange (const double *range)
virtual double *	GetRange ()
virtual void	GetRange (double &min, double &max)
virtual void	GetRange (double range[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	SetClampValue (int)
virtual int	GetClampValue ()
virtual void	ClampValueOn ()
virtual void	ClampValueOff ()
virtual vtkKWScale *	GetScale ()
void	SetRangeVisibility (int flag)
virtual int	GetRangeVisibility ()
virtual void	RangeVisibilityOn ()
virtual void	RangeVisibilityOff ()
virtual void	SetEntryVisibility (int)
virtual void	EntryVisibilityOn ()
virtual void	EntryVisibilityOff ()
virtual int	GetEntryVisibility ()
virtual vtkKWEntry *	GetEntry ()
virtual int	HasEntry ()
virtual void	SetEntryWidth (int width)
virtual int	GetEntryWidth ()
virtual void	SetEntryPosition (int)
virtual int	GetEntryPosition ()
virtual void	SetEntryPositionToDefault ()
virtual void	SetEntryPositionToTop ()
virtual void	SetEntryPositionToBottom ()
virtual void	SetEntryPositionToLeft ()
virtual void	SetEntryPositionToRight ()
virtual void	SetPopupMode (int)
virtual int	GetPopupMode ()
virtual void	PopupModeOn ()
virtual void	PopupModeOff ()
virtual vtkKWPushButton *	GetPopupPushButton ()
virtual void	SetExpandEntry (int flag)
virtual int	GetExpandEntry ()
virtual void	ExpandEntryOn ()
virtual void	ExpandEntryOff ()
virtual void	SetOrientation (int)
virtual int	GetOrientation ()
virtual void	SetOrientationToHorizontal ()
virtual void	SetOrientationToVertical ()
virtual void	SetLength (int length)
virtual int	GetLength ()
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	SetEntryCommand (vtkObject object, const char method)
virtual void	SetDisableCommands (int)
virtual int	GetDisableCommands ()
virtual void	DisableCommandsOn ()
virtual void	DisableCommandsOff ()
virtual void	DisplayPopupModeCallback ()
virtual void	WithdrawPopupModeCallback ()
virtual void	EntryValueCallback (const char *value)
virtual void	ScaleValueCallback (double num)
virtual void	AddCallbackCommandObservers ()
virtual void	RemoveCallbackCommandObservers ()
void	Bind ()
void	UnBind ()
virtual void	UpdateValue ()
virtual void	SetEntryValue (double num)
virtual void	UpdateRange ()
virtual void	ProcessCallbackCommandEvents (vtkObject caller, unsigned long event, void calldata)

Detailed Description

a scale widget with a label and entry

A widget that represents a more complex scale (or slider) with options for positioning a label, displaying an entry, working in popup mode, etc. For a more lightweight widget, check vtkKWScale. The label position and visibility can be changed through the vtkKWWidgetWithLabel superclass methods (see SetLabelPosition). The default position for the label is on the left of the scale for horizontal scales, on the right (top corner) for vertical ones. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Both label and entry are visible by default. For convenience purposes, an empty label is not displayed though (make sure you use the SetLabelText method to set the label). In popup mode, a small button replaces the scale. Pressing that button will popup a scale the user can interact with, until it leaves the scale focus, which will withdraw the popup automatically. In that mode, the label and entry position are always displayed side by side, horizontally. Many of the vtkKWScale methods have been added to this API for convenience purposes, but GetScale() can be used to retrieve the internal vtkKWScale and access the rest of the API.

See also:: vtkKWScale vtkKWScaleWithLabel vtkKWWidgetWithLabel

Events:: vtkKWScale::ScaleValueChangedEvent

Definition at line 53 of file vtkKWScaleWithEntry.h.

Member Typedef Documentation

typedef vtkKWScaleWithLabel vtkKWScaleWithEntry::Superclass

Reimplemented from vtkKWScaleWithLabel.

Definition at line 58 of file vtkKWScaleWithEntry.h.

Member Enumeration Documentation

anonymous enum

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Enumerator:

EntryPositionDefault
EntryPositionTop
EntryPositionBottom
EntryPositionLeft
EntryPositionRight

Definition at line 158 of file vtkKWScaleWithEntry.h.

Constructor & Destructor Documentation

vtkKWScaleWithEntry::vtkKWScaleWithEntry ( ) [protected]

vtkKWScaleWithEntry::~vtkKWScaleWithEntry ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWScaleWithLabel.

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

Reimplemented from vtkKWScaleWithLabel.

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

Reimplemented from vtkKWScaleWithLabel.

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

Reimplemented from vtkKWScaleWithLabel.

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

Reimplemented from vtkKWScaleWithLabel.

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

Reimplemented from vtkKWScaleWithLabel.

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

Set the range for this scale.

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 64 of file vtkKWScaleWithEntry.h.

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::GetRange	(	double &	min,
		double &	max
	)			`[virtual]`

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::GetRange ( double range[2] ) [inline, virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 68 of file vtkKWScaleWithEntry.h.

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 70 of file vtkKWScaleWithEntry.h.

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 71 of file vtkKWScaleWithEntry.h.

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

Set/Get the value of the scale.

virtual double vtkKWScaleWithEntry::GetValue ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

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

Set/Get the resolution of the slider.

virtual double vtkKWScaleWithEntry::GetResolution ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::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 vtkKWScaleWithEntry::GetClampValue ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::ClampValueOn ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::ClampValueOff ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual vtkKWScale* vtkKWScaleWithEntry::GetScale ( ) [inline, virtual]

Get the internal vtkKWScale. Retrive that object to set the resolution, range, value, etc.

Definition at line 97 of file vtkKWScaleWithEntry.h.

void vtkKWScaleWithEntry::SetRangeVisibility ( int flag )

Set/Get whether to display the range of the scale. If the scale orientation is horizontal, the min is displayed on the left of the scale, the max range on the right. For vertical orientation, min is on top, max at the bottom. In popup mode, the range is displayed directly in the popup window using the same layout as above.

virtual int vtkKWScaleWithEntry::GetRangeVisibility ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::RangeVisibilityOn ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::RangeVisibilityOff ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetEntryVisibility ( int ) [virtual]

Set/Get the internal entry visibility (On by default). IMPORTANT: if you know you may not show the entry, try to set that flag as early as possible (ideally, before calling Create()) in order to lower the footprint of the widget: the entry will not be allocated and created if there is no need to show it. Later on, you can still use that option to show the entry: it will be allocated and created on the fly.

virtual void vtkKWScaleWithEntry::EntryVisibilityOn ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::EntryVisibilityOff ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual int vtkKWScaleWithEntry::GetEntryVisibility ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

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

Set the contents label. IMPORTANT: this method will create the label on the fly, use it only if you are confident that you will indeed display the label. Override the superclass so that the label is packed/unpacked if the text value is an empty string.

Reimplemented from vtkKWWidgetWithLabel.

virtual vtkKWEntry* vtkKWScaleWithEntry::GetEntry ( ) [virtual]

Get the internal entry. IMPORTANT: the internal entry is "lazy created", i.e. it is neither allocated nor created until GetEntry() is called. This allows for a lower footprint and faster UI startup. Therefore, do *not* use GetEntry() to check if the entry exists, as it will automatically allocate the entry. Use HasEntry() instead.

virtual int vtkKWScaleWithEntry::HasEntry ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetEntryWidth ( int width ) [virtual]

Set/Get the entry width. IMPORTANT: this method will create the entry on the fly, use it only if you are confident that you will indeed display the entry.

virtual int vtkKWScaleWithEntry::GetEntryWidth ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetEntryPosition ( int ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual int vtkKWScaleWithEntry::GetEntryPosition ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetEntryPositionToDefault ( ) [inline, virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 169 of file vtkKWScaleWithEntry.h.

virtual void vtkKWScaleWithEntry::SetEntryPositionToTop ( ) [inline, virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 171 of file vtkKWScaleWithEntry.h.

virtual void vtkKWScaleWithEntry::SetEntryPositionToBottom ( ) [inline, virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 173 of file vtkKWScaleWithEntry.h.

virtual void vtkKWScaleWithEntry::SetEntryPositionToLeft ( ) [inline, virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 175 of file vtkKWScaleWithEntry.h.

virtual void vtkKWScaleWithEntry::SetEntryPositionToRight ( ) [inline, virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Definition at line 177 of file vtkKWScaleWithEntry.h.

virtual void vtkKWScaleWithEntry::SetLabelAndEntryPositionToTop ( ) [virtual]

Set both the label and entry position to the top of the scale (label in the left corner, entry in the right corner)

virtual void vtkKWScaleWithEntry::SetPopupMode ( int ) [virtual]

Set/Get a popup scale. WARNING: must be set *before* Create() is called.

virtual int vtkKWScaleWithEntry::GetPopupMode ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::PopupModeOn ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::PopupModeOff ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual vtkKWPushButton* vtkKWScaleWithEntry::GetPopupPushButton ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetExpandEntry ( int flag ) [virtual]

Set/Get the entry expansion flag. This flag is only used if PopupMode mode is On. In that case, the default behaviour is to provide a widget as compact as possible, i.e. the Entry won't be expanded if the widget grows. Set ExpandEntry to On to override this behaviour.

virtual int vtkKWScaleWithEntry::GetExpandEntry ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::ExpandEntryOn ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::ExpandEntryOff ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::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 vtkKWScaleWithEntry::GetOrientation ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetOrientationToHorizontal ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetOrientationToVertical ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::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 vtkKWScaleWithEntry::GetLength ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::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). 'EntryCommand' is invoked when the widget value is changed using the text entry. 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. Note that the same events as vtkKWScale are generated, as a convenience. The following parameters are also passed to the command:

the current value: double

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetEntryCommand	(	vtkObject *	object,
		const char *	method
	)			`[virtual]`

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

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

Events. IMPORTANT: this widget is a composite widget that assembles both a vtkKWScale (which can be retrieved using GetScale()) and a (which can be retrieved using GetEntry()). Events are generated by both classes separately (see the corresponding class documentation). HOWEVER, for convenience purposes, an instance of vtkKWScaleWithEntry will emit (i.e. forward) the events that were sent by its internal vtkKWScale automatically, just as if they were sent by the instance itself. Therefore, you do not need to listen to the internal GetScale() or GetEntry() objects, but to the instance directly. Check the vtkKWScale documentation for the list of events. (for example, vtkKWScale::ScaleValueChangingEvent, vtkKWScale::ScaleValueChangedEvent, vtkKWScale::ScaleValueStartChangingEvent, etc).

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 vtkKWScaleWithEntry::GetDisableCommands ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::DisableCommandsOn ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::DisableCommandsOff ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::SetBalloonHelpString ( const char * str ) [virtual]

Setting this string enables balloon help for this widget. Override to pass down to children for cleaner behavior

Reimplemented from vtkKWScaleWithLabel.

virtual void vtkKWScaleWithEntry::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 vtkKWScaleWithLabel.

virtual void vtkKWScaleWithEntry::DisplayPopupModeCallback ( ) [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWScaleWithEntry::WithdrawPopupModeCallback ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::EntryValueCallback ( const char * value ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::AddCallbackCommandObservers ( ) [virtual]

Add all the default observers needed by that object, or remove all the observers that were added through AddCallbackCommandObserver. Subclasses can override these methods to add/remove their own default observers, but should call the superclass too.

Reimplemented from vtkKWObject.

virtual void vtkKWScaleWithEntry::RemoveCallbackCommandObservers ( ) [virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

Reimplemented from vtkKWObject.

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

Create the widget.

Reimplemented from vtkKWScaleWithLabel.

void vtkKWScaleWithEntry::Bind ( ) [protected]

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

void vtkKWScaleWithEntry::UnBind ( ) [protected]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::InvokeEntryCommand ( double value ) [protected, virtual]

virtual void vtkKWScaleWithEntry::Pack ( ) [protected, virtual]

Pack or repack the widget. To be implemented by subclasses.

Reimplemented from vtkKWScaleWithLabel.

virtual void vtkKWScaleWithEntry::CreateEntry ( ) [protected, virtual]

Create the entry

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

Update internal widgets value

virtual void vtkKWScaleWithEntry::SetEntryValue ( double num ) [protected, virtual]

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

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

If supported, set the entry position in regards to the rest of the composite widget. Check the subclass for more information about what the Default position is, and if specific positions are supported. The default position for the entry is on the right of the scale for horizontal scales, on the right (bottom corner) for vertical ones. Remember that the label position and visibility can also be changed through the vtkKWWidgetWithLabel superclass methods (SetLabelPosition). BTX

virtual void vtkKWScaleWithEntry::ProcessCallbackCommandEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	calldata
	)			`[protected, virtual]`

Processes the events that are passed through CallbackCommand (or others). Subclasses can oberride this method to process their own events, but should call the superclass too.

Reimplemented from vtkKWObject.