vtkKWMessageDialog Class Reference

a message dialog superclass More...

#include <vtkKWMessageDialog.h>

Inheritance diagram for vtkKWMessageDialog:

[legend]

Collaboration diagram for vtkKWMessageDialog:

[legend]

List of all members.

Public Types
typedef vtkKWDialog	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetText (const char *)
virtual void	Display ()
virtual void	Other ()
virtual void	SetIcon ()
Static Public Member Functions
static vtkKWMessageDialog *	New ()
static int	IsTypeOf (const char *type)
static vtkKWMessageDialog *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWMessageDialog ()
	~vtkKWMessageDialog ()
virtual void	CreateWidget ()
virtual void	SetDialogText (const char *)
virtual char *	GetDialogText ()
int	GetRememberMessage ()
virtual void	Pack ()
Protected Attributes
int	Style
int	Default
int	Options
char *	DialogName
char *	DialogText
vtkKWFrame *	TopFrame
vtkKWFrame *	MessageDialogFrame
vtkKWFrame *	BottomFrame
vtkKWMessage *	Message
vtkKWFrame *	ButtonFrame
vtkKWPushButton *	OKButton
vtkKWPushButton *	CancelButton
vtkKWPushButton *	OtherButton
vtkKWLabel *	Icon
vtkKWFrame *	OKFrame
vtkKWFrame *	CancelFrame
vtkKWFrame *	OtherFrame
vtkKWCheckButton *	CheckButton
char *	OKButtonText
char *	CancelButtonText
char *	OtherButtonText

enum	{ StatusOther = 100 }
enum	{ StyleMessage = 0, StyleYesNo, StyleOkCancel, StyleOkOtherCancel, StyleCancel }
enum	{ RememberYes = 0x00002, RememberNo = 0x00004, ErrorIcon = 0x00008, WarningIcon = 0x00010, QuestionIcon = 0x00020, YesDefault = 0x00040, NoDefault = 0x00080, OkDefault = 0x00100, CancelDefault = 0x00200, Beep = 0x00400, PackVertically = 0x00800, InvokeAtPointer = 0x01000, CustomIcon = 0x02000, Resizable = 0x04000 }
static void	PopupMessage (vtkKWApplication app, vtkKWWidget masterWin, const char title, const char message, int options=0)
static int	PopupYesNo (vtkKWApplication app, vtkKWWidget masterWin, const char title, const char message, int options=0)
static int	PopupYesNo (vtkKWApplication app, vtkKWWidget masterWin, const char name, const char title, const char *message, int options=0)
static int	PopupOkCancel (vtkKWApplication app, vtkKWWidget masterWin, const char title, const char message, int options=0)
static int	RestoreMessageDialogResponseFromRegistry (vtkKWApplication app, const char dialogname)
static void	SaveMessageDialogResponseToRegistry (vtkKWApplication app, const char dialogname, int response)
virtual void	SetTextWidth (int)
virtual int	GetTextWidth ()
virtual void	SetStyle (int)
virtual int	GetStyle ()
void	SetStyleToMessage ()
void	SetStyleToYesNo ()
void	SetStyleToOkCancel ()
void	SetStyleToOkOtherCancel ()
void	SetStyleToCancel ()
virtual void	SetOptions (int)
virtual int	GetOptions ()
virtual void	SetOKButtonText (const char *)
virtual char *	GetOKButtonText ()
virtual void	SetCancelButtonText (const char *)
virtual char *	GetCancelButtonText ()
virtual void	SetOtherButtonText (const char *)
virtual char *	GetOtherButtonText ()
virtual vtkKWFrame *	GetTopFrame ()
virtual vtkKWFrame *	GetMessageDialogFrame ()
virtual vtkKWFrame *	GetBottomFrame ()
virtual vtkKWLabel *	GetIcon ()
virtual vtkKWPushButton *	GetOKButton ()
virtual vtkKWPushButton *	GetCancelButton ()
virtual vtkKWPushButton *	GetOtherButton ()
virtual void	SetDialogName (const char *)
virtual char *	GetDialogName ()
virtual int	PreInvoke ()
virtual void	PostInvoke ()
virtual void	UpdateButtons ()
virtual void	PackButtons ()
virtual void	UpdateMessage ()

