vtkKWLoadSaveButton Class Reference

a button that triggers a load/save dialog More...

#include <vtkKWLoadSaveButton.h>

Inheritance diagram for vtkKWLoadSaveButton:

[legend]

Collaboration diagram for vtkKWLoadSaveButton:

[legend]

List of all members.

Public Types
typedef vtkKWPushButton	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetFileName ()
virtual void	SetInitialFileName (const char *path)
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWLoadSaveButton *	New ()
static int	IsTypeOf (const char *type)
static vtkKWLoadSaveButton *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWLoadSaveButton ()
	~vtkKWLoadSaveButton ()
virtual void	CreateWidget ()
virtual void	UpdateTextFromFileName ()
virtual void	InvokeCommand ()
Protected Attributes
vtkKWLoadSaveDialog *	LoadSaveDialog
int	TrimPathFromFileName
int	MaximumFileNameLength

virtual vtkKWLoadSaveDialog *	GetLoadSaveDialog ()
virtual void	SetMaximumFileNameLength (int)
virtual int	GetMaximumFileNameLength ()
virtual void	SetTrimPathFromFileName (int)
virtual void	TrimPathFromFileNameOn ()
virtual void	TrimPathFromFileNameOff ()
virtual int	GetTrimPathFromFileName ()
virtual void	AddCallbackCommandObservers ()
virtual void	RemoveCallbackCommandObservers ()
virtual void	ProcessCallbackCommandEvents (vtkObject caller, unsigned long event, void calldata)

Detailed Description

a button that triggers a load/save dialog

The vtkKWLoadSaveButton class creates a push button that will popup a vtkKWLoadSaveDialog and display the chosen filename as the button label. Note that if the dialog is cancelled, the button will not be reset to an empty string, therefore reflecting the previously selected file, if any (which is the more logical behavior).

See also:: vtkKWLoadSaveButtonWithLabel

Definition at line 33 of file vtkKWLoadSaveButton.h.

Member Typedef Documentation

typedef vtkKWPushButton vtkKWLoadSaveButton::Superclass

Reimplemented from vtkKWPushButton.

Definition at line 38 of file vtkKWLoadSaveButton.h.

Constructor & Destructor Documentation

vtkKWLoadSaveButton::vtkKWLoadSaveButton ( ) [protected]

vtkKWLoadSaveButton::~vtkKWLoadSaveButton ( ) [protected]

Member Function Documentation

static vtkKWLoadSaveButton* vtkKWLoadSaveButton::New ( ) [static]

Reimplemented from vtkKWPushButton.

virtual const char* vtkKWLoadSaveButton::GetClassName ( ) [virtual]

Reimplemented from vtkKWPushButton.

static int vtkKWLoadSaveButton::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWPushButton.

virtual int vtkKWLoadSaveButton::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWPushButton.

static vtkKWLoadSaveButton* vtkKWLoadSaveButton::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWPushButton.

void vtkKWLoadSaveButton::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkKWPushButton.

virtual vtkKWLoadSaveDialog* vtkKWLoadSaveButton::GetLoadSaveDialog ( ) [virtual]

Access to sub-widgets. Important: the LoadSaveDialog is created automatically the first time the button is pressed, for efficiency reasons. While you can still use the dialog object and invoke methods on it before the button is invoked, some methods may require the LoadSaveDialog to be created already; if that is the case, just call Create() on the dialog object manually.

virtual const char* vtkKWLoadSaveButton::GetFileName ( ) [virtual]

Retrieve the filename. This method only query the GetFileName method on the LoadSaveDialog member.

virtual void vtkKWLoadSaveButton::SetInitialFileName ( const char * path ) [virtual]

Set up the initial file name for the button, and the last path and initial file name (for the file name entry) of the internal File Brower dialog

virtual void vtkKWLoadSaveButton::SetMaximumFileNameLength ( int ) [virtual]

Set/Get the length of the filename when displayed in the button. If set to 0, do not shorten the filename.

virtual int vtkKWLoadSaveButton::GetMaximumFileNameLength ( ) [virtual]

Access to sub-widgets. Important: the LoadSaveDialog is created automatically the first time the button is pressed, for efficiency reasons. While you can still use the dialog object and invoke methods on it before the button is invoked, some methods may require the LoadSaveDialog to be created already; if that is the case, just call Create() on the dialog object manually.

virtual void vtkKWLoadSaveButton::SetTrimPathFromFileName ( int ) [virtual]

Set/Get if the path of the filename should be trimmed when displayed in the button.

virtual void vtkKWLoadSaveButton::TrimPathFromFileNameOn ( ) [virtual]

Access to sub-widgets. Important: the LoadSaveDialog is created automatically the first time the button is pressed, for efficiency reasons. While you can still use the dialog object and invoke methods on it before the button is invoked, some methods may require the LoadSaveDialog to be created already; if that is the case, just call Create() on the dialog object manually.

virtual void vtkKWLoadSaveButton::TrimPathFromFileNameOff ( ) [virtual]

Access to sub-widgets. Important: the LoadSaveDialog is created automatically the first time the button is pressed, for efficiency reasons. While you can still use the dialog object and invoke methods on it before the button is invoked, some methods may require the LoadSaveDialog to be created already; if that is the case, just call Create() on the dialog object manually.

virtual int vtkKWLoadSaveButton::GetTrimPathFromFileName ( ) [virtual]

Access to sub-widgets. Important: the LoadSaveDialog is created automatically the first time the button is pressed, for efficiency reasons. While you can still use the dialog object and invoke methods on it before the button is invoked, some methods may require the LoadSaveDialog to be created already; if that is the case, just call Create() on the dialog object manually.

virtual void vtkKWLoadSaveButton::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 vtkKWPushButton.

virtual void vtkKWLoadSaveButton::AddCallbackCommandObservers ( ) [virtual]

Add all the default observers needed by that object, or remove all the observers that were added through AddCallbackCommandObserver. Subclasses can override these methods to add/remove their own default observers, but should call the superclass too.

Reimplemented from vtkKWObject.

virtual void vtkKWLoadSaveButton::RemoveCallbackCommandObservers ( ) [virtual]

Access to sub-widgets. Important: the LoadSaveDialog is created automatically the first time the button is pressed, for efficiency reasons. While you can still use the dialog object and invoke methods on it before the button is invoked, some methods may require the LoadSaveDialog to be created already; if that is the case, just call Create() on the dialog object manually.

Reimplemented from vtkKWObject.

virtual void vtkKWLoadSaveButton::CreateWidget ( ) [protected, virtual]

Create the widget.

Reimplemented from vtkKWPushButton.

virtual void vtkKWLoadSaveButton::UpdateTextFromFileName ( ) [protected, virtual]

virtual void vtkKWLoadSaveButton::InvokeCommand ( ) [protected, virtual]

Reimplemented from vtkKWPushButton.

virtual void vtkKWLoadSaveButton::ProcessCallbackCommandEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	calldata
	)			`[protected, virtual]`

Processes the events that are passed through CallbackCommand (or others). Subclasses can oberride this method to process their own events, but should call the superclass too.

Reimplemented from vtkKWObject.