AlgorithmDialog Class Reference

Modeless dialog support for a plug-in. More...

#include <AlgorithmDialog.h>

List of all members.

Public Slots
void	accept ()
void	reject ()
Public Member Functions
	AlgorithmDialog (QWidget *pParent=0)
	~AlgorithmDialog ()
int	enterLoop ()

---

Detailed Description

Modeless dialog support for a plug-in.

The algorithm dialog provides a means for plug-ins to display modeless dialogs where an event loop can be executed to prevent control from returning to the caller until the dialog is accepted or rejected.

After calling show(), call enterLoop() to begin the event loop. The enterLoop() method will not return until the dialog is accepted or rejected.

WARNING: If another instance of an algorithm dialog is instantiated while the event loop of this instance is running, accepting or rejecting this dialog will not cause enterLoop() to return until control has returned from the other dialog instance.

Definition at line 30 of file AlgorithmDialog.h.

---

Constructor & Destructor Documentation

AlgorithmDialog::AlgorithmDialog

(

QWidget *

pParent = 0

)

Creates the algorithm dialog.

By default, the dialog is created as a modeless dialog.

Parameters:

pParent

The parent widget.

AlgorithmDialog::~AlgorithmDialog

(

)

Destroys the algorithm dialog.

If the event loop is running and the dialog has not been accepted or rejected, the event loop is exited with a QDialog::Rejected value.

---

Member Function Documentation

int AlgorithmDialog::enterLoop

(

)

Begins the local event loop.

This method begins the local event loop, and the method will not return until the dialog is accepted or rejected.

Returns:

QDialog::Accepted is returned if the dialog is accepted either by the user or programmatically. QDialog::Rejected is returned if the dialog is rejected or if the dialog is destroyed without being accepted or rejected.

void AlgorithmDialog::accept

(

)

[slot]

Closes the dialog, accepting the changes.

This method accepts the dialog and exits the local event loop, thereby returning control to the caller of eventLoop().

WARNING: If overriding this method, the base class must be called to ensure proper execution of the application.

void AlgorithmDialog::reject

(

)

[slot]

Closes the dialog, rejecting the changes.

This method rejects the dialog and exits the local event loop, thereby returning control to the caller of eventLoop().

WARNING: If overriding this method, the base class must be called to ensure proper execution of the application.