vtkKWThumbWheel Class Reference

a thumbwheel widget More...

#include <vtkKWThumbWheel.h>

Inheritance diagram for vtkKWThumbWheel:
Inheritance graph
[legend]
Collaboration diagram for vtkKWThumbWheel:
Collaboration graph
[legend]

List of all members.

Classes

class  LinearMotionState
class  NonLinearMotionState

Public Types

typedef vtkKWCompositeWidget Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetBalloonHelpString (const char *str)
virtual void UpdateEnableState ()

Static Public Member Functions

static vtkKWThumbWheelNew ()
static int IsTypeOf (const char *type)
static vtkKWThumbWheelSafeDownCast (vtkObject *o)

Protected Types

enum  WidgetState { Idle, InMotion }

Protected Member Functions

 vtkKWThumbWheel ()
 ~vtkKWThumbWheel ()
virtual void CreateWidget ()
virtual void InvokeThumbWheelCommand (const char *command, double value)
virtual void InvokeCommand (double value)
virtual void InvokeStartCommand (double value)
virtual void InvokeEndCommand (double value)
virtual void InvokeEntryCommand (double value)
void CreateEntry ()
void CreateLabel ()
void UpdateThumbWheelImage (double pos=-1.0)
void PackWidget ()
double GetMousePositionInThumbWheel ()
void RefreshValue ()

Protected Attributes

double Value
double MinimumValue
int ClampMinimumValue
double MaximumValue
int ClampMaximumValue
double Resolution
int ClampResolution
double NonLinearMaximumMultiplier
double LinearThreshold
int ThumbWheelWidth
int ThumbWheelHeight
double SizeOfNotches
double ThumbWheelPositionIndicatorColor [3]
int ResizeThumbWheel
int DisplayLabel
int DisplayEntry
int DisplayEntryAndLabelOnTop
int DisplayThumbWheelPositionIndicator
int DisplayThumbWheelCenterIndicator
int PopupMode
int ExpandEntry
char * Command
char * StartCommand
char * EndCommand
char * EntryCommand
double ThumbWheelShift
int InteractionModes [3]
vtkKWLabelThumbWheel
vtkKWEntryEntry
vtkKWLabelLabel
vtkKWTopLevelTopLevel
vtkKWPushButtonPopupPushButton
int State
LinearMotionState StartLinearMotionState
NonLinearMotionState StartNonLinearMotionState
int InInvokeCommand



