vtkKWWidgetWithLabel Class Reference

an abstract class widget with a label More...

#include <vtkKWWidgetWithLabel.h>

Inheritance diagram for vtkKWWidgetWithLabel:

[legend]

Collaboration diagram for vtkKWWidgetWithLabel:

[legend]

List of all members.

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 vtkKWWidgetWithLabel *	New ()
static int	IsTypeOf (const char *type)
static vtkKWWidgetWithLabel *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWWidgetWithLabel ()
	~vtkKWWidgetWithLabel ()
virtual void	CreateWidget ()
virtual void	CreateLabel ()
virtual void	Pack ()
Protected Attributes
int	LabelVisibility
int	LabelPosition

enum	{ LabelPositionDefault = 0, LabelPositionTop, LabelPositionBottom, LabelPositionLeft, LabelPositionRight }
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 ()
virtual void	SetLabelPosition (int)
virtual int	GetLabelPosition ()
virtual void	SetLabelPositionToDefault ()
virtual void	SetLabelPositionToTop ()
virtual void	SetLabelPositionToBottom ()
virtual void	SetLabelPositionToLeft ()
virtual void	SetLabelPositionToRight ()

Detailed Description

an abstract class widget with a label

This class implements a superclass for composite widgets that need to associate a label (vtkKWLabel) to a widget (say, a vtkKWEntry for example). This superclass provides a GetLabel() method to retrieve the internal vtkKWLabel. Each subclass provides a GetWidget() method that can be used to retrieve the internal widget associated to to this label in the composite (say, a vtkKWEntry).

Be aware that most subclasses of vtkKWWidgetWithLabel are generated automatically out of the vtkKWWidgetWithLabelSubclass template located in the Templates directory. Therefore, even though the source code for those vtkKWWidgetWithLabel subclasses does not exist in the KWWidgets repository, they are still generated automatically and documented in the API online; check the vtkKWWidgetWithLabel API online for its subclasses, as well as the KWWidgets Auto-Generated Classes page. Classes related to the same template can be found in the KWWidgets Auto-Generated Classes: Widget With label section.

See also:: vtkKWCheckButtonWithLabel vtkKWEntryWithLabel vtkKWComboBoxWithLabel vtkKWMenuButtonWithLabel vtkKWMessageWithLabel vtkKWPushButtonWithLabel vtkKWScaleWithLabel vtkKWSpinBoxWithLabel

Definition at line 44 of file vtkKWWidgetWithLabel.h.

Member Typedef Documentation

typedef vtkKWCompositeWidget vtkKWWidgetWithLabel::Superclass

Reimplemented from vtkKWCompositeWidget.

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

Definition at line 49 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

Enumerator:

LabelPositionDefault
LabelPositionTop
LabelPositionBottom
LabelPositionLeft
LabelPositionRight

Definition at line 95 of file vtkKWWidgetWithLabel.h.

Constructor & Destructor Documentation

vtkKWWidgetWithLabel::vtkKWWidgetWithLabel ( ) [protected]

vtkKWWidgetWithLabel::~vtkKWWidgetWithLabel ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkKWCompositeWidget.

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

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

Reimplemented from vtkKWCompositeWidget.

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

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

Reimplemented from vtkKWCompositeWidget.

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

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

Reimplemented from vtkKWCompositeWidget.

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

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

Reimplemented from vtkKWCompositeWidget.

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

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]

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::LabelVisibilityOff ( ) [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 int vtkKWWidgetWithLabel::GetLabelVisibility ( ) [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 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]

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::SetLabelText ( const char * ) [virtual]

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 ( )

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::SetLabelWidth ( int width ) [virtual]

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]

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::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 106 of file vtkKWWidgetWithLabel.h.

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 108 of file vtkKWWidgetWithLabel.h.

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 110 of file vtkKWWidgetWithLabel.h.

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 112 of file vtkKWWidgetWithLabel.h.

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 114 of file vtkKWWidgetWithLabel.h.

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, vtkKWListBoxWithScrollbarsWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMatrixWidgetWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWMultiColumnListWithLabel, vtkKWMultiColumnListWithScrollbarsWithLabel, 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, vtkKWListBoxWithScrollbarsWithLabel, vtkKWLoadSaveButtonWithLabel, vtkKWMatrixWidgetWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWMultiColumnListWithLabel, vtkKWMultiColumnListWithScrollbarsWithLabel, vtkKWPopupButtonWithLabel, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, and vtkKWTextWithScrollbarsWithLabel.