pqStandardViewModules Class Reference

interface class for plugins that create view modules More...

#include <pqStandardViewModules.h>

Inheritance diagram for pqStandardViewModules:

Collaboration diagram for pqStandardViewModules:

List of all members.

Public Member Functions
	pqStandardViewModules (QObject *o)
	~pqStandardViewModules ()
virtual QStringList	viewTypes () const
	Return a list of view types supported by this interface.
QStringList	displayTypes () const
	Return a list of display types supported by this interface overload this if you have custom pqConsuerDisplay's.
QString	viewTypeName (const QString &) const
	Return a friendly type name (e.g.
bool	canCreateView (const QString &viewtype) const
	Returns true if this can create a view of a given name The name corresponds to the Server Manager XML Hint such as.
vtkSMProxy *	createViewProxy (const QString &viewtype, pqServer *server)
	Creates the Server Manager view module For example:
pqView *	createView (const QString &viewtype, const QString &group, const QString &name, vtkSMViewProxy *viewmodule, pqServer *server, QObject *parent)
	Creates the GUI view that corresponds with the server manager view viewtype is the type of view (e.g.
pqDataRepresentation *	createDisplay (const QString &display_type, const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent)
	Creates a pqDataRepresentation that corresponds with the ViewModuleProxy's display_name this is optional and only needs to be implemented if the pqDataRepresentation needs to do something special.

---

Detailed Description

interface class for plugins that create view modules

Definition at line 41 of file pqStandardViewModules.h.

---

Constructor & Destructor Documentation

pqStandardViewModules::pqStandardViewModules

(

QObject *

o

)

pqStandardViewModules::~pqStandardViewModules

(

)

---

Member Function Documentation

virtual QStringList pqStandardViewModules::viewTypes

(

)

const [virtual]

Return a list of view types supported by this interface.

Implements pqViewModuleInterface.

QStringList pqStandardViewModules::displayTypes

(

)

const [virtual]

Return a list of display types supported by this interface overload this if you have custom pqConsuerDisplay's.

Reimplemented from pqViewModuleInterface.

QString pqStandardViewModules::viewTypeName

(

const QString &

viewtype

)

const [virtual]

Return a friendly type name (e.g.

"My Custom View" in place of "MyCustomView")

Implements pqViewModuleInterface.

bool pqStandardViewModules::canCreateView

(

const QString &

viewtype

)

const [virtual]

Returns true if this can create a view of a given name The name corresponds to the Server Manager XML Hint such as.

  /// <SourceProxy name="MyCustomFilter" class="vtkMyCustomFilter">
  ///  ...
  ///  <Hints>
  ///   <View type="MyCustom" />
  ///  </Hints>
  /// </SourceProxy>
  /// 

Implements pqViewModuleInterface.

vtkSMProxy* pqStandardViewModules::createViewProxy	(	const QString &	viewtype,
		pqServer *	server
	)		[virtual]

Creates the Server Manager view module For example:

  /// <ProxyGroup name="plotmodules">
  ///  <ViewModuleProxy name="MyCustomViewModule">
  ///    base_proxygroup="rendermodules"
  ///    base_proxyname="ViewModule"
  ///    display_name="MyCustomViewDisplay"
  ///  </ViewModuleProxy>
  /// </ProxyGroup>
  /// 

implement this to call vtkSMProxyManager::NewProxy("plotmodules", "MyCustomViewModule")

Implements pqViewModuleInterface.

pqView* pqStandardViewModules::createView	(	const QString &	viewtypemodule,
		const QString &	group,
		const QString &	name,
		vtkSMViewProxy *	viewmodule,
		pqServer *	server,
		QObject *	parent
	)		[virtual]

Creates the GUI view that corresponds with the server manager view viewtype is the type of view (e.g.

MyCustomViewModule), group is the group that the viewmodule was registered with, name is the name that the view module was registered with, viewmodule is the server manager view module this GUI side view module corresponds with, server is the server it was created on, parent is the QObject parent.

Implements pqViewModuleInterface.

pqDataRepresentation* pqStandardViewModules::createDisplay	(	const QString &	,
		const QString &	,
		const QString &	,
		vtkSMProxy *	,
		pqServer *	,
		QObject *
	)		[virtual]

Creates a pqDataRepresentation that corresponds with the ViewModuleProxy's display_name this is optional and only needs to be implemented if the pqDataRepresentation needs to do something special.

Reimplemented from pqViewModuleInterface.

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqStandardViewModules.h