vtkPVItemSelection Class Reference

widget to select a set of data arrays. More...

#include <vtkPVItemSelection.h>

Inheritance diagram for vtkPVItemSelection:

[legend]Collaboration diagram for vtkPVItemSelection:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVItemSelection, vtkPVWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ResetInternal ()
virtual void	Initialize ()
virtual void	Create (vtkKWApplication *app)
void	SetArrayStatus (const char *name, int status)
int	GetNumberOfArrays ()
virtual void	SaveInBatchScript (ofstream *file)
virtual void	UpdateEnableState ()
virtual void	Accept ()
virtual void	PostAccept ()
virtual void	SetLabelText (const char *)
virtual char *	GetLabelText ()
void	AllOnCallback ()
void	AllOffCallback ()
vtkPVItemSelection *	ClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
Static Public Member Functions
vtkPVItemSelection *	New ()
Protected Member Functions
	vtkPVItemSelection ()
	~vtkPVItemSelection ()
virtual void	Trace (ofstream *file)
virtual void	UpdateGUI ()
virtual void	UpdateSelections (int fromReader)
virtual void	SetPropertyFromGUI ()
const char *	GetNameFromNumber (int num)
int	GetNumberFromName (const char *name, int *val)
virtual void	CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
Protected Attributes
char *	LabelText
vtkKWFrameWithLabel *	LabeledFrame
vtkKWFrame *	ButtonFrame
vtkKWPushButton *	AllOnButton
vtkKWPushButton *	AllOffButton
vtkKWFrame *	CheckFrame
vtkCollection *	ArrayCheckButtons
vtkKWLabel *	NoArraysLabel
vtkDataArraySelection *	Selection
vtkPVItemSelectionArraySet *	ArraySet

---

Detailed Description

widget to select a set of data arrays.

vtkPVItemSelection is used for selecting which set of data arrays to load when a reader has the ability to selectively load arrays. This class is able to deal with two different (though similar) type of domains: vtkSMStringListDomain and vtkSMStringListRangeDomain

Definition at line 37 of file vtkPVItemSelection.h.

---

Constructor & Destructor Documentation

vtkPVItemSelection::vtkPVItemSelection (   )  [protected]

vtkPVItemSelection::~vtkPVItemSelection (   )  [protected]

---

Member Function Documentation

vtkPVItemSelection* vtkPVItemSelection::New (   )  [static]

Reimplemented from vtkPVTracedWidget.

vtkPVItemSelection::vtkTypeRevisionMacro (  vtkPVItemSelection  , vtkPVWidget  )

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

Reimplemented from vtkPVWidget.

virtual void vtkPVItemSelection::Accept (   )  [virtual]

Methods for setting the value of the VTKReader from the widget. User internally when user hits Accept. Implements vtkPVWidget.

virtual void vtkPVItemSelection::PostAccept (   )  [virtual]

Methods for setting the value of the VTKReader from the widget. User internally when user hits Accept. Reimplemented from vtkPVWidget.

virtual void vtkPVItemSelection::ResetInternal (   )  [virtual]

Methods for setting the value of the widget from the VTKReader. User internally when user hits Reset. Reimplemented from vtkPVWidget.

virtual void vtkPVItemSelection::Initialize (   )  [virtual]

Update our local vtkDataItemSelection instance with the reader's settings. Implements vtkPVWidget.

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

Used to change the label of the widget. If not specified, the label is constructed using the AttributeName

virtual char* vtkPVItemSelection::GetLabelText (   )  [virtual]

Used to change the label of the widget. If not specified, the label is constructed using the AttributeName

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

Create the widget. Reimplemented from vtkPVWidget.

void vtkPVItemSelection::AllOnCallback (   )

Callback for the AllOn and AllOff buttons.

void vtkPVItemSelection::AllOffCallback (   )

Callback for the AllOn and AllOff buttons.

void vtkPVItemSelection::SetArrayStatus (  const char *  name, int  status )

Access to change this widgets state from a script. Used for tracing.

int vtkPVItemSelection::GetNumberOfArrays (   )

Get the number of array names listed in this widget.

vtkPVItemSelection* vtkPVItemSelection::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 vtkPVWidget.

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

Save this widget to a file. Ingore parts for thsi reader specific widget. Reimplemented from vtkPVWidget.

virtual void vtkPVItemSelection::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 vtkPVItemSelection::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 vtkPVItemSelection::UpdateGUI (   )  [protected, virtual]

virtual void vtkPVItemSelection::UpdateSelections (  int  fromReader  )  [protected, virtual]

virtual void vtkPVItemSelection::SetPropertyFromGUI (   )  [protected, virtual]

const char* vtkPVItemSelection::GetNameFromNumber (  int  num  )  [protected]

int vtkPVItemSelection::GetNumberFromName (  const char *  name, int *  val )  [protected]

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

Reimplemented from vtkPVWidget.

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

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

---

Member Data Documentation

char* vtkPVItemSelection::LabelText [protected]

Definition at line 117 of file vtkPVItemSelection.h.

vtkKWFrameWithLabel* vtkPVItemSelection::LabeledFrame [protected]

Definition at line 119 of file vtkPVItemSelection.h.

vtkKWFrame* vtkPVItemSelection::ButtonFrame [protected]

Definition at line 121 of file vtkPVItemSelection.h.

vtkKWPushButton* vtkPVItemSelection::AllOnButton [protected]

Definition at line 122 of file vtkPVItemSelection.h.

vtkKWPushButton* vtkPVItemSelection::AllOffButton [protected]

Definition at line 123 of file vtkPVItemSelection.h.

vtkKWFrame* vtkPVItemSelection::CheckFrame [protected]

Definition at line 125 of file vtkPVItemSelection.h.

vtkCollection* vtkPVItemSelection::ArrayCheckButtons [protected]

Definition at line 126 of file vtkPVItemSelection.h.

vtkKWLabel* vtkPVItemSelection::NoArraysLabel [protected]

Definition at line 127 of file vtkPVItemSelection.h.

vtkDataArraySelection* vtkPVItemSelection::Selection [protected]

Definition at line 129 of file vtkPVItemSelection.h.

vtkPVItemSelectionArraySet* vtkPVItemSelection::ArraySet [protected]

Definition at line 131 of file vtkPVItemSelection.h.

---

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

• GUI/Client/vtkPVItemSelection.h

---