Detailed Description

a message dialog superclass

A generic superclass for MessageDialog boxes.

Events:: vtkKWEvent::MessageDialogInvokeEvent

Definition at line 35 of file vtkKWMessageDialog.h.

Member Typedef Documentation

typedef vtkKWDialog vtkKWMessageDialog::Superclass

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

Definition at line 40 of file vtkKWMessageDialog.h.

Member Enumeration Documentation

anonymous enum

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

Enumerator:

StatusOther

Definition at line 56 of file vtkKWMessageDialog.h.

anonymous enum

Set the style of the message box. No effect if called after Create() BTX

Enumerator:

StyleMessage
StyleYesNo
StyleOkCancel
StyleOkOtherCancel
StyleCancel

Definition at line 66 of file vtkKWMessageDialog.h.

anonymous enum

Set different options for the dialog. BTX

Enumerator:

RememberYes
RememberNo
ErrorIcon
WarningIcon
QuestionIcon
YesDefault
NoDefault
OkDefault
CancelDefault
Beep
PackVertically
InvokeAtPointer
CustomIcon
Resizable

Definition at line 86 of file vtkKWMessageDialog.h.

Constructor & Destructor Documentation

vtkKWMessageDialog::vtkKWMessageDialog ( ) [protected]

vtkKWMessageDialog::~vtkKWMessageDialog ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

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

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

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

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

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

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

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

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

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

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

virtual void vtkKWMessageDialog::SetText ( const char * ) [virtual]

Set the text of the message

virtual void vtkKWMessageDialog::SetTextWidth ( int ) [virtual]

Set/Get the width of the message, in pixels)

