The pqActiveViewOptions class is the interface to the view options dialogs used by the pqActiveViewOptionsManager. More...
#include <pqActiveViewOptions.h>
Signals | |
| void | optionsClosed (pqActiveViewOptions *options) |
| Emitted when the view options dialog has been closed. | |
Public Member Functions | |
| pqActiveViewOptions (QObject *parent=0) | |
| Constructs a view options class. | |
| virtual | ~pqActiveViewOptions () |
| virtual void | showOptions (pqView *view, const QString &page, QWidget *parent=0)=0 |
| Opens the options dialog for the given view. | |
| virtual void | changeView (pqView *view)=0 |
| Changes the view displayed in the options dialog. | |
| virtual void | closeOptions ()=0 |
| Closes the open options dialog. | |
Detailed Description
The pqActiveViewOptions class is the interface to the view options dialogs used by the pqActiveViewOptionsManager.
Definition at line 52 of file pqActiveViewOptions.h.
Constructor & Destructor Documentation
| pqActiveViewOptions::pqActiveViewOptions | ( | QObject * | parent = 0 | ) |
Constructs a view options class.
- Parameters:
-
parent The parent object.
| virtual pqActiveViewOptions::~pqActiveViewOptions | ( | ) | [inline, virtual] |
Definition at line 61 of file pqActiveViewOptions.h.
Member Function Documentation
| virtual void pqActiveViewOptions::showOptions | ( | pqView * | view, |
| const QString & | page, | ||
| QWidget * | parent = 0 |
||
| ) | [pure virtual] |
Opens the options dialog for the given view.
If the page parameter is empty, the default page should be shown.
- Parameters:
-
view The view to show the options for. page The path to the properties page to display. parent The parent widget for the options dialog.
Implemented in pqActiveRenderViewOptions, pqActiveTwoDRenderViewOptions, pqActiveXYChartOptions, and pqActivePlotMatrixViewOptions.
| virtual void pqActiveViewOptions::changeView | ( | pqView * | view | ) | [pure virtual] |
Changes the view displayed in the options dialog.
This method is called when the active view is changed while the options dialog is open.
- Parameters:
-
view The new view to show the options for.
Implemented in pqActiveRenderViewOptions, pqActiveTwoDRenderViewOptions, pqActiveXYChartOptions, and pqActivePlotMatrixViewOptions.
| virtual void pqActiveViewOptions::closeOptions | ( | ) | [pure virtual] |
Closes the open options dialog.
This method is called when the active view is changed to a view type that is not supported by the current options dialog.
Implemented in pqActiveRenderViewOptions, pqActiveTwoDRenderViewOptions, pqActiveXYChartOptions, and pqActivePlotMatrixViewOptions.
| void pqActiveViewOptions::optionsClosed | ( | pqActiveViewOptions * | options | ) | [signal] |
Emitted when the view options dialog has been closed.
This signal is used to notify the view options manager that the current dialog has been closed. Subclasses can use the dialog's finished(int) signal to emit this signal.
- Parameters:
-
options The view options whose dialog closed.
The documentation for this class was generated from the following file:
- /home/kitware/Dashboards/My Tests/ParaView/Qt/Components/pqActiveViewOptions.h
