vtkKWDialog Class Reference

dialog box superclass More...

#include <vtkKWDialog.h>

Inheritance diagram for vtkKWDialog:

[legend]

Collaboration diagram for vtkKWDialog:

[legend]

List of all members.

Public Types
typedef vtkKWTopLevel	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	Invoke ()
virtual void	Display ()
vtkKWWidget *	GetFrame ()
virtual void	Cancel ()
virtual void	OK ()
Static Public Member Functions
static vtkKWDialog *	New ()
static int	IsTypeOf (const char *type)
static vtkKWDialog *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWDialog ()
	~vtkKWDialog ()
virtual void	CreateWidget ()
Protected Attributes
int	Done
int	Beep

enum	{ StatusActive = 0, StatusCanceled = 1, StatusOK = 2 }
int	GetStatus ()
virtual void	SetBeep (int)
virtual void	BeepOn ()
virtual void	BeepOff ()
virtual int	GetBeep ()
virtual int	PreInvoke ()
virtual void	PostInvoke ()
virtual int	IsUserDoneWithDialog ()

Detailed Description

dialog box superclass

A generic superclass for dialog boxes. This is a toplevel that is modal by default, and centered in its master window (or on screen)

Definition at line 27 of file vtkKWDialog.h.

Member Typedef Documentation

typedef vtkKWTopLevel vtkKWDialog::Superclass

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLoadSaveDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.

Definition at line 32 of file vtkKWDialog.h.

Member Enumeration Documentation

anonymous enum

Status of the dialog (active e.g. displayed, canceled, OK'ed) BTX

Enumerator:

StatusActive
StatusCanceled
StatusOK

Definition at line 50 of file vtkKWDialog.h.

Constructor & Destructor Documentation

vtkKWDialog::vtkKWDialog ( ) [protected]

vtkKWDialog::~vtkKWDialog ( ) [inline, protected]

Definition at line 91 of file vtkKWDialog.h.

Member Function Documentation

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLoadSaveDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLoadSaveDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLoadSaveDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLoadSaveDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLoadSaveDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.

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

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLoadSaveDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.

virtual int vtkKWDialog::Invoke ( ) [virtual]

Invoke the dialog, display it and enter an event loop until the user confirms or cancels the dialog. Create() will be called automatically by PreInvoke() if the dialog has not been Create'd() yet. Note that a dialog is a modal toplevel by default. This method returns 0 if the dialog was killed or canceled, 1 otherwise. The status can be further refined by querying GetStatus().

Reimplemented in vtkKWSaveImageDialog, and vtkKWSimpleEntryDialog.

virtual void vtkKWDialog::Display ( ) [virtual]

Display the dialog. Create() will be called automatically if the dialog has not been Create'd() yet. Note that a dialog is a modal toplevel by default.

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, and vtkKWMessageDialog.

int vtkKWDialog::GetStatus ( ) [inline]

Status of the dialog (active e.g. displayed, canceled, OK'ed) BTX

Definition at line 57 of file vtkKWDialog.h.

vtkKWWidget* vtkKWDialog::GetFrame ( ) [inline]

Return frame to pack into.

Definition at line 61 of file vtkKWDialog.h.

virtual void vtkKWDialog::SetBeep ( int ) [virtual]

Play beep when the dialog is displayed

virtual void vtkKWDialog::BeepOn ( ) [virtual]

Status of the dialog (active e.g. displayed, canceled, OK'ed) BTX

virtual void vtkKWDialog::BeepOff ( ) [virtual]

Status of the dialog (active e.g. displayed, canceled, OK'ed) BTX

virtual int vtkKWDialog::GetBeep ( ) [virtual]

Status of the dialog (active e.g. displayed, canceled, OK'ed) BTX

virtual void vtkKWDialog::Cancel ( ) [virtual]

Callback. Cancel the action and close this dialog

Reimplemented in vtkKWFileBrowserDialog.

virtual void vtkKWDialog::OK ( ) [virtual]

Callback. Confirm the action and close this dialog

Reimplemented in vtkKWColorPickerDialog, and vtkKWFileBrowserDialog.

virtual int vtkKWDialog::PreInvoke ( ) [virtual]

Dialog can be also used by performing individual steps of Invoke. These steps are initialize: PreInvoke(), finalize: PostInvoke(), and check if user responded IsUserDoneWithDialog(). Use this method only if you want to bypass the event loop used in Invoke() by creating your own and checking for IsUserDoneWithDialog().

Reimplemented in vtkKWMessageDialog.

virtual void vtkKWDialog::PostInvoke ( ) [virtual]

Status of the dialog (active e.g. displayed, canceled, OK'ed) BTX

Reimplemented in vtkKWMessageDialog.

virtual int vtkKWDialog::IsUserDoneWithDialog ( ) [virtual]

Status of the dialog (active e.g. displayed, canceled, OK'ed) BTX

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

Create the widget.

Reimplemented from vtkKWTopLevel.

Reimplemented in vtkKWColorPickerDialog, vtkKWFileBrowserDialog, vtkKWLogDialog, vtkKWMessageDialog, vtkKWSaveImageDialog, vtkKWSimpleEntryDialog, and vtkKWWizardDialog.