Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkKWWidgetWithLabel Class Reference

an abstract class widget with a label More...

#include <vtkKWWidgetWithLabel.h>

Inheritance diagram for vtkKWWidgetWithLabel:

Inheritance graph
[legend]
Collaboration diagram for vtkKWWidgetWithLabel:

Collaboration graph
[legend]
List of all members.

[NOHEADER]

enum  {
  LabelPositionDefault = 0, LabelPositionTop, LabelPositionBottom, LabelPositionLeft,
  LabelPositionRight
}
virtual void SetLabelPosition (int)
virtual int GetLabelPosition ()
virtual void SetLabelPositionToDefault ()
virtual void SetLabelPositionToTop ()
virtual void SetLabelPositionToBottom ()
virtual void SetLabelPositionToLeft ()
virtual void SetLabelPositionToRight ()

Public Types


Public Member Functions

 vtkTypeRevisionMacro (vtkKWWidgetWithLabel, vtkKWCompositeWidget)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Create (vtkKWApplication *app)
virtual void SetBalloonHelpString (const char *str)
virtual void UpdateEnableState ()
virtual void SetLabelVisibility (int)
virtual void LabelVisibilityOn ()
virtual void LabelVisibilityOff ()
virtual int GetLabelVisibility ()
virtual vtkKWLabel * GetLabel ()
virtual int HasLabel ()
virtual void SetLabelText (const char *)
const char * GetLabelText ()
virtual void SetLabelWidth (int width)
virtual int GetLabelWidth ()

Static Public Member Functions

vtkKWWidgetWithLabel * New ()

Protected Member Functions

 vtkKWWidgetWithLabel ()
 ~vtkKWWidgetWithLabel ()
virtual void CreateLabel (vtkKWApplication *app)
virtual void Pack ()

Protected Attributes

int LabelVisibility
int LabelPosition

Detailed Description

an abstract class widget with a label

This class implements an abstract superclass for composite widgets associating a label to a widget.

Definition at line 29 of file vtkKWWidgetWithLabel.h.

Member Enumeration Documentation

anonymous enum
 

If supported, set the label 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. BTX

Enumeration values:
LabelPositionDefault 
LabelPositionTop 
LabelPositionBottom 
LabelPositionLeft 
LabelPositionRight 

Definition at line 82 of file vtkKWWidgetWithLabel.h.

Constructor & Destructor Documentation

vtkKWWidgetWithLabel::vtkKWWidgetWithLabel (   )  [protected]
 

vtkKWWidgetWithLabel::~vtkKWWidgetWithLabel (   )  [protected]
 

Member Function Documentation

vtkKWWidgetWithLabel* vtkKWWidgetWithLabel::New (   )  [static]
 

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWChangeColorButton, vtkKWColorPresetSelector, vtkKWColorTransferFunctionEditor, vtkKWPiecewiseFunctionEditor, vtkKWRange, vtkKWScaleWithEntry, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxWithLabel, vtkKWEntryWithLabel, vtkKWLabelWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWPopupButtonWithLabel, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, vtkKWTextWithScrollbarsWithLabel, and vtkPVTimeLine.

vtkKWWidgetWithLabel::vtkTypeRevisionMacro (  vtkKWWidgetWithLabel  ,
vtkKWCompositeWidget 
) 
 

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

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWChangeColorButton, vtkKWColorPresetSelector, vtkKWColorTransferFunctionEditor, vtkKWParameterValueFunctionEditor, vtkKWParameterValueFunctionInterface, vtkKWParameterValueHermiteFunctionEditor, vtkKWPiecewiseFunctionEditor, vtkKWRange, vtkKWScaleWithEntry, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxWithLabel, vtkKWEntryWithLabel, vtkKWLabelWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWPopupButtonWithLabel, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, vtkKWTextWithScrollbarsWithLabel, and vtkPVTimeLine.

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

Create the widget.

Reimplemented from vtkKWCompositeWidget.

Reimplemented in vtkKWChangeColorButton, vtkKWColorPresetSelector, vtkKWColorTransferFunctionEditor, vtkKWParameterValueFunctionEditor, vtkKWParameterValueFunctionInterface, vtkKWParameterValueHermiteFunctionEditor, vtkKWPiecewiseFunctionEditor, vtkKWRange, vtkKWScaleWithEntry, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxWithLabel, vtkKWEntryWithLabel, vtkKWLabelWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWPopupButtonWithLabel, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, vtkKWTextWithScrollbarsWithLabel, and vtkPVTimeLine.

virtual void vtkKWWidgetWithLabel::SetLabelVisibility (  int   )  [virtual]
 

Set/Get the internal label visibility (On by default). IMPORTANT: if you know you may not show the label, try to set that flag as early as possible (ideally, before calling Create()) in order to lower the footprint of the widget: the label 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 label: it will be allocated and created on the fly.

virtual void vtkKWWidgetWithLabel::LabelVisibilityOn (   )  [virtual]
 

Set/Get the internal label visibility (On by default). IMPORTANT: if you know you may not show the label, try to set that flag as early as possible (ideally, before calling Create()) in order to lower the footprint of the widget: the label 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 label: it will be allocated and created on the fly.

virtual void vtkKWWidgetWithLabel::LabelVisibilityOff (   )  [virtual]
 