enum  { InteractionModeNone = 0, InteractionModeLinearMotion, InteractionModeNonLinearMotion, InteractionModeToggleCenterIndicator }
enum  { ThumbWheelValueChangingEvent = 10000, ThumbWheelValueChangedEvent, ThumbWheelValueStartChangingEvent }
virtual void SetValue (double v)
virtual double GetValue ()
virtual void SetMinimumValue (double)
virtual double GetMinimumValue ()
virtual void SetClampMinimumValue (int)
virtual int GetClampMinimumValue ()
virtual void ClampMinimumValueOn ()
virtual void ClampMinimumValueOff ()
virtual void SetMaximumValue (double)
virtual double GetMaximumValue ()
virtual void SetClampMaximumValue (int)
virtual int GetClampMaximumValue ()
virtual void ClampMaximumValueOn ()
virtual void ClampMaximumValueOff ()
virtual void SetRange (double min, double max)
virtual void SetRange (const double *range)
virtual void SetResolution (double r)
virtual double GetResolution ()
virtual void SetClampResolution (int)
virtual int GetClampResolution ()
virtual void ClampResolutionOn ()
virtual void ClampResolutionOff ()
virtual void SetInteractionMode (int mode, int v)
virtual int GetInteractionMode (int mode)
virtual void SetInteractionModeToNone (int mode)
virtual void SetInteractionModeToLinear (int mode)
virtual void SetInteractionModeToNonLinear (int mode)
virtual void SetInteractionModeToToggleCenterIndicator (int mode)
virtual char * GetInteractionModeAsString (int mode)
virtual void SetLinearThreshold (double)
virtual double GetLinearThreshold ()
virtual void SetNonLinearMaximumMultiplier (double)
virtual double GetNonLinearMaximumMultiplier ()
virtual void SetThumbWheelWidth (int v)
virtual int GetThumbWheelWidth ()
virtual void SetThumbWheelHeight (int v)
virtual int GetThumbWheelHeight ()
virtual void SetThumbWheelSize (int w, int h)
virtual void SetLength (int v)
virtual void SetResizeThumbWheel (int flag)
virtual int GetResizeThumbWheel ()
virtual void ResizeThumbWheelOn ()
virtual void ResizeThumbWheelOff ()
virtual void SetDisplayThumbWheelPositionIndicator (int)
virtual int GetDisplayThumbWheelPositionIndicator ()
virtual void DisplayThumbWheelPositionIndicatorOn ()
virtual void DisplayThumbWheelPositionIndicatorOff ()
virtual void SetThumbWheelPositionIndicatorColor (double, double, double)
virtual void SetThumbWheelPositionIndicatorColor (double[3])
virtual double * GetThumbWheelPositionIndicatorColor ()
virtual void GetThumbWheelPositionIndicatorColor (double data[3])
virtual void SetDisplayThumbWheelCenterIndicator (int flag)
virtual int GetDisplayThumbWheelCenterIndicator ()
virtual void DisplayThumbWheelCenterIndicatorOn ()
virtual void DisplayThumbWheelCenterIndicatorOff ()
virtual void ToggleDisplayThumbWheelCenterIndicator ()
virtual void SetSizeOfNotches (double v)
virtual double GetSizeOfNotches ()
virtual void SetDisplayEntry (int flag)
virtual int GetDisplayEntry ()
virtual void DisplayEntryOn ()
virtual void DisplayEntryOff ()
virtual vtkKWEntryGetEntry ()
virtual void SetDisplayLabel (int flag)
virtual int GetDisplayLabel ()
virtual void DisplayLabelOn ()
virtual void DisplayLabelOff ()
virtual vtkKWLabelGetLabel ()
virtual void SetDisplayEntryAndLabelOnTop (int flag)
virtual int GetDisplayEntryAndLabelOnTop ()
virtual void DisplayEntryAndLabelOnTopOn ()
virtual void DisplayEntryAndLabelOnTopOff ()
virtual void SetPopupMode (int)
virtual int GetPopupMode ()
virtual void PopupModeOn ()
virtual void PopupModeOff ()
virtual vtkKWPushButtonGetPopupPushButton ()
virtual void SetExpandEntry (int flag)
virtual int GetExpandEntry ()
virtual void ExpandEntryOn ()
virtual void ExpandEntryOff ()
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)
void Bind ()
void UnBind ()
virtual void ResizeThumbWheelCallback ()
virtual void DisplayPopupCallback ()
virtual void WithdrawPopupCallback ()
virtual void EntryValueCallback (const char *)
virtual void StartLinearMotionCallback ()
virtual void PerformLinearMotionCallback ()
virtual void StartNonLinearMotionCallback ()
virtual void PerformNonLinearMotionCallback ()
virtual void StopMotionCallback ()

Detailed Description

a thumbwheel widget

A widget that repsentes a thumbwheel widget with options for a label string and a text entry box.

Events:
vtkKWThumbWheel::ThumbWheelValueChangedEvent vtkKWThumbWheel::ThumbWheelValueStartChangingEvent vtkKWThumbWheel::ThumbWheelValueChangingEvent

Definition at line 34 of file vtkKWThumbWheel.h.


Member Typedef Documentation

Reimplemented from vtkKWCompositeWidget.

Definition at line 39 of file vtkKWThumbWheel.h.


Member Enumeration Documentation

anonymous enum

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Enumerator:
InteractionModeNone 
InteractionModeLinearMotion 
InteractionModeNonLinearMotion 
InteractionModeToggleCenterIndicator 

Definition at line 94 of file vtkKWThumbWheel.h.

anonymous enum