virtual int vtkKWMessageDialog::GetTextWidth ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::SetStyle ( int ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual int vtkKWMessageDialog::GetStyle ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

void vtkKWMessageDialog::SetStyleToMessage ( )

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

void vtkKWMessageDialog::SetStyleToYesNo ( )

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

void vtkKWMessageDialog::SetStyleToOkCancel ( )

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

void vtkKWMessageDialog::SetStyleToOkOtherCancel ( )

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

void vtkKWMessageDialog::SetStyleToCancel ( )

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::SetOptions ( int ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual int vtkKWMessageDialog::GetOptions ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::SetOKButtonText ( const char * ) [virtual]

The label displayed on the OK button. Only used when the style is OkCancel.

virtual char* vtkKWMessageDialog::GetOKButtonText ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::SetCancelButtonText ( const char * ) [virtual]

The label displayed on the cancel button. Only used when the style is OkCancel.

virtual char* vtkKWMessageDialog::GetCancelButtonText ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::SetOtherButtonText ( const char * ) [virtual]

The label displayed on the other button. Only used when the style is OkOtherCancel.

virtual char* vtkKWMessageDialog::GetOtherButtonText ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

static void vtkKWMessageDialog::PopupMessage	(	vtkKWApplication *	app,
		vtkKWWidget *	masterWin,
		const char *	title,
		const char *	message,
		int	options = `0`
	)			`[static]`

Utility methods to create various dialog windows. icon is a enumerated icon type described in vtkKWIcon. title is a title string of the dialog. name is the dialog name used for the registry. message is the text message displayed in the dialog. masterwin is a pointer to a widget belonging to the window you want this message dialog to be a child of (or the window directly).

static int vtkKWMessageDialog::PopupYesNo	(	vtkKWApplication *	app,
		vtkKWWidget *	masterWin,
		const char *	title,
		const char *	message,
		int	options = `0`
	)			`[static]`

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

static int vtkKWMessageDialog::PopupYesNo	(	vtkKWApplication *	app,
		vtkKWWidget *	masterWin,
		const char *	name,
		const char *	title,
		const char *	message,
		int	options = `0`
	)			`[static]`

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

static int vtkKWMessageDialog::PopupOkCancel	(	vtkKWApplication *	app,
		vtkKWWidget *	masterWin,
		const char *	title,
		const char *	message,
		int	options = `0`
	)			`[static]`

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual vtkKWFrame* vtkKWMessageDialog::GetTopFrame ( ) [virtual]

Retrieve the frame where the message is.

virtual vtkKWFrame* vtkKWMessageDialog::GetMessageDialogFrame ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual vtkKWFrame* vtkKWMessageDialog::GetBottomFrame ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual vtkKWLabel* vtkKWMessageDialog::GetIcon ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual vtkKWPushButton* vtkKWMessageDialog::GetOKButton ( ) [virtual]

Accessor for OK and cancel button

virtual vtkKWPushButton* vtkKWMessageDialog::GetCancelButton ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual vtkKWPushButton* vtkKWMessageDialog::GetOtherButton ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::SetDialogName ( const char * ) [virtual]

Set or get the message dialog name. This name is use to save/restore information about this specific dialog in the registry (for example, bypass the dialog altogether by clicking on a specific button automatically). This should not be confused with the message dialog title that can be set using the superclass SetTitle() method.

virtual char* vtkKWMessageDialog::GetDialogName ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

static int vtkKWMessageDialog::RestoreMessageDialogResponseFromRegistry	(	vtkKWApplication *	app,
		const char *	dialogname
	)			`[static]`

Store/retrieve a message dialog response for a given application in/from the registry. This can be used to prevent the user from answering the same question again and again (for ex: "Are you sure you want to exit the application"). 'dialogname' is the name of a dialog (most likely its DialogName ivar). The 'response' is arbitrary but most likely the value returned by a call to Invoke() on the dialog.

static void vtkKWMessageDialog::SaveMessageDialogResponseToRegistry	(	vtkKWApplication *	app,
		const char *	dialogname,
		int	response
	)			`[static]`

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::Display ( ) [virtual]

Display the dialog. Override the superclass to set up keybindings and options

Reimplemented from vtkKWDialog.

virtual int vtkKWMessageDialog::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(). Override the superclass to handle DialogName

Reimplemented from vtkKWDialog.

virtual void vtkKWMessageDialog::PostInvoke ( ) [virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

Reimplemented from vtkKWDialog.

virtual void vtkKWMessageDialog::Other ( ) [virtual]

Callback. Close this Dialog (for the third button)

virtual void vtkKWMessageDialog::SetIcon ( ) [virtual]

Set the icon on the message dialog. Legacy. Do not call anymore. Is called automatically by Create().

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

Create the widget.

Reimplemented from vtkKWDialog.

Reimplemented in vtkKWLogDialog, and vtkKWSimpleEntryDialog.

virtual void vtkKWMessageDialog::SetDialogText ( const char * ) [protected, virtual]

virtual char* vtkKWMessageDialog::GetDialogText ( ) [protected, virtual]

int vtkKWMessageDialog::GetRememberMessage ( ) [protected]

Get the value of the check box for remembering the answer from the user.

virtual void vtkKWMessageDialog::UpdateButtons ( ) [protected, virtual]

Update the buttons or message

virtual void vtkKWMessageDialog::PackButtons ( ) [protected, virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::UpdateMessage ( ) [protected, virtual]

Status of the dialog. This subclass defines a new 'Other' status on top of the usual one (active e.g. displayed, canceled, OK'ed). This status is triggered by pressing the 'Other' button. BTX

virtual void vtkKWMessageDialog::Pack ( ) [protected, virtual]

Pack

Reimplemented in vtkKWSimpleEntryDialog.