Set/Get the internal label visibility (On by default). IMPORTANT: if you know you may not show the label, try to set that flag as early as possible (ideally, before calling Create()) in order to lower the footprint of the widget: the label 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 label: it will be allocated and created on the fly.

virtual int vtkKWWidgetWithLabel::GetLabelVisibility (   )  [virtual]
 

Set/Get the internal label visibility (On by default). IMPORTANT: if you know you may not show the label, try to set that flag as early as possible (ideally, before calling Create()) in order to lower the footprint of the widget: the label 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 label: it will be allocated and created on the fly.

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

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

virtual int vtkKWWidgetWithLabel::HasLabel (   )  [virtual]
 

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

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

Convenience method to set/get the contents label. IMPORTANT: SetLabelText will create the label on the fly, use it only if you are confident that you will indeed display the label.

Reimplemented in vtkKWScaleWithEntry.

const char* vtkKWWidgetWithLabel::GetLabelText (   ) 
 

Convenience method to set/get the contents label. IMPORTANT: SetLabelText will create the label on the fly, use it only if you are confident that you will indeed display the label.

virtual void vtkKWWidgetWithLabel::SetLabelWidth (  int  width  )  [virtual]
 

Convenience method to set/get the label width. IMPORTANT: this method will create the label on the fly, use it only if you are confident that you will indeed display the label.

virtual int vtkKWWidgetWithLabel::GetLabelWidth (   )  [virtual]
 

Convenience method to set/get the label width. IMPORTANT: this method will create the label on the fly, use it only if you are confident that you will indeed display the label.

virtual void vtkKWWidgetWithLabel::SetLabelPosition (  int   )  [virtual]
 

If supported, set the label 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. BTX

Reimplemented in vtkKWParameterValueFunctionEditor.

virtual int vtkKWWidgetWithLabel::GetLabelPosition (   )  [virtual]
 

If supported, set the label 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. BTX

virtual void vtkKWWidgetWithLabel::SetLabelPositionToDefault (   )  [inline, virtual]
 

If supported, set the label 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. BTX

Definition at line 93 of file vtkKWWidgetWithLabel.h.

References LabelPositionDefault.

virtual void vtkKWWidgetWithLabel::SetLabelPositionToTop (   )  [inline, virtual]
 

If supported, set the label 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. BTX

Definition at line 95 of file vtkKWWidgetWithLabel.h.

References LabelPositionTop.

virtual void vtkKWWidgetWithLabel::SetLabelPositionToBottom (   )  [inline, virtual]
 

If supported, set the label 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. BTX

Definition at line 97 of file vtkKWWidgetWithLabel.h.

References LabelPositionBottom.

virtual void vtkKWWidgetWithLabel::SetLabelPositionToLeft (   )  [inline, virtual]
 

If supported, set the label 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. BTX

Definition at line 99 of file vtkKWWidgetWithLabel.h.

References LabelPositionLeft.

virtual void vtkKWWidgetWithLabel::SetLabelPositionToRight (   )  [inline, virtual]
 

If supported, set the label 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. BTX

Definition at line 101 of file vtkKWWidgetWithLabel.h.

References LabelPositionRight.

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

Set the string that enables balloon help for this widget. Override to pass down to children.

Reimplemented from vtkKWWidget.

Reimplemented in vtkKWChangeColorButton, vtkKWParameterValueFunctionEditor, vtkKWRange, vtkKWScaleWithEntry, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxWithLabel, vtkKWEntryWithLabel, vtkKWLabelWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWPopupButtonWithLabel, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, and vtkKWTextWithScrollbarsWithLabel.

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

Reimplemented in vtkKWChangeColorButton, vtkKWColorTransferFunctionEditor, vtkKWParameterValueFunctionEditor, vtkKWParameterValueHermiteFunctionEditor, vtkKWPiecewiseFunctionEditor, vtkKWRange, vtkKWScaleWithEntry, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxWithLabel, vtkKWEntryWithLabel, vtkKWLabelWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWPopupButtonWithLabel, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, and vtkKWTextWithScrollbarsWithLabel.

virtual void vtkKWWidgetWithLabel::CreateLabel (  vtkKWApplication *  app  )  [protected, virtual]
 

Create the label

Reimplemented in vtkKWChangeColorButton, and vtkKWParameterValueFunctionEditor.

virtual void vtkKWWidgetWithLabel::Pack (   )  [inline, protected, virtual]
 

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

Reimplemented in vtkKWChangeColorButton, vtkKWColorTransferFunctionEditor, vtkKWParameterValueFunctionEditor, vtkKWPiecewiseFunctionEditor, vtkKWRange, vtkKWScaleWithEntry, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxWithLabel, vtkKWEntryWithLabel, vtkKWLabelWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWPopupButtonWithLabel, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, and vtkKWTextWithScrollbarsWithLabel.

Definition at line 131 of file vtkKWWidgetWithLabel.h.

Member Data Documentation

int vtkKWWidgetWithLabel::LabelVisibility [protected]
 

Label visibility

Definition at line 122 of file vtkKWWidgetWithLabel.h.

int vtkKWWidgetWithLabel::LabelPosition [protected]
 

Label position

Definition at line 125 of file vtkKWWidgetWithLabel.h.

The documentation for this class was generated from the following file:
Generated on Tue May 30 12:47:36 2006 for ParaView by doxygen 1.3.5