vtkPVLabeledToggle Class Reference

#include <vtkPVLabeledToggle.h>

Inheritance diagram for vtkPVLabeledToggle:

[legend]Collaboration diagram for vtkPVLabeledToggle:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVLabeledToggle, vtkPVObjectWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *pvApp)
virtual void	SetBalloonHelpString (const char *str)
void	Disable ()
virtual void	UpdateEnableState ()
virtual void	Initialize ()
virtual void	SaveInBatchScript (ofstream *file)
void	SetLabel (const char *str)
const char *	GetLabel ()
void	SetSelectedState (int val)
int	GetSelectedState ()
vtkPVLabeledToggle *	ClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
Static Public Member Functions
vtkPVLabeledToggle *	New ()
Protected Member Functions
	vtkPVLabeledToggle ()
	~vtkPVLabeledToggle ()
virtual void	Accept ()
virtual void	ResetInternal ()
virtual void	Trace (ofstream *file)
virtual void	CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
Protected Attributes
vtkKWLabel *	Label
vtkKWCheckButton *	CheckButton

---

Constructor & Destructor Documentation

vtkPVLabeledToggle::vtkPVLabeledToggle (   )  [protected]

vtkPVLabeledToggle::~vtkPVLabeledToggle (   )  [protected]

---

Member Function Documentation

vtkPVLabeledToggle* vtkPVLabeledToggle::New (   )  [static]

Reimplemented from vtkPVTracedWidget.

vtkPVLabeledToggle::vtkTypeRevisionMacro (  vtkPVLabeledToggle  , vtkPVObjectWidget  )

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

Reimplemented from vtkPVObjectWidget.

void vtkPVLabeledToggle::SetLabel (  const char *  str  )

Setting the label also sets the name.

const char* vtkPVLabeledToggle::GetLabel (   )

Setting the label also sets the name.

virtual void vtkPVLabeledToggle::Create (  vtkKWApplication *  pvApp  )  [virtual]

Create the widget. Reimplemented from vtkPVWidget.

void vtkPVLabeledToggle::SetSelectedState (  int  val  )

This method allows scripts to modify the widgets value.

int vtkPVLabeledToggle::GetSelectedState (   )

This method allows scripts to modify the widgets value.

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

This class redefines SetBalloonHelpString since it has to forward the call to a widget it contains. Reimplemented from vtkKWWidget.

void vtkPVLabeledToggle::Disable (   )

Disables the checkbutton.

vtkPVLabeledToggle* vtkPVLabeledToggle::ClonePrototype (  vtkPVSource *  pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *  map )

Creates and returns a copy of this widget. It will create a new instance of the same type as the current object using NewInstance() and then copy some necessary state parameters. Reimplemented from vtkPVObjectWidget.

virtual void vtkPVLabeledToggle::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 vtkPVLabeledToggle::Initialize (   )  [virtual]

Initialize the widget after creation. Implements vtkPVWidget.

virtual void vtkPVLabeledToggle::SaveInBatchScript (  ofstream *  file  )  [virtual]

Save this widget to a file. Implements vtkPVObjectWidget.

virtual void vtkPVLabeledToggle::Accept (   )  [protected, virtual]

These methods are called when the Accept and Reset buttons are pressed. The copy state from VTK/PV objects to the widget and back. Most subclasses do not have to implement these methods. They implement AcceptInternal and ResetInternal instead. Only methods that copy state from PV object need to override these methods. Accept needs to add to the trace (call trace), but AcceptInternal does not. Implements vtkPVWidget.

virtual void vtkPVLabeledToggle::ResetInternal (   )  [protected, virtual]

Called by Reset() if PVSource is set. Reimplemented from vtkPVWidget.

virtual void vtkPVLabeledToggle::Trace (  ofstream *  file  )  [protected, virtual]

Used by subclasses to save this widgets state into a PVScript. This method does not initialize trace variable or check modified. Implements vtkPVWidget.

virtual void vtkPVLabeledToggle::CopyProperties (  vtkPVWidget *  clone, vtkPVSource *  pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *  map )  [protected, virtual]

Reimplemented from vtkPVObjectWidget.

int vtkPVLabeledToggle::ReadXMLAttributes (  vtkPVXMLElement *  element, vtkPVXMLPackageParser *  parser )  [protected, virtual]

Called by vtkPVXMLPackageParser to configure the widget from XML attributes. Reimplemented from vtkPVObjectWidget.

---

Member Data Documentation

vtkKWLabel* vtkPVLabeledToggle::Label [protected]

Definition at line 99 of file vtkPVLabeledToggle.h.

vtkKWCheckButton* vtkPVLabeledToggle::CheckButton [protected]

Definition at line 100 of file vtkPVLabeledToggle.h.

---

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

• GUI/Client/vtkPVLabeledToggle.h

---