Events. The ThumbWheelValueChangingEvent is triggered when the widget value is changed (i.e., during user interaction on the widget's thumbhweel), the ThumbWheelValueStartChangingEvent is invoked at the beginning of an interaction with the widget, the ThumbWheelValueChangedEvent 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:
ThumbWheelValueChangingEvent 
ThumbWheelValueChangedEvent 
ThumbWheelValueStartChangingEvent 

Definition at line 281 of file vtkKWThumbWheel.h.

enum vtkKWThumbWheel::WidgetState [protected]
Enumerator:
Idle 
InMotion 

Definition at line 385 of file vtkKWThumbWheel.h.


Constructor & Destructor Documentation

vtkKWThumbWheel::vtkKWThumbWheel (  )  [protected]
vtkKWThumbWheel::~vtkKWThumbWheel (  )  [protected]

Member Function Documentation

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Reimplemented from vtkKWCompositeWidget.

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

Set/Get the value of the thumbwheel.

virtual double vtkKWThumbWheel::GetValue (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetMinimumValue ( double   )  [virtual]

Set/Get the minimum value. The current value will be clamped only if ClampMinimumValue is true.

virtual double vtkKWThumbWheel::GetMinimumValue (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetClampMinimumValue ( int   )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual int vtkKWThumbWheel::GetClampMinimumValue (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ClampMinimumValueOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ClampMinimumValueOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetMaximumValue ( double   )  [virtual]

Set/Get the maximum value. The current value will be clamped only if ClampMaximumValue is true.

virtual double vtkKWThumbWheel::GetMaximumValue (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetClampMaximumValue ( int   )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual int vtkKWThumbWheel::GetClampMaximumValue (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ClampMaximumValueOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ClampMaximumValueOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Set the range.

Definition at line 70 of file vtkKWThumbWheel.h.

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

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Definition at line 72 of file vtkKWThumbWheel.h.

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

Set/Get the resolution of the thumbwheel. Moving the thumbwheel will increase/decrease the value by an amount proportional to this resolution. If the Clamp option is set, then the value will always be an integer number of increments of Resolution offset from the MinimumValue; for example, if the MinimumValue is -0.5 and the MaximumValue is 1.0 and the Resolution is set to .75, then Value can only be -0.5, 0.25, or 1.0.

virtual double vtkKWThumbWheel::GetResolution (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetClampResolution ( int   )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual int vtkKWThumbWheel::GetClampResolution (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ClampResolutionOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ClampResolutionOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetInteractionMode ( int  mode,
int  v 
) [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual int vtkKWThumbWheel::GetInteractionMode ( int  mode  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetInteractionModeToNone ( int  mode  )  [inline, virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Definition at line 104 of file vtkKWThumbWheel.h.

virtual void vtkKWThumbWheel::SetInteractionModeToLinear ( int  mode  )  [inline, virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Definition at line 107 of file vtkKWThumbWheel.h.

virtual void vtkKWThumbWheel::SetInteractionModeToNonLinear ( int  mode  )  [inline, virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Definition at line 110 of file vtkKWThumbWheel.h.

virtual void vtkKWThumbWheel::SetInteractionModeToToggleCenterIndicator ( int  mode  )  [inline, virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Definition at line 113 of file vtkKWThumbWheel.h.

virtual char* vtkKWThumbWheel::GetInteractionModeAsString ( int  mode  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetLinearThreshold ( double   )  [virtual]

Set/Get the % of the thumbwheel's current width that must be "travelled" by the mouse so that the value is increased/decreased by one resolution unit (Resolution ivar). Linear mode only. Example: if the threshold is 0.1, the current width is 100 pixels and the resolution is 2, then the mouse must be moved 10 pixels to "the right" to add 2 to the current value. If set to 0, a reasonable value will be picked computed from the whole range and the resolution.

virtual double vtkKWThumbWheel::GetLinearThreshold (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetNonLinearMaximumMultiplier ( double   )  [virtual]

Set/Get the maximum multiplier in non-linear mode. This bounds the scaling factor applied to the resolution when the thumbwheel is reaching its maximum left or right position.

virtual double vtkKWThumbWheel::GetNonLinearMaximumMultiplier (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetThumbWheelWidth ( int  v  )  [virtual]

Set/Get the width and height of the thumbwheel. Can't be smaller than 5x5.

virtual int vtkKWThumbWheel::GetThumbWheelWidth (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetThumbWheelHeight ( int  v  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual int vtkKWThumbWheel::GetThumbWheelHeight (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetThumbWheelSize ( int  w,
int  h 
) [inline, virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Definition at line 146 of file vtkKWThumbWheel.h.

virtual void vtkKWThumbWheel::SetLength ( int  v  )  [inline, virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

Definition at line 148 of file vtkKWThumbWheel.h.

virtual void vtkKWThumbWheel::SetResizeThumbWheel ( int  flag  )  [virtual]

Enable/Disable automatic thumbwheel resizing. Turn it off if you want a specific thumbwheel size, otherwise it will resize when its parent widget expands. Note that the ThumbWheelWidth and ThumbWheelHeight ivars are updated accordingly automatically.

virtual int vtkKWThumbWheel::GetResizeThumbWheel (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ResizeThumbWheelOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ResizeThumbWheelOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetDisplayThumbWheelPositionIndicator ( int   )  [virtual]

Display/Hide a thumbwheel position indicator when the user performs a motion. This is just a vertical colored bar following the mouse position. Set/Get the indicator color.

virtual int vtkKWThumbWheel::GetDisplayThumbWheelPositionIndicator (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayThumbWheelPositionIndicatorOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayThumbWheelPositionIndicatorOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetThumbWheelPositionIndicatorColor ( double  ,
double  ,
double   
) [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetThumbWheelPositionIndicatorColor ( double  [3]  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual double* vtkKWThumbWheel::GetThumbWheelPositionIndicatorColor (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::GetThumbWheelPositionIndicatorColor ( double  data[3]  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetDisplayThumbWheelCenterIndicator ( int  flag  )  [virtual]

Display/Hide a centrer indicator so that the user can easily find the positive and negative part of the range.

virtual int vtkKWThumbWheel::GetDisplayThumbWheelCenterIndicator (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayThumbWheelCenterIndicatorOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayThumbWheelCenterIndicatorOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ToggleDisplayThumbWheelCenterIndicator (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetSizeOfNotches ( double  v  )  [virtual]

Set/Get the average size (in pixels) of the notches on the visible part of the thumbwheel. Can be a decimal value, since it's only used to compute the number of notches to display depending on the current thumbwheel size.

virtual double vtkKWThumbWheel::GetSizeOfNotches (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetDisplayEntry ( int  flag  )  [virtual]

Display/Hide an entry field (optional).

virtual int vtkKWThumbWheel::GetDisplayEntry (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayEntryOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayEntryOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetDisplayLabel ( int  flag  )  [virtual]

Display/Hide/Set a label (optional).

virtual int vtkKWThumbWheel::GetDisplayLabel (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayLabelOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayLabelOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual vtkKWLabel* vtkKWThumbWheel::GetLabel (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::SetDisplayEntryAndLabelOnTop ( int  flag  )  [virtual]

Set/Get the position of the label and/or entry (on top, or on the side).

virtual int vtkKWThumbWheel::GetDisplayEntryAndLabelOnTop (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayEntryAndLabelOnTopOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::DisplayEntryAndLabelOnTopOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Set/Get the popup mode. WARNING: this mode must be set *before* Create() is called.

virtual int vtkKWThumbWheel::GetPopupMode (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::PopupModeOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::PopupModeOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Set/Get the entry expansion flag. This flag is only used if PopupMode 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 vtkKWThumbWheel::GetExpandEntry (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ExpandEntryOn (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::ExpandEntryOff (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::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. 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 vtkKWThumbWheel::SetStartCommand ( vtkObject object,
const char *  method 
) [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::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 vtkKWWidget.

void vtkKWThumbWheel::Bind (  ) 

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

void vtkKWThumbWheel::UnBind (  ) 

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::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 vtkKWThumbWheel::ResizeThumbWheelCallback (  )  [virtual]

Callbacks. Internal, do not use.

virtual void vtkKWThumbWheel::DisplayPopupCallback (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::WithdrawPopupCallback (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::EntryValueCallback ( const char *   )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::StartLinearMotionCallback (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::PerformLinearMotionCallback (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::StartNonLinearMotionCallback (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::PerformNonLinearMotionCallback (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

virtual void vtkKWThumbWheel::StopMotionCallback (  )  [virtual]

Set the interaction modes (mode 0 is left button, 1 is middle, 2 is right). Note: set it before setting the balloon help string. BTX

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

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWThumbWheel::InvokeThumbWheelCommand ( const char *  command,
double  value 
) [protected, virtual]
virtual void vtkKWThumbWheel::InvokeCommand ( double  value  )  [protected, virtual]
virtual void vtkKWThumbWheel::InvokeStartCommand ( double  value  )  [protected, virtual]
virtual void vtkKWThumbWheel::InvokeEndCommand ( double  value  )  [protected, virtual]
virtual void vtkKWThumbWheel::InvokeEntryCommand ( double  value  )  [protected, virtual]
void vtkKWThumbWheel::CreateEntry (  )  [protected]
void vtkKWThumbWheel::CreateLabel (  )  [protected]
void vtkKWThumbWheel::UpdateThumbWheelImage ( double  pos = -1.0  )  [protected]
void vtkKWThumbWheel::PackWidget (  )  [protected]
double vtkKWThumbWheel::GetMousePositionInThumbWheel (  )  [protected]
void vtkKWThumbWheel::RefreshValue (  )  [protected]

Member Data Documentation

double vtkKWThumbWheel::Value [protected]

Definition at line 331 of file vtkKWThumbWheel.h.

double vtkKWThumbWheel::MinimumValue [protected]

Definition at line 332 of file vtkKWThumbWheel.h.

Definition at line 333 of file vtkKWThumbWheel.h.

double vtkKWThumbWheel::MaximumValue [protected]

Definition at line 334 of file vtkKWThumbWheel.h.

Definition at line 335 of file vtkKWThumbWheel.h.

double vtkKWThumbWheel::Resolution [protected]

Definition at line 336 of file vtkKWThumbWheel.h.

Definition at line 337 of file vtkKWThumbWheel.h.

Definition at line 338 of file vtkKWThumbWheel.h.

Definition at line 339 of file vtkKWThumbWheel.h.

Definition at line 341 of file vtkKWThumbWheel.h.

Definition at line 342 of file vtkKWThumbWheel.h.

double vtkKWThumbWheel::SizeOfNotches [protected]

Definition at line 343 of file vtkKWThumbWheel.h.

Definition at line 344 of file vtkKWThumbWheel.h.

Definition at line 346 of file vtkKWThumbWheel.h.

Definition at line 347 of file vtkKWThumbWheel.h.

Definition at line 348 of file vtkKWThumbWheel.h.

Definition at line 349 of file vtkKWThumbWheel.h.

Definition at line 350 of file vtkKWThumbWheel.h.

Definition at line 351 of file vtkKWThumbWheel.h.

int vtkKWThumbWheel::PopupMode [protected]

Definition at line 352 of file vtkKWThumbWheel.h.

Definition at line 353 of file vtkKWThumbWheel.h.

char* vtkKWThumbWheel::Command [protected]

Definition at line 355 of file vtkKWThumbWheel.h.

char* vtkKWThumbWheel::StartCommand [protected]

Definition at line 356 of file vtkKWThumbWheel.h.

char* vtkKWThumbWheel::EndCommand [protected]

Definition at line 357 of file vtkKWThumbWheel.h.

char* vtkKWThumbWheel::EntryCommand [protected]

Definition at line 358 of file vtkKWThumbWheel.h.

Definition at line 366 of file vtkKWThumbWheel.h.

Definition at line 368 of file vtkKWThumbWheel.h.

Definition at line 370 of file vtkKWThumbWheel.h.

Definition at line 371 of file vtkKWThumbWheel.h.

Definition at line 372 of file vtkKWThumbWheel.h.

Definition at line 373 of file vtkKWThumbWheel.h.

Definition at line 374 of file vtkKWThumbWheel.h.

int vtkKWThumbWheel::State [protected]

Definition at line 384 of file vtkKWThumbWheel.h.

Definition at line 409 of file vtkKWThumbWheel.h.

Definition at line 410 of file vtkKWThumbWheel.h.

Definition at line 412 of file vtkKWThumbWheel.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Tue Apr 27 02:38:23 2010 for KWWidgets by  doxygen 1.6.1