vtkKWObject Class Reference

Superclass that supports basic Tcl functionality. More...

#include <vtkKWObject.h>

Inheritance diagram for vtkKWObject:

[legend]Collaboration diagram for vtkKWObject:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkKWObject, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
const char *	GetTclName ()
virtual vtkKWApplication *	GetApplication ()
virtual void	SetApplication (vtkKWApplication *arg)
virtual const char *	Script (const char *EventString,...)
virtual void	AddCallbackCommandObserver (vtkObject *object, unsigned long event)
virtual void	RemoveCallbackCommandObserver (vtkObject *object, unsigned long event)
virtual void	AddCallbackCommandObservers ()
virtual void	RemoveCallbackCommandObservers ()
Static Public Member Functions
vtkKWObject *	New ()
Protected Member Functions
	vtkKWObject ()
	~vtkKWObject ()
virtual vtkCallbackCommand *	GetCallbackCommand ()
void	SetObjectMethodCommand (char **command, vtkObject *object, const char *method)
virtual void	ProcessCallbackCommandEvents (vtkObject *caller, unsigned long event, void *calldata)
Static Protected Member Functions
void	ProcessCallbackCommandEventsFunction (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

---

Detailed Description

Superclass that supports basic Tcl functionality.

vtkKWObject is the superclass for most application classes. It is a direct subclass of vtkObject but adds functionality for invoking Tcl scripts, obtaining the Tcl name for an instance, etc. This class requires a vtkKWApplication in order to work (as do all classes).

See also:

vtkKWApplication

Definition at line 36 of file vtkKWObject.h.

---

Constructor & Destructor Documentation

vtkKWObject::vtkKWObject (   )  [protected]

vtkKWObject::~vtkKWObject (   )  [protected]

---

Member Function Documentation

vtkKWObject* vtkKWObject::New (   )  [static]

Reimplemented in vtkKWApplication, vtkKWApplicationSettingsInterface, vtkKWBalloonHelpManager, vtkKWCanvas, vtkKWChangeColorButton, vtkKWCheckButton, vtkKWCheckButtonWithChangeColorButton, vtkKWCheckButtonWithPopupFrame, vtkKWColorPresetSelector, vtkKWColorTransferFunctionEditor, vtkKWComboBox, vtkKWCompositeWidget, vtkKWCoreWidget, vtkKWCornerAnnotationEditor, vtkKWDialog, vtkKWDragAndDropTargetSet, vtkKWEntry, vtkKWExtent, vtkKWFrame, vtkKWFrameWithLabel, vtkKWFrameWithScrollbar, vtkKWHeaderAnnotationEditor, vtkKWHSVColorSelector, vtkKWLabel, vtkKWListBox, vtkKWListBoxToListBoxSelectionEditor, vtkKWLoadSaveButton, vtkKWLoadSaveDialog, vtkKWMenu, vtkKWMenuButton, vtkKWMessage, vtkKWMessageDialog, vtkKWMostRecentFilesManager, vtkKWMultiColumnList, vtkKWNotebook, vtkKWPiecewiseFunctionEditor, vtkKWPopupButton, vtkKWPopupFrame, vtkKWPresetSelector, vtkKWProgressGauge, vtkKWPushButton, vtkKWPushButtonWithMenu, vtkKWRadioButton, vtkKWRadioButtonSet, vtkKWRange, vtkKWRenderWidget, vtkKWSaveImageDialog, vtkKWScalarBarAnnotation, vtkKWScalarComponentSelectionWidget, vtkKWScale, vtkKWScaleWithEntry, vtkKWScrollbar, vtkKWSegmentedProgressGauge, vtkKWSelectionFrame, vtkKWSelectionFrameLayoutManager, vtkKWSeparator, vtkKWSimpleAnimationWidget, vtkKWSimpleEntryDialog, vtkKWSpinBox, vtkKWSpinButtons, vtkKWSplashScreen, vtkKWSplitFrame, vtkKWSurfaceMaterialPropertyWidget, vtkKWTclInteractor, vtkKWText, vtkKWTextPropertyEditor, vtkKWThumbWheel, vtkKWTkcon, vtkKWToolbar, vtkKWToolbarSet, vtkKWTopLevel, vtkKWTree, vtkKWUserInterfaceManagerDialog, vtkKWUserInterfaceManagerNotebook, vtkKWUserInterfacePanel, vtkKWVolumeMaterialPropertyWidget, vtkKWVolumePropertyPresetSelector, vtkKWVolumePropertyWidget, vtkKWWidget, vtkKWWidgetWithLabel, vtkKWWidgetWithSpinButtons, vtkKWWindow, vtkKWWindowBase, vtkKWWindowLevelPresetSelector, vtkKWCanvasWithScrollbars, vtkKWCheckButtonSet, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxSet, vtkKWComboBoxWithLabel, vtkKWEntrySet, vtkKWEntryWithLabel, vtkKWLabelSet, vtkKWLabelWithLabel, vtkKWLabelWithLabelSet, vtkKWListBoxWithScrollbars, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtons, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWMultiColumnListWithScrollbars, vtkKWPopupButtonWithLabel, vtkKWPushButtonSet, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleSet, vtkKWScaleWithEntrySet, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, vtkKWTextWithScrollbars, vtkKWTextWithScrollbarsWithLabel, vtkKWTreeWithScrollbars, vtkKWBoundsDisplay, vtkKWLookmark, vtkKWLookmarkFolder, vtkKWView, vtkPVActiveTrackSelector, vtkPVAdvancedReaderModule, vtkPVAnimationCue, vtkPVAnimationCueTree, vtkPVAnimationManager, vtkPVAnimationScene, vtkPVApplication, vtkPVApplicationSettingsInterface, vtkPVArrayMenu, vtkPVArraySelection, vtkPVAttributeEditor, vtkPVBasicDSPFilterWidget, vtkPVBooleanKeyFrame, vtkPVBoundsDisplay, vtkPVBoxWidget, vtkPVCalculatorWidget, vtkPVCameraAnimationCue, vtkPVCameraControl, vtkPVCameraIcon, vtkPVCameraKeyFrame, vtkPVCaveRenderModuleUI, vtkPVColorMap, vtkPVColorSelectionWidget, vtkPVComparativeVisDialog, vtkPVComparativeVisManager, vtkPVComparativeVisManagerGUI, vtkPVComparativeVisProgressDialog, vtkPVComparativeVisPropertyWidget, vtkPVCompositeRenderModuleUI, vtkPVConnectDialog, vtkPVContainerWidget, vtkPVContourEntry, vtkPVCornerAnnotationEditor, vtkPVCutEntry, vtkPVDataSetReaderModule, vtkPVDisplayGUI, vtkPVDReaderModule, vtkPVDummyWidget, vtkPVDWriter, vtkPVEnSightReaderModule, vtkPVErrorLogDisplay, vtkPVEWriter, vtkPVExponentialKeyFrame, vtkPVExtentEntry, vtkPVExtractDataSetsWidget, vtkPVExtractPartsWidget, vtkPVFieldMenu, vtkPVFileEntry, vtkPVGhostLevelDialog, vtkPVGroupInputsWidget, vtkPVHorizontalAnimationInterface, vtkPVIceTDesktopRenderModuleUI, vtkPVIceTRenderModuleUI, vtkPVImplicitPlaneWidget, vtkPVInformationGUI, vtkPVInitialize, vtkPVInputMenu, vtkPVInteractorStyleControl, vtkPVItemSelection, vtkPVLabeledToggle, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVListBoxToListBoxSelectionEditor, vtkPVLODRenderModuleUI, vtkPVLookmark, vtkPVLookmarkManager, vtkPVMinMax, vtkPVMPIRenderModuleUI, vtkPVMultiDisplayRenderModuleUI, vtkPVNavigationWindow, vtkPVOrientScaleWidget, vtkPVPick, vtkPVPickBoxWidget, vtkPVPickSphereWidget, vtkPVPLOT3DReaderModule, vtkPVPointSourceWidget, vtkPVPointWidget, vtkPVProbe, vtkPVRampKeyFrame, vtkPVRawReaderModule, vtkPVReaderModule, vtkPVRenderGroupDialog, vtkPVRenderModuleUI, vtkPVRenderView, vtkPVSaveBatchScriptDialog, vtkPVScalarRangeLabel, vtkPVScale, vtkPVScaleFactorEntry, vtkPVSelectArrays, vtkPVSelectCustomReader, vtkPVSelectionList, vtkPVSelectTimeSet, vtkPVSelectWidget, vtkPVServerFileDialog, vtkPVSimpleAnimationCue, vtkPVSinusoidKeyFrame, vtkPVSource, vtkPVSourceList, vtkPVSourceNotebook, vtkPVSourcesNavigationWindow, vtkPVSphereWidget, vtkPVStringEntry, vtkPVTempTessellatorEntry, vtkPVTextPropertyEditor, vtkPVThumbWheel, vtkPVTimeLine, vtkPVTimerLogDisplay, vtkPVTracedWidget, vtkPVTraceFileDialog, vtkPVTrackEditor, vtkPVVCRControl, vtkPVVectorEntry, vtkPVVerticalAnimationInterface, vtkPVVolumeAppearanceEditor, vtkPVVolumePropertyWidget, vtkPVWindow, vtkPVWriter, vtkPVXDMFParameters, and vtkXDMFReaderModule.

vtkKWObject::vtkTypeRevisionMacro (  vtkKWObject  , vtkObject  )

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

Reimplemented in vtkKWApplication, vtkKWApplicationSettingsInterface, vtkKWBalloonHelpManager, vtkKWCanvas, vtkKWChangeColorButton, vtkKWCheckButton, vtkKWCheckButtonWithChangeColorButton, vtkKWCheckButtonWithPopupFrame, vtkKWColorPresetSelector, vtkKWColorTransferFunctionEditor, vtkKWComboBox, vtkKWCompositeWidget, vtkKWCoreWidget, vtkKWCornerAnnotationEditor, vtkKWDialog, vtkKWDragAndDropTargetSet, vtkKWEntry, vtkKWExtent, vtkKWFrame, vtkKWFrameWithLabel, vtkKWFrameWithScrollbar, vtkKWHeaderAnnotationEditor, vtkKWHSVColorSelector, vtkKWLabel, vtkKWListBox, vtkKWListBoxToListBoxSelectionEditor, vtkKWLoadSaveButton, vtkKWLoadSaveDialog, vtkKWMaterialPropertyWidget, vtkKWMenu, vtkKWMenuButton, vtkKWMessage, vtkKWMessageDialog, vtkKWMostRecentFilesManager, vtkKWMultiColumnList, vtkKWNotebook, vtkKWParameterValueFunctionEditor, vtkKWParameterValueFunctionInterface, vtkKWParameterValueHermiteFunctionEditor, vtkKWPiecewiseFunctionEditor, vtkKWPopupButton, vtkKWPopupFrame, vtkKWPresetSelector, vtkKWProgressGauge, vtkKWPushButton, vtkKWPushButtonWithMenu, vtkKWRadioButton, vtkKWRadioButtonSet, vtkKWRange, vtkKWRenderWidget, vtkKWSaveImageDialog, vtkKWScalarBarAnnotation, vtkKWScalarComponentSelectionWidget, vtkKWScale, vtkKWScaleWithEntry, vtkKWScrollbar, vtkKWSegmentedProgressGauge, vtkKWSelectionFrame, vtkKWSelectionFrameLayoutManager, vtkKWSeparator, vtkKWSimpleAnimationWidget, vtkKWSimpleEntryDialog, vtkKWSpinBox, vtkKWSpinButtons, vtkKWSplashScreen, vtkKWSplitFrame, vtkKWSurfaceMaterialPropertyWidget, vtkKWTclInteractor, vtkKWText, vtkKWTextPropertyEditor, vtkKWThumbWheel, vtkKWTkcon, vtkKWToolbar, vtkKWToolbarSet, vtkKWTopLevel, vtkKWTree, vtkKWUserInterfaceManager, vtkKWUserInterfaceManagerDialog, vtkKWUserInterfaceManagerNotebook, vtkKWUserInterfacePanel, vtkKWVolumeMaterialPropertyWidget, vtkKWVolumePropertyPresetSelector, vtkKWVolumePropertyWidget, vtkKWWidget, vtkKWWidgetSet, vtkKWWidgetWithLabel, vtkKWWidgetWithScrollbars, vtkKWWidgetWithSpinButtons, vtkKWWindow, vtkKWWindowBase, vtkKWWindowLevelPresetSelector, vtkKWCanvasWithScrollbars, vtkKWCheckButtonSet, vtkKWCheckButtonSetWithLabel, vtkKWCheckButtonWithLabel, vtkKWComboBoxSet, vtkKWComboBoxWithLabel, vtkKWEntrySet, vtkKWEntryWithLabel, vtkKWLabelSet, vtkKWLabelWithLabel, vtkKWLabelWithLabelSet, vtkKWListBoxWithScrollbars, vtkKWLoadSaveButtonWithLabel, vtkKWMenuButtonWithLabel, vtkKWMenuButtonWithSpinButtons, vtkKWMenuButtonWithSpinButtonsWithLabel, vtkKWMessageWithLabel, vtkKWMultiColumnListWithScrollbars, vtkKWPopupButtonWithLabel, vtkKWPushButtonSet, vtkKWPushButtonSetWithLabel, vtkKWPushButtonWithLabel, vtkKWRadioButtonSetWithLabel, vtkKWScaleSet, vtkKWScaleWithEntrySet, vtkKWScaleWithEntrySetWithLabel, vtkKWScaleWithLabel, vtkKWSpinBoxWithLabel, vtkKWTextWithLabel, vtkKWTextWithScrollbars, vtkKWTextWithScrollbarsWithLabel, vtkKWTreeWithScrollbars, vtkKWBoundsDisplay, vtkKWLookmark, vtkKWLookmarkFolder, vtkKWView, vtkPV3DWidget, vtkPVActiveTrackSelector, vtkPVAdvancedReaderModule, vtkPVAnimationCue, vtkPVAnimationCueTree, vtkPVAnimationManager, vtkPVAnimationScene, vtkPVApplication, vtkPVApplicationSettingsInterface, vtkPVArrayMenu, vtkPVArraySelection, vtkPVAttributeEditor, vtkPVBasicDSPFilterWidget, vtkPVBooleanKeyFrame, vtkPVBoundsDisplay, vtkPVBoxWidget, vtkPVCalculatorWidget, vtkPVCameraAnimationCue, vtkPVCameraControl, vtkPVCameraIcon, vtkPVCameraKeyFrame, vtkPVCaveRenderModuleUI, vtkPVColorMap, vtkPVColorSelectionWidget, vtkPVComparativeVisDialog, vtkPVComparativeVisManager, vtkPVComparativeVisManagerGUI, vtkPVComparativeVisProgressDialog, vtkPVComparativeVisPropertyWidget, vtkPVCompositeRenderModuleUI, vtkPVConnectDialog, vtkPVContainerWidget, vtkPVContourEntry, vtkPVCornerAnnotationEditor, vtkPVCutEntry, vtkPVDataSetReaderModule, vtkPVDisplayGUI, vtkPVDReaderModule, vtkPVDummyWidget, vtkPVDWriter, vtkPVEnSightReaderModule, vtkPVErrorLogDisplay, vtkPVEWriter, vtkPVExponentialKeyFrame, vtkPVExtentEntry, vtkPVExtractDataSetsWidget, vtkPVExtractPartsWidget, vtkPVFieldMenu, vtkPVFileEntry, vtkPVGhostLevelDialog, vtkPVGroupInputsWidget, vtkPVHorizontalAnimationInterface, vtkPVIceTDesktopRenderModuleUI, vtkPVIceTRenderModuleUI, vtkPVImplicitPlaneWidget, vtkPVInformationGUI, vtkPVInitialize, vtkPVInputMenu, vtkPVInteractorStyleControl, vtkPVItemSelection, vtkPVKeyFrame, vtkPVLabeledToggle, vtkPVLineSourceWidget, vtkPVLineWidget, vtkPVListBoxToListBoxSelectionEditor, vtkPVLODRenderModuleUI, vtkPVLookmark, vtkPVLookmarkManager, vtkPVMinMax, vtkPVMPIRenderModuleUI, vtkPVMultiDisplayRenderModuleUI, vtkPVNavigationWindow, vtkPVObjectWidget, vtkPVOrientScaleWidget, vtkPVPick, vtkPVPickBoxWidget, vtkPVPickSphereWidget, vtkPVPLOT3DReaderModule, vtkPVPointSourceWidget, vtkPVPointWidget, vtkPVProbe, vtkPVPropertyKeyFrame, vtkPVProxyKeyFrame, vtkPVRampKeyFrame, vtkPVRawReaderModule, vtkPVReaderModule, vtkPVRenderGroupDialog, vtkPVRenderModuleUI, vtkPVRenderView, vtkPVSaveBatchScriptDialog, vtkPVScalarRangeLabel, vtkPVScale, vtkPVScaleFactorEntry, vtkPVSelectArrays, vtkPVSelectCustomReader, vtkPVSelectionList, vtkPVSelectTimeSet, vtkPVSelectWidget, vtkPVServerFileDialog, vtkPVSimpleAnimationCue, vtkPVSinusoidKeyFrame, vtkPVSource, vtkPVSourceList, vtkPVSourceNotebook, vtkPVSourcesNavigationWindow, vtkPVSphereWidget, vtkPVStringEntry, vtkPVTempTessellatorEntry, vtkPVTextPropertyEditor, vtkPVThumbWheel, vtkPVTimeLine, vtkPVTimerLogDisplay, vtkPVTracedWidget, vtkPVTraceFileDialog, vtkPVTrackEditor, vtkPVValueList, vtkPVVCRControl, vtkPVVectorEntry, vtkPVVerticalAnimationInterface, vtkPVVolumeAppearanceEditor, vtkPVVolumePropertyWidget, vtkPVWidget, vtkPVWindow, vtkPVWriter, vtkPVXDMFParameters, and vtkXDMFReaderModule.

const char* vtkKWObject::GetTclName (   )

Get the name of the Tcl object this instance represents.

virtual vtkKWApplication* vtkKWObject::GetApplication (   )  [virtual]

Set/Get the application instance for this object. Reimplemented in vtkKWApplication.

virtual void vtkKWObject::SetApplication (  vtkKWApplication *  arg  )  [virtual]

Set/Get the application instance for this object. Reimplemented in vtkKWApplication.

virtual const char* vtkKWObject::Script (  const char *  EventString, ...  )  [virtual]

Convenience method to invoke some Tcl script code and perform argument substitution. Reimplemented in vtkKWApplication.

virtual void vtkKWObject::AddCallbackCommandObserver (  vtkObject *  object, unsigned long  event )  [virtual]

Add/Remove a callback command observer. This AddCallbackCommandObserver() method makes sure the CallbackCommand object is setup properly, then add an observer on 'object', if it does not exist already. This observer is triggered by 'event' and will invoke the CallbackCommand's Execute() method. This method is prefered over the vtkObject::AddObserver method as it takes care of initializing CallbackCommand, and eventually keep track of observers that have been added, so that they can be removed properly using RemoveCallbackCommandObserver(s).

virtual void vtkKWObject::RemoveCallbackCommandObserver (  vtkObject *  object, unsigned long  event )  [virtual]

Add/Remove a callback command observer. This AddCallbackCommandObserver() method makes sure the CallbackCommand object is setup properly, then add an observer on 'object', if it does not exist already. This observer is triggered by 'event' and will invoke the CallbackCommand's Execute() method. This method is prefered over the vtkObject::AddObserver method as it takes care of initializing CallbackCommand, and eventually keep track of observers that have been added, so that they can be removed properly using RemoveCallbackCommandObserver(s).

virtual void vtkKWObject::AddCallbackCommandObservers (   )  [inline, 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 in vtkKWRenderWidget. Definition at line 81 of file vtkKWObject.h.

virtual void vtkKWObject::RemoveCallbackCommandObservers (   )  [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 in vtkKWRenderWidget.

void vtkKWObject::SetObjectMethodCommand (  char **  command, vtkObject *  object, const char *  method )  [protected]

Convenience method that can be used to create a callback function on an object. The first argument is the command (string) to set, the second is the KWObject that the method will be called on. The third is the name of the method itself and any arguments in string form. Note that the command is allocated automatically using the 'new' operator. If it is not NULL, it is deallocated first using 'delete []'.

virtual vtkCallbackCommand* vtkKWObject::GetCallbackCommand (   )  [protected, virtual]

Get the callback command. Its ClientData is set to this vtkKWObject instance itself, do not change it. Its Execute() method calls the static ProcessCallbackCommandEventsFunction method, passing it its ClientData, which in turn is converted back to a vtkKWObject pointer. The virtual ProcessCallbackCommandEvents method is invokved on that pointer. Subclasses can override this method to set specific flags, like the AbortFlagOnExecute flag.

void vtkKWObject::ProcessCallbackCommandEventsFunction (  vtkObject *  object, unsigned long  event, void *  clientdata, void *  calldata )  [static, protected]

Static callback function that is invoked by the CallbackCommand's Execute() method. It converts its clientdata back to a vtkKWObject pointer and invoke its virtual ProcessCallbackCommandEvents method.

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

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

---

The documentation for this class was generated from the following file:

• GUI/Widgets/vtkKWObject.h

---