ParaView
Public Member Functions
pqOptionsContainer Class Reference

The pqOptionsContainer class is used to add multiple pages of options to the pqOptionsDialog. More...

#include <pqOptionsContainer.h>

Inheritance diagram for pqOptionsContainer:
Inheritance graph
[legend]
Collaboration diagram for pqOptionsContainer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 pqOptionsContainer (QWidget *parent=0)
 Constructs an options container.
virtual ~pqOptionsContainer ()
const QString & getPagePrefix () const
 Gets the page path prefix.
void setPagePrefix (const QString &prefix)
 Sets the page path prefix.
virtual void setPage (const QString &page)=0
 Sets the currently displayed page.
virtual QStringList getPageList ()=0
 Gets the list of available pages in the container.

Detailed Description

The pqOptionsContainer class is used to add multiple pages of options to the pqOptionsDialog.

Grouping the options pages into container objects can make is easier to maintain a set of options. The container makes it possible to reuse a UI form. If several objects have the same properties, the same page can be used for each of the objects.

Definition at line 53 of file pqOptionsContainer.h.


Constructor & Destructor Documentation

pqOptionsContainer::pqOptionsContainer ( QWidget *  parent = 0)

Constructs an options container.

Parameters:
parentThe parent widget.
virtual pqOptionsContainer::~pqOptionsContainer ( ) [virtual]

Member Function Documentation

const QString& pqOptionsContainer::getPagePrefix ( ) const

Gets the page path prefix.

Returns:
The page path prefix.
void pqOptionsContainer::setPagePrefix ( const QString &  prefix)

Sets the page path prefix.

Parameters:
prefixThe new page path prefix.
virtual void pqOptionsContainer::setPage ( const QString &  page) [pure virtual]

Sets the currently displayed page.

Parameters:
pageThe page hierarchy name.

Implemented in pqPlotMatrixOptionsEditor, pqXYChartOptionsEditor, pqRenderViewOptions, pqApplicationOptions, and pqGlobalRenderViewOptions.

virtual QStringList pqOptionsContainer::getPageList ( ) [pure virtual]

Gets the list of available pages in the container.

Parameters:
pagesUsed to return the list of available pages.

Implemented in pqPlotMatrixOptionsEditor, pqXYChartOptionsEditor, pqRenderViewOptions, pqApplicationOptions, and pqGlobalRenderViewOptions.


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