ParaView
Public Slots | Public Member Functions
pqActiveViewOptionsManager Class Reference

The pqActiveViewOptionsManager class is used to open the appropriate view options dialog. More...

#include <pqActiveViewOptionsManager.h>

Inheritance diagram for pqActiveViewOptionsManager:
Inheritance graph
[legend]

List of all members.

Public Slots

void setActiveView (pqView *view)
 Sets the active view.
void showOptions ()
 Shows the options dialog for the active view.
void showOptions (const QString &page)
 Shows the options dialog for the active view.

Public Member Functions

 pqActiveViewOptionsManager (QObject *parent=0)
 Creates a view options manager.
virtual ~pqActiveViewOptionsManager ()
bool registerOptions (const QString &viewType, pqActiveViewOptions *options)
 Registers an options dialog handler with a view type.
void unregisterOptions (pqActiveViewOptions *options)
 Removes the options dialog from the name mapping.
bool isRegistered (pqActiveViewOptions *options) const
 Gets whether or not the options dialog is registered.
pqActiveViewOptionsgetOptions (const QString &viewType) const
 Gets the options dialog handler for the specified view type.
bool canShowOptions (pqView *view) const
 Returns if an options dialog can be shown for the given view.

Detailed Description

The pqActiveViewOptionsManager class is used to open the appropriate view options dialog.

Definition at line 54 of file pqActiveViewOptionsManager.h.


Constructor & Destructor Documentation

pqActiveViewOptionsManager::pqActiveViewOptionsManager ( QObject *  parent = 0)

Creates a view options manager.

virtual pqActiveViewOptionsManager::~pqActiveViewOptionsManager ( ) [virtual]

Member Function Documentation

bool pqActiveViewOptionsManager::registerOptions ( const QString &  viewType,
pqActiveViewOptions options 
)

Registers an options dialog handler with a view type.

Parameters:
viewTypeThe name of the view type.
optionsThe options dialog handler.
Returns:
True if the registration was successful.
void pqActiveViewOptionsManager::unregisterOptions ( pqActiveViewOptions options)

Removes the options dialog from the name mapping.

Parameters:
optionsThe options dialog handler.
bool pqActiveViewOptionsManager::isRegistered ( pqActiveViewOptions options) const

Gets whether or not the options dialog is registered.

Parameters:
optionsThe options dialog handler.
Returns:
True if the options dialog is associated with a view type.
pqActiveViewOptions* pqActiveViewOptionsManager::getOptions ( const QString &  viewType) const

Gets the options dialog handler for the specified view type.

Parameters:
viewTypeThe name of the view type.
Returns:
A pointer to the options dialog handler.
bool pqActiveViewOptionsManager::canShowOptions ( pqView view) const

Returns if an options dialog can be shown for the given view.

void pqActiveViewOptionsManager::setActiveView ( pqView view) [slot]

Sets the active view.

Parameters:
viewThe new active view.
void pqActiveViewOptionsManager::showOptions ( ) [slot]

Shows the options dialog for the active view.

void pqActiveViewOptionsManager::showOptions ( const QString &  page) [slot]

Shows the options dialog for the active view.

Parameters:
pageThe options page to display.

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