ParaView
Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pqInterfaceTracker Class Reference

pqInterfaceTracker is used by ParaView components to locate interface-implementations. More...

#include <pqInterfaceTracker.h>

Inherits QObject.

Signals

void interfaceRegistered (QObject *iface)
 fired every time an interface is registered either from a plugin on manually. More...
 

Public Member Functions

 pqInterfaceTracker (QObject *parent=0)
 
virtual ~pqInterfaceTracker ()
 
QObjectList interfaces () const
 Return all interfaces that have been loaded/registered. More...
 
template<class T >
QList< T > interfaces () const
 Returns all interfaces that have been loaded/registered that are of the requested type. More...
 
void addInterface (QObject *iface)
 add an extra interface. More...
 
void removeInterface (QObject *iface)
 remove an extra interface More...
 
void initialize ()
 initializes the tracker using existing plugins. More...
 

Protected Member Functions

void onPluginLoaded (vtkObject *, unsigned long, void *calldata)
 Callback when a plugin is loaded. More...
 

Protected Attributes

QObjectList Interfaces
 
QObjectList RegisteredInterfaces
 
unsigned long ObserverID
 

Detailed Description

pqInterfaceTracker is used by ParaView components to locate interface-implementations.

These implementations can be either those loaded from plugins or registered explicitly using addInterface/removeInterface API. In previous versions of ParaView, this role was performed by the pqPluginManager class itself.

Definition at line 45 of file pqInterfaceTracker.h.

Constructor & Destructor Documentation

§ pqInterfaceTracker()

pqInterfaceTracker::pqInterfaceTracker ( QObject *  parent = 0)

§ ~pqInterfaceTracker()

virtual pqInterfaceTracker::~pqInterfaceTracker ( )
virtual

Member Function Documentation

§ interfaces() [1/2]

QObjectList pqInterfaceTracker::interfaces ( ) const
inline

Return all interfaces that have been loaded/registered.

Definition at line 54 of file pqInterfaceTracker.h.

§ interfaces() [2/2]

template<class T >
QList<T> pqInterfaceTracker::interfaces ( ) const
inline

Returns all interfaces that have been loaded/registered that are of the requested type.

Definition at line 60 of file pqInterfaceTracker.h.

§ addInterface()

void pqInterfaceTracker::addInterface ( QObject *  iface)

add an extra interface.

these interfaces are appended to the ones loaded from plugins

§ removeInterface()

void pqInterfaceTracker::removeInterface ( QObject *  iface)

remove an extra interface

§ initialize()

void pqInterfaceTracker::initialize ( )

initializes the tracker using existing plugins.

§ interfaceRegistered

void pqInterfaceTracker::interfaceRegistered ( QObject *  iface)
signal

fired every time an interface is registered either from a plugin on manually.

§ onPluginLoaded()

void pqInterfaceTracker::onPluginLoaded ( vtkObject *  ,
unsigned  long,
void *  calldata 
)
protected

Callback when a plugin is loaded.

We locate and load any interafaces defined in the plugin.

Member Data Documentation

§ Interfaces

QObjectList pqInterfaceTracker::Interfaces
protected

Definition at line 94 of file pqInterfaceTracker.h.

§ RegisteredInterfaces

QObjectList pqInterfaceTracker::RegisteredInterfaces
protected

Definition at line 95 of file pqInterfaceTracker.h.

§ ObserverID

unsigned long pqInterfaceTracker::ObserverID
protected

Definition at line 96 of file pqInterfaceTracker.h.


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