vtkPVSelectionList Class Reference

Another form of radio buttons. More...

#include <vtkPVSelectionList.h>

Inheritance diagram for vtkPVSelectionList:

[legend]Collaboration diagram for vtkPVSelectionList:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVSelectionList, vtkPVObjectWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
void	AddItem (const char *name, int value)
int	GetValue (const char *name)
void	RemoveAllItems ()
void	SelectCallback (const char *name, int value)
virtual void	SetBalloonHelpString (const char *str)
void	Disable ()
virtual void	Accept ()
virtual void	ResetInternal ()
virtual void	Initialize ()
virtual void	Trace (ofstream *file)
virtual void	UpdateEnableState ()
virtual void	SaveInBatchScript (ofstream *file)
int	GetNumberOfItems ()
void	SetLabel (const char *label)
const char *	GetLabel ()
void	SetLabelVisibility (int visible)
virtual int	GetLabelVisibility ()
void	ShowLabel ()
void	HideLabel ()
virtual int	GetCurrentValue ()
void	SetCurrentValue (int val)
virtual char *	GetCurrentName ()
virtual void	SetOptionWidth (int)
vtkPVSelectionList *	ClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
Static Public Member Functions
vtkPVSelectionList *	New ()
Protected Member Functions
	vtkPVSelectionList ()
	~vtkPVSelectionList ()
virtual void	SetCurrentName (const char *)
virtual void	CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
Protected Attributes
vtkKWLabel *	Label
vtkKWMenuButton *	Menu
char *	Command
int	LabelVisibility
int	OptionWidth
int	CurrentValue
char *	CurrentName
vtkStringList *	Names

---

Detailed Description

Another form of radio buttons.

This widget produces a button that displays a selection from a list. When the button is pressed, the list is displayed in the form of a menu. The user can select a new value from the menu.

This class is not named correctly. It should be selection menu.

Definition at line 34 of file vtkPVSelectionList.h.

---

Constructor & Destructor Documentation

vtkPVSelectionList::vtkPVSelectionList (   )  [protected]

vtkPVSelectionList::~vtkPVSelectionList (   )  [protected]

---

Member Function Documentation

vtkPVSelectionList* vtkPVSelectionList::New (   )  [static]

Reimplemented from vtkPVTracedWidget.

vtkPVSelectionList::vtkTypeRevisionMacro (  vtkPVSelectionList  , vtkPVObjectWidget  )

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

Reimplemented from vtkPVObjectWidget.

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

Create the widget. Reimplemented from vtkPVWidget.

void vtkPVSelectionList::AddItem (  const char *  name, int  value )

int vtkPVSelectionList::GetValue (  const char *  name  )

Get the value for the first match of the name in added items..

void vtkPVSelectionList::RemoveAllItems (   )

Remove all items.

void vtkPVSelectionList::SetLabel (  const char *  label  )

Set the label of the menu.

const char* vtkPVSelectionList::GetLabel (   )

Set the label of the menu.

void vtkPVSelectionList::SetLabelVisibility (  int  visible  )

Show/Hide the label.

virtual int vtkPVSelectionList::GetLabelVisibility (   )  [virtual]

Show/Hide the label.

void vtkPVSelectionList::ShowLabel (   )  [inline]

Show/Hide the label. Definition at line 65 of file vtkPVSelectionList.h.

void vtkPVSelectionList::HideLabel (   )  [inline]

Show/Hide the label. Definition at line 66 of file vtkPVSelectionList.h.

virtual int vtkPVSelectionList::GetCurrentValue (   )  [virtual]

This is how the user can query the state of the selection. Warning: Setting the current value will not change vtk ivar.

void vtkPVSelectionList::SetCurrentValue (  int  val  )

This is how the user can query the state of the selection. Warning: Setting the current value will not change vtk ivar.

virtual char* vtkPVSelectionList::GetCurrentName (   )  [virtual]

This is how the user can query the state of the selection. Warning: Setting the current value will not change vtk ivar.

virtual void vtkPVSelectionList::SetOptionWidth (  int   )  [virtual]

Sets the width (in units of character) of the option menu (should be specified before create)

void vtkPVSelectionList::SelectCallback (  const char *  name, int  value )

This method gets called when the user selects an entry. Use this method if you want to programmatically change the selection.

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

This class redefines SetBalloonHelpString since it has to forward the call to the widgets (label and selection) it contains. Reimplemented from vtkKWWidget.

void vtkPVSelectionList::Disable (   )

Disables the widget.

vtkPVSelectionList* vtkPVSelectionList::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 vtkPVSelectionList::Accept (   )  [virtual]

Pass the value from the widget to the property. Implements vtkPVWidget.

virtual void vtkPVSelectionList::ResetInternal (   )  [virtual]

Called when reset button is pushed. Sets UI current value from objects variable. Reimplemented from vtkPVWidget.

virtual void vtkPVSelectionList::Initialize (   )  [virtual]

Initialize the widget after creation Implements vtkPVWidget.

virtual void vtkPVSelectionList::Trace (  ofstream *  file  )  [virtual]

This serves a dual purpose. For tracing and for saving state. Implements vtkPVWidget.

virtual void vtkPVSelectionList::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 vtkPVSelectionList::SaveInBatchScript (  ofstream *  file  )  [virtual]

Save this widget to a file. Implements vtkPVObjectWidget.

int vtkPVSelectionList::GetNumberOfItems (   )

Get number of items in the selection list.

virtual void vtkPVSelectionList::SetCurrentName (  const char *   )  [protected, virtual]

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

Reimplemented from vtkPVObjectWidget.

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

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

---

Member Data Documentation

vtkKWLabel* vtkPVSelectionList::Label [protected]

Definition at line 134 of file vtkPVSelectionList.h.

vtkKWMenuButton* vtkPVSelectionList::Menu [protected]

Definition at line 135 of file vtkPVSelectionList.h.

char* vtkPVSelectionList::Command [protected]

Definition at line 136 of file vtkPVSelectionList.h.

int vtkPVSelectionList::LabelVisibility [protected]

Definition at line 138 of file vtkPVSelectionList.h.

int vtkPVSelectionList::OptionWidth [protected]

Definition at line 139 of file vtkPVSelectionList.h.

int vtkPVSelectionList::CurrentValue [protected]

Definition at line 141 of file vtkPVSelectionList.h.

char* vtkPVSelectionList::CurrentName [protected]

Definition at line 142 of file vtkPVSelectionList.h.

vtkStringList* vtkPVSelectionList::Names [protected]

Definition at line 144 of file vtkPVSelectionList.h.

---

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

• GUI/Client/vtkPVSelectionList.h

---