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.

[NOHEADER]
enum	{   StyleMessage = 0, StyleYesNo, StyleOkCancel, StyleOkOtherCancel,   StyleCancel }
virtual void	SetStyle (int)
virtual int	GetStyle ()
void	SetStyleToMessage ()
void	SetStyleToYesNo ()
void	SetStyleToOkCancel ()
void	SetStyleToOkOtherCancel ()
void	SetStyleToCancel ()
[NOHEADER]
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 }
virtual void	SetOptions (int)
virtual int	GetOptions ()
Public Types
Public Member Functions
	vtkTypeRevisionMacro (vtkKWMessageDialog, vtkKWDialog)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	SetIcon ()
virtual void	Other ()
virtual void	SetText (const char *)
virtual void	SetTextWidth (int)
virtual int	GetTextWidth ()
virtual void	SetDialogName (const char *)
virtual char *	GetDialogName ()
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 vtkKWPushButton *	GetOKButton ()
virtual vtkKWPushButton *	GetCancelButton ()
virtual vtkKWPushButton *	GetOtherButton ()
virtual int	PreInvoke ()
virtual void	PostInvoke ()
Static Public Member Functions
vtkKWMessageDialog *	New ()
void	PopupMessage (vtkKWApplication *app, vtkKWWindowBase *masterWin, const char *title, const char *message, int options=0)
int	PopupYesNo (vtkKWApplication *app, vtkKWWindowBase *masterWin, const char *title, const char *message, int options=0)
int	PopupYesNo (vtkKWApplication *app, vtkKWWindowBase *masterWin, const char *name, const char *title, const char *message, int options=0)
int	PopupOkCancel (vtkKWApplication *app, vtkKWWindowBase *masterWin, const char *title, const char *message, int options=0)
int	RestoreMessageDialogResponseFromRegistry (vtkKWApplication *app, const char *dialogname)
void	SaveMessageDialogResponseToRegistry (vtkKWApplication *app, const char *dialogname, int response)
Protected Member Functions
	vtkKWMessageDialog ()
	~vtkKWMessageDialog ()
virtual void	SetDialogText (const char *)
virtual char *	GetDialogText ()
int	GetRememberMessage ()
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

---

Detailed Description

a message dialog superclass

A generic superclass for MessageDialog boxes.

Definition at line 32 of file vtkKWMessageDialog.h.

---

Member Enumeration Documentation

anonymous enum

Set the style of the message box BTX Enumeration values: StyleMessage  StyleYesNo  StyleOkCancel  StyleOkOtherCancel  StyleCancel  Definition at line 51 of file vtkKWMessageDialog.h.

anonymous enum

Set different options for the dialog. BTX Enumeration values: RememberYes  RememberNo  ErrorIcon  WarningIcon  QuestionIcon  YesDefault  NoDefault  OkDefault  CancelDefault  Beep  PackVertically  InvokeAtPointer  Definition at line 82 of file vtkKWMessageDialog.h.

---

Constructor & Destructor Documentation

vtkKWMessageDialog::vtkKWMessageDialog (   )  [protected]

vtkKWMessageDialog::~vtkKWMessageDialog (   )  [protected]

---

Member Function Documentation

vtkKWMessageDialog* vtkKWMessageDialog::New (   )  [static]

Reimplemented from vtkKWDialog. Reimplemented in vtkKWSimpleEntryDialog, vtkPVConnectDialog, vtkPVSelectCustomReader, and vtkPVTraceFileDialog.

vtkKWMessageDialog::vtkTypeRevisionMacro (  vtkKWMessageDialog  , vtkKWDialog  )

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

Reimplemented from vtkKWDialog. Reimplemented in vtkKWSimpleEntryDialog, vtkPVConnectDialog, vtkPVSelectCustomReader, and vtkPVTraceFileDialog.

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

Create the widget. Reimplemented from vtkKWDialog. Reimplemented in vtkKWSimpleEntryDialog, vtkPVConnectDialog, and vtkPVTraceFileDialog.

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

Set the text of the message (and the width of a line, in pixels)

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

Set the text of the message (and the width of a line, in pixels)

virtual int vtkKWMessageDialog::GetTextWidth (   )  [virtual]

Set the text of the message (and the width of a line, in pixels)

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

Set the style of the message box BTX

virtual int vtkKWMessageDialog::GetStyle (   )  [virtual]

Set the style of the message box BTX

void vtkKWMessageDialog::SetStyleToMessage (   )  [inline]

Set the style of the message box BTX Definition at line 62 of file vtkKWMessageDialog.h. References StyleMessage.

void vtkKWMessageDialog::SetStyleToYesNo (   )  [inline]

Set the style of the message box BTX Definition at line 64 of file vtkKWMessageDialog.h. References StyleYesNo.

void vtkKWMessageDialog::SetStyleToOkCancel (   )  [inline]

