vtkPVFileEntry Class Reference

#include <vtkPVFileEntry.h>

Inheritance diagram for vtkPVFileEntry:

[legend]Collaboration diagram for vtkPVFileEntry:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVFileEntry, vtkPVObjectWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *pvApp)
void	BrowseCallback ()
virtual void	SetBalloonHelpString (const char *str)
virtual void	ResetInternal ()
virtual void	Initialize ()
virtual void	Trace (ofstream *file)
void	EntryChangedCallback ()
void	TimestepChangedCallback ()
void	SetTimeStep (int ts)
virtual int	GetNumberOfFiles ()
void	ExecuteEvent (vtkObject *o, unsigned long event, void *calldata)
virtual void	UpdateEnableState ()
virtual void	SaveInBatchScript (ofstream *file)
void	SetLabel (const char *label)
const char *	GetLabel ()
virtual void	SetValue (const char *fileName)
const char *	GetValue ()
virtual void	SetExtension (const char *)
virtual char *	GetExtension ()
vtkPVFileEntry *	ClonePrototype (vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
virtual void	Accept ()
void	UpdateAvailableFiles ()
void	UpdateAvailableFiles (int force)
Static Public Member Functions
vtkPVFileEntry *	New ()
Protected Member Functions
	vtkPVFileEntry ()
	~vtkPVFileEntry ()
virtual void	SetPath (const char *)
virtual void	CopyProperties (vtkPVWidget *clone, vtkPVSource *pvSource, vtkArrayMap< vtkPVWidget *, vtkPVWidget * > *map)
int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
void	UpdateTimeStep ()
void	UpdateTimesteps ()
Protected Attributes
vtkKWLabel *	LabelWidget
vtkKWPushButton *	BrowseButton
vtkKWEntry *	Entry
char *	Extension
int	InSetValue
vtkKWFrame *	TimestepFrame
vtkKWScaleWithEntry *	Timestep
int	TimeStep
char *	Path
int	IgnoreFileListEvents
vtkPVListBoxToListBoxSelectionEditor *	FileListSelect
vtkKWPopupButton *	FileListPopup
unsigned long	ListObserverTag
vtkPVFileEntryObserver *	Observer
int	Initialized

---

Constructor & Destructor Documentation

vtkPVFileEntry::vtkPVFileEntry (   )  [protected]

vtkPVFileEntry::~vtkPVFileEntry (   )  [protected]

---

Member Function Documentation

vtkPVFileEntry* vtkPVFileEntry::New (   )  [static]

Reimplemented from vtkPVTracedWidget.

vtkPVFileEntry::vtkTypeRevisionMacro (  vtkPVFileEntry  , vtkPVObjectWidget  )

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

Reimplemented from vtkPVObjectWidget.

void vtkPVFileEntry::SetLabel (  const char *  label  )

The label can be set before or after create is called.

const char* vtkPVFileEntry::GetLabel (   )

The label can be set before or after create is called.

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

Create the widget. Reimplemented from vtkPVWidget.

virtual void vtkPVFileEntry::SetValue (  const char *  fileName  )  [virtual]

This method allows scripts to modify the widgets value.

const char* vtkPVFileEntry::GetValue (   )

This method allows scripts to modify the widgets value.

void vtkPVFileEntry::BrowseCallback (   )

Called when the browse button is pressed.

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

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

virtual void vtkPVFileEntry::SetExtension (  const char *   )  [virtual]

The extension used in the file dialog

virtual char* vtkPVFileEntry::GetExtension (   )  [virtual]

The extension used in the file dialog

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

Called when accept button is pushed. Sets objects variable to the widgets value. Side effect is to turn modified flag off. Implements vtkPVWidget.

virtual void vtkPVFileEntry::ResetInternal (   )  [virtual]

Called when the reset button is pushed. Sets widget's value to the object-variable's value. Side effect is to turn the modified flag off. Reimplemented from vtkPVWidget.

virtual void vtkPVFileEntry::Initialize (   )  [virtual]

Initialize widget after creation Implements vtkPVWidget.

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

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

void vtkPVFileEntry::EntryChangedCallback (   )

This callback is called when entry changes.

void vtkPVFileEntry::TimestepChangedCallback (   )

This callback is called when timestep changes.

void vtkPVFileEntry::SetTimeStep (  int  ts  )

Set the current time step.

virtual int vtkPVFileEntry::GetNumberOfFiles (   )  [virtual]

Get the number of files

void vtkPVFileEntry::ExecuteEvent (  vtkObject *  o, unsigned long  event, void *  calldata )  [virtual]

For event handling. Reimplemented from vtkPVWidget.

void vtkPVFileEntry::UpdateAvailableFiles (   )  [inline]

Callback for Timesteps button Definition at line 120 of file vtkPVFileEntry.h.

void vtkPVFileEntry::UpdateAvailableFiles (  int  force  )

Callback for Timesteps button

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

Save this widget to a file. Implements vtkPVObjectWidget.

virtual void vtkPVFileEntry::SetPath (  const char *   )  [protected, virtual]

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

Reimplemented from vtkPVObjectWidget.

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

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

void vtkPVFileEntry::UpdateTimeStep (   )  [protected]

void vtkPVFileEntry::UpdateTimesteps (   )  [protected]

This method determines if the timesteps selected are valid or must be discarded. This happends when the user changes the file name of the file name or file prefix entry to something that is not in the list of timesteps, implying that the user wants to load a new dataset.

---

Member Data Documentation

vtkKWLabel* vtkPVFileEntry::LabelWidget [protected]

Definition at line 139 of file vtkPVFileEntry.h.

vtkKWPushButton* vtkPVFileEntry::BrowseButton [protected]

Definition at line 140 of file vtkPVFileEntry.h.

vtkKWEntry* vtkPVFileEntry::Entry [protected]

Definition at line 141 of file vtkPVFileEntry.h.

char* vtkPVFileEntry::Extension [protected]

Definition at line 143 of file vtkPVFileEntry.h.

int vtkPVFileEntry::InSetValue [protected]

Definition at line 144 of file vtkPVFileEntry.h.

vtkKWFrame* vtkPVFileEntry::TimestepFrame [protected]

Definition at line 147 of file vtkPVFileEntry.h.

vtkKWScaleWithEntry* vtkPVFileEntry::Timestep [protected]

Definition at line 148 of file vtkPVFileEntry.h.

int vtkPVFileEntry::TimeStep [protected]

Definition at line 149 of file vtkPVFileEntry.h.

char* vtkPVFileEntry::Path [protected]

Definition at line 152 of file vtkPVFileEntry.h.

int vtkPVFileEntry::IgnoreFileListEvents [protected]

Definition at line 154 of file vtkPVFileEntry.h.

vtkPVListBoxToListBoxSelectionEditor* vtkPVFileEntry::FileListSelect [protected]

Definition at line 156 of file vtkPVFileEntry.h.

vtkKWPopupButton* vtkPVFileEntry::FileListPopup [protected]

Definition at line 157 of file vtkPVFileEntry.h.

unsigned long vtkPVFileEntry::ListObserverTag [protected]

Definition at line 167 of file vtkPVFileEntry.h.

vtkPVFileEntryObserver* vtkPVFileEntry::Observer [protected]

Reimplemented from vtkPVWidget. Definition at line 168 of file vtkPVFileEntry.h.

int vtkPVFileEntry::Initialized [protected]

Definition at line 178 of file vtkPVFileEntry.h.

---

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

• GUI/Client/vtkPVFileEntry.h

---