vtkPVInputMenu Class Reference

#include <vtkPVInputMenu.h>

Inheritance diagram for vtkPVInputMenu:

[legend]Collaboration diagram for vtkPVInputMenu:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVInputMenu, vtkPVWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	Select ()
int	GetNumberOfSources ()
vtkPVSource *	GetSource (int i)
virtual void	ModifiedCallback ()
void	MenuEntryCallback (vtkPVSource *pvs)
virtual void	SaveInBatchScript (ofstream *file)
virtual void	Initialize ()
virtual void	ResetInternal ()
virtual void	Trace (ofstream *file)
virtual void	UpdateEnableState ()
virtual void	Update ()
void	SetLabel (const char *label)
const char *	GetLabel ()
void	SetSources (vtkPVSourceCollection *sources)
vtkPVSourceCollection *	GetSources ()
virtual void	SetInputName (const char *)
void	SetCurrentValue (vtkPVSource *pvs)
vtkPVSource *	GetCurrentValue ()
vtkPVSource *	GetLastAcceptedValue ()
vtkPVInputMenu *	ClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
virtual void	Accept ()
Static Public Member Functions
vtkPVInputMenu *	New ()
Protected Member Functions
	vtkPVInputMenu ()
	~vtkPVInputMenu ()
void	DeleteAllEntries ()
int	AddEntry (vtkPVSource *pvs)
int	CheckForLoop (vtkPVSource *pvs)
int	GetPVInputIndex ()
vtkSMInputProperty *	GetInputProperty ()
void	AddSources (vtkPVSourceCollection *sources)
	vtkPVInputMenu (const vtkPVInputMenu &)
void	operator= (const vtkPVInputMenu &)
virtual void	CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
Protected Attributes
int	InitializeWithCurrent
char *	InputName
vtkPVSource *	CurrentValue
vtkPVSourceCollection *	Sources
vtkKWLabel *	Label
vtkKWMenuButton *	Menu

---

Detailed Description

This menu uses vtkPVSources as entries instead of vtkPVDatas. Use of the first input is hard coded. If we want to allow more than one output, then this widget will have to be changed.

Definition at line 35 of file vtkPVInputMenu.h.

---

Constructor & Destructor Documentation

vtkPVInputMenu::vtkPVInputMenu (   )  [protected]

vtkPVInputMenu::~vtkPVInputMenu (   )  [protected]

vtkPVInputMenu::vtkPVInputMenu (  const vtkPVInputMenu &   )  [protected]

---

Member Function Documentation

vtkPVInputMenu* vtkPVInputMenu::New (   )  [static]

Reimplemented from vtkPVTracedWidget.

vtkPVInputMenu::vtkTypeRevisionMacro (  vtkPVInputMenu  , vtkPVWidget  )

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

Reimplemented from vtkPVWidget.

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

Create the widget. Reimplemented from vtkPVWidget.

void vtkPVInputMenu::SetLabel (  const char *  label  )

Set the label. The label can be used to get this widget from a script.

const char* vtkPVInputMenu::GetLabel (   )

Set the label. The label can be used to get this widget from a script.

void vtkPVInputMenu::SetSources (  vtkPVSourceCollection *  sources  )

This is the source collection as possible inputs. If the collection gets modified, it will be reflected in the menu on the next Reset call. The collection is not referce counted for fear of loops and memory leaks. We may wnet to fix his later.

vtkPVSourceCollection* vtkPVInputMenu::GetSources (   )

This is the source collection as possible inputs. If the collection gets modified, it will be reflected in the menu on the next Reset call. The collection is not referce counted for fear of loops and memory leaks. We may wnet to fix his later.

virtual void vtkPVInputMenu::Select (   )  [virtual]

This method is called when the source that contains this widget is selected. Updates the menu in case more sources have been created Reimplemented from vtkPVWidget.

int vtkPVInputMenu::GetNumberOfSources (   )

vtkPVSource* vtkPVInputMenu::GetSource (  int  i  )