Set the style of the message box BTX Definition at line 66 of file vtkKWMessageDialog.h. References StyleOkCancel.

void vtkKWMessageDialog::SetStyleToOkOtherCancel (   )  [inline]

Set the style of the message box BTX Definition at line 68 of file vtkKWMessageDialog.h. References StyleOkOtherCancel.

void vtkKWMessageDialog::SetStyleToCancel (   )  [inline]

Set the style of the message box BTX Definition at line 70 of file vtkKWMessageDialog.h. References StyleCancel.

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

Set or get the message dialog name

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

Set or get the message dialog name

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

Set different options for the dialog. BTX

virtual int vtkKWMessageDialog::GetOptions (   )  [virtual]

Set different options for the dialog. 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]

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

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]

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

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]

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

void vtkKWMessageDialog::PopupMessage (  vtkKWApplication *  app, vtkKWWindowBase *  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.

int vtkKWMessageDialog::PopupYesNo (  vtkKWApplication *  app, vtkKWWindowBase *  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.

int vtkKWMessageDialog::PopupYesNo (  vtkKWApplication *  app, vtkKWWindowBase *  masterWin, const char *  name, 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.

int vtkKWMessageDialog::PopupOkCancel (  vtkKWApplication *  app, vtkKWWindowBase *  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.

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

Retrieve the frame where the message is.

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

Retrieve the frame where the message is.

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

Retrieve the frame where the message is.

virtual void vtkKWMessageDialog::SetIcon (   )  [virtual]

Set the icon on the message dialog.

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

Accessor for OK and cancel button

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

Accessor for OK and cancel button

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

Accessor for OK and cancel button

virtual void vtkKWMessageDialog::Other (   )  [virtual]

Close this Dialog (for the third button)

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

Convenience static method to 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.

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

Convenience static method to 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.

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(). Reimplemented from vtkKWDialog.

virtual void vtkKWMessageDialog::PostInvoke (   )  [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 from vtkKWDialog.

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.

---

Member Data Documentation

int vtkKWMessageDialog::Style [protected]

Definition at line 191 of file vtkKWMessageDialog.h.

int vtkKWMessageDialog::Default [protected]

Definition at line 192 of file vtkKWMessageDialog.h.

int vtkKWMessageDialog::Options [protected]

Definition at line 193 of file vtkKWMessageDialog.h.

char* vtkKWMessageDialog::DialogName [protected]

Definition at line 194 of file vtkKWMessageDialog.h.

char* vtkKWMessageDialog::DialogText [protected]

Definition at line 195 of file vtkKWMessageDialog.h.

vtkKWFrame* vtkKWMessageDialog::TopFrame [protected]

Definition at line 200 of file vtkKWMessageDialog.h.

vtkKWFrame* vtkKWMessageDialog::MessageDialogFrame [protected]

Definition at line 201 of file vtkKWMessageDialog.h.

vtkKWFrame* vtkKWMessageDialog::BottomFrame [protected]

Definition at line 202 of file vtkKWMessageDialog.h.

vtkKWMessage* vtkKWMessageDialog::Message [protected]

Definition at line 203 of file vtkKWMessageDialog.h.

vtkKWFrame* vtkKWMessageDialog::ButtonFrame [protected]

Definition at line 204 of file vtkKWMessageDialog.h.

vtkKWPushButton* vtkKWMessageDialog::OKButton [protected]

Definition at line 205 of file vtkKWMessageDialog.h.

vtkKWPushButton* vtkKWMessageDialog::CancelButton [protected]

Definition at line 206 of file vtkKWMessageDialog.h.

vtkKWPushButton* vtkKWMessageDialog::OtherButton [protected]

Definition at line 207 of file vtkKWMessageDialog.h.

vtkKWLabel* vtkKWMessageDialog::Icon [protected]

Definition at line 208 of file vtkKWMessageDialog.h.

vtkKWFrame* vtkKWMessageDialog::OKFrame [protected]

Definition at line 209 of file vtkKWMessageDialog.h.

vtkKWFrame* vtkKWMessageDialog::CancelFrame [protected]

Definition at line 210 of file vtkKWMessageDialog.h.

vtkKWFrame* vtkKWMessageDialog::OtherFrame [protected]

Definition at line 211 of file vtkKWMessageDialog.h.

vtkKWCheckButton* vtkKWMessageDialog::CheckButton [protected]

Definition at line 212 of file vtkKWMessageDialog.h.

char* vtkKWMessageDialog::OKButtonText [protected]

Definition at line 218 of file vtkKWMessageDialog.h.

char* vtkKWMessageDialog::CancelButtonText [protected]

Definition at line 219 of file vtkKWMessageDialog.h.

char* vtkKWMessageDialog::OtherButtonText [protected]

Definition at line 220 of file vtkKWMessageDialog.h.

---

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

• GUI/Widgets/vtkKWMessageDialog.h

---