The pqOptionsDialog class is a generic options dialog. More...
#include <pqOptionsDialog.h>
Public Slots | |
| void | setCurrentPage (const QString &path) |
| Sets the current options page. | |
| void | applyChanges () |
| Calls each page to apply any changes. | |
| void | resetChanges () |
| Calls each page to reset any changes. | |
Signals | |
| void | aboutToApplyChanges () |
| Emitted before the option changes are applied. | |
| void | appliedChanges () |
| Emitted after the option changes have been applied. | |
Public Member Functions | |
| pqOptionsDialog (QWidget *parent=0) | |
| virtual | ~pqOptionsDialog () |
| bool | isApplyNeeded () const |
| Gets whether or not there are changes to apply. | |
| void | setApplyNeeded (bool applyNeeded) |
| Sets whether or not there are changes to apply. | |
| void | addOptions (const QString &path, pqOptionsPage *options) |
| Adds a page to the options dialog. | |
| void | addOptions (pqOptionsContainer *options) |
| Adds a container to the options dialog. | |
| void | removeOptions (pqOptionsPage *options) |
| Removes the options page from the options dialog. | |
Detailed Description
The pqOptionsDialog class is a generic options dialog.
Pages can be added to the dialog using the pqOptionsPage and pqOptionsContainer interfaces. The options dialog has apply and reset buttons that the pages can use.
Definition at line 56 of file pqOptionsDialog.h.
Constructor & Destructor Documentation
| pqOptionsDialog::pqOptionsDialog | ( | QWidget * | parent = 0 | ) |
| virtual pqOptionsDialog::~pqOptionsDialog | ( | ) | [virtual] |
Member Function Documentation
| bool pqOptionsDialog::isApplyNeeded | ( | ) | const |
Gets whether or not there are changes to apply.
- Returns:
- True if there are changes to apply.
| void pqOptionsDialog::setApplyNeeded | ( | bool | applyNeeded | ) |
Sets whether or not there are changes to apply.
- Parameters:
-
applyNeeded True if there are changes to apply.
| void pqOptionsDialog::addOptions | ( | const QString & | path, |
| pqOptionsPage * | options | ||
| ) |
Adds a page to the options dialog.
When the options object is a page container, the path parameter becomes the path prefix for the container pages.
- Parameters:
-
path The name hierarchy for the options page. options The options page.
| void pqOptionsDialog::addOptions | ( | pqOptionsContainer * | options | ) |
Adds a container to the options dialog.
Each page listed for the container is added to the root of the selection tree.
- Parameters:
-
options The options container to add.
| void pqOptionsDialog::removeOptions | ( | pqOptionsPage * | options | ) |
Removes the options page from the options dialog.
The page name is removed from the selection tree. If the page is an options container, all the names are removed.
- Parameters:
-
options The options page/container to remove.
| void pqOptionsDialog::setCurrentPage | ( | const QString & | path | ) | [slot] |
Sets the current options page.
- Parameters:
-
path The name of the options page to show.
| void pqOptionsDialog::applyChanges | ( | ) | [slot] |
Calls each page to apply any changes.
| void pqOptionsDialog::resetChanges | ( | ) | [slot] |
Calls each page to reset any changes.
| void pqOptionsDialog::aboutToApplyChanges | ( | ) | [signal] |
Emitted before the option changes are applied.
| void pqOptionsDialog::appliedChanges | ( | ) | [signal] |
Emitted after the option changes have been applied.
The documentation for this class was generated from the following file:
- /home/kitware/Dashboards/My Tests/ParaView/Qt/Components/pqOptionsDialog.h