virtual void vtkPVInputMenu::SetInputName (  const char *   )  [virtual]

The input name is usually "Input", but can be something else (i.e. Source). Used to format commands in accept and reset methods.

virtual void vtkPVInputMenu::ModifiedCallback (   )  [virtual]

This method gets called when the user changes the widgets value, or a script changes the widgets value. Ideally, this method should be protected. Input menus have the specifie behaviour that the widgets Accept method is called when ever the input menu is changed. Reimplemented from vtkPVWidget.

void vtkPVInputMenu::SetCurrentValue (  vtkPVSource *  pvs  )

Set the menus value as a string. Used by the Accept and Reset callbacks.

vtkPVSource* vtkPVInputMenu::GetCurrentValue (   )  [inline]

Set the menus value as a string. Used by the Accept and Reset callbacks. Definition at line 86 of file vtkPVInputMenu.h.

vtkPVSource* vtkPVInputMenu::GetLastAcceptedValue (   )

Set the menus value as a string. Used by the Accept and Reset callbacks.

void vtkPVInputMenu::MenuEntryCallback (  vtkPVSource *  pvs  )

Menu callback when an item is selected.

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

Save this widget to a file. Reimplemented from vtkPVWidget.

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

Gets called when the accept button is pressed. This method may add an entry to the trace file. Implements vtkPVWidget.

virtual void vtkPVInputMenu::Initialize (   )  [virtual]

Initializes the input. Implements vtkPVWidget.

virtual void vtkPVInputMenu::ResetInternal (   )  [virtual]

Gets called when the reset button is pressed. Reimplemented from vtkPVWidget.

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

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

virtual void vtkPVInputMenu::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 vtkPVInputMenu::Update (   )  [virtual]

The methods get called when reset is called. It can also get called on its own. If the widget has options or configuration values dependent on the VTK object, this method set these configuation object using the VTK object. Reimplemented from vtkPVWidget.

void vtkPVInputMenu::DeleteAllEntries (   )  [protected]

Reset the menu by taking all entries out.

int vtkPVInputMenu::AddEntry (  vtkPVSource *  pvs  )  [protected]

Add an entry to the menu. If the source is not the right type, then this does nothing. Returns 1 if a new entry was created, 0 if not the right type.

int vtkPVInputMenu::CheckForLoop (  vtkPVSource *  pvs  )  [protected]

When setting input, we have to be carefull not to cause the loop. This code will determine if the operation would cause the loop.

int vtkPVInputMenu::GetPVInputIndex (   )  [protected]

This converts the InputName into an index. SetSource -> SetNthPVInput(idx, ...);

vtkSMInputProperty* vtkPVInputMenu::GetInputProperty (   )  [protected]

Get the property for this input.

void vtkPVInputMenu::AddSources (  vtkPVSourceCollection *  sources  )  [protected]

Adds a collection of sources to the menu. The sources are filtered by "InputType".

void vtkPVInputMenu::operator= (  const vtkPVInputMenu &   )  [protected]

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

Reimplemented from vtkPVWidget.

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

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

---

Member Data Documentation

int vtkPVInputMenu::InitializeWithCurrent [protected]

Definition at line 141 of file vtkPVInputMenu.h.

char* vtkPVInputMenu::InputName [protected]

Definition at line 143 of file vtkPVInputMenu.h.

vtkPVSource* vtkPVInputMenu::CurrentValue [protected]

Definition at line 145 of file vtkPVInputMenu.h.

vtkPVSourceCollection* vtkPVInputMenu::Sources [protected]

Definition at line 146 of file vtkPVInputMenu.h.

vtkKWLabel* vtkPVInputMenu::Label [protected]

Definition at line 148 of file vtkPVInputMenu.h.

vtkKWMenuButton* vtkPVInputMenu::Menu [protected]

Definition at line 149 of file vtkPVInputMenu.h.

---

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

• GUI/Client/vtkPVInputMenu.h

---