ParaView
Signals | Public Member Functions | Protected Member Functions | Protected Attributes
pqDialog Class Reference

This is a QDialog subclass that is aware of the undo-redo sub-system. More...

#include <pqDialog.h>

Inheritance diagram for pqDialog:
Inheritance graph
[legend]

List of all members.

Signals

void beginUndo (const QString &)
 Fired when dialog begins undo-able changes.
void endUndo ()
 Fired when dialog is done with undo-able changes.

Public Member Functions

 pqDialog (QWidget *parent=0, Qt::WindowFlags f=0)
virtual ~pqDialog ()
void setUndoLabel (const QString &label)
 Set the lable used for undo command.
virtual void accept ()
virtual void done (int r)

Protected Member Functions

virtual void acceptInternal ()
 Subclassess should override this instead of accept();.
virtual void doneInternal (int)
 Subclassess should override this instead of done().

Protected Attributes

QString UndoLabel

Detailed Description

This is a QDialog subclass that is aware of the undo-redo sub-system.

Many dialogs show information about server manager objects. The user can change the information and then when he/she hits "Accept" or "Apply", we change the underlying server manager object(s). For this change to be undoable, it is essential that the undo set generation is commenced before doing any changes to the server manager. This manages the start/end of building the undo stack for us. For any such dialogs, instead of using a QDialog, one should simply use this. One can use the accepted(), finished() signals safely to perform any changes to the server manager. However, is should not override the accept() or done() methods, instead one should override acceptInternal() or doneInternal().

Definition at line 51 of file pqDialog.h.


Constructor & Destructor Documentation

pqDialog::pqDialog ( QWidget *  parent = 0,
Qt::WindowFlags  f = 0 
)
virtual pqDialog::~pqDialog ( ) [virtual]

Member Function Documentation

void pqDialog::setUndoLabel ( const QString &  label) [inline]

Set the lable used for undo command.

Definition at line 60 of file pqDialog.h.

void pqDialog::beginUndo ( const QString &  ) [signal]

Fired when dialog begins undo-able changes.

Should be connected to undo-redo stack builder.

void pqDialog::endUndo ( ) [signal]

Fired when dialog is done with undo-able changes.

Should be connected to the undo-redo stack builder.

virtual void pqDialog::accept ( ) [virtual]
virtual void pqDialog::done ( int  r) [virtual]
virtual void pqDialog::acceptInternal ( ) [inline, protected, virtual]

Subclassess should override this instead of accept();.

Definition at line 78 of file pqDialog.h.

virtual void pqDialog::doneInternal ( int  ) [inline, protected, virtual]

Subclassess should override this instead of done().

Definition at line 81 of file pqDialog.h.


Member Data Documentation

QString pqDialog::UndoLabel [protected]

Definition at line 83 of file pqDialog.h.


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