ParaView
Public Member Functions | Protected Member Functions
pqDisplayPanelDecoratorInterface Class Reference

pqDisplayPanelDecoratorInterface is used to add decorators to display panels created by ParaView. More...

#include <pqDisplayPanelDecoratorInterface.h>

List of all members.

Public Member Functions

virtual ~pqDisplayPanelDecoratorInterface ()
virtual bool canDecorate (pqDisplayPanel *panel) const =0
 Returns true if this implementation can decorate the given panel type.
virtual void decorate (pqDisplayPanel *panel) const =0
 Called to allow the implementation to decorate the panel.

Protected Member Functions

 pqDisplayPanelDecoratorInterface ()

Detailed Description

pqDisplayPanelDecoratorInterface is used to add decorators to display panels created by ParaView.

This makes it possible to added additional widgets to existing display panels. This is typically useful for plugins that add new painters to the rendering pipeline and want to expose some of the painter parameters through the GUI. Unlike other plugin interfaces, where ParaView stops after the first interface implementation that handles the case, for this interface, every registered implementation gets an opportunity to decorate the panel.

Definition at line 47 of file pqDisplayPanelDecoratorInterface.h.


Constructor & Destructor Documentation

virtual pqDisplayPanelDecoratorInterface::~pqDisplayPanelDecoratorInterface ( ) [inline, virtual]

Definition at line 50 of file pqDisplayPanelDecoratorInterface.h.

pqDisplayPanelDecoratorInterface::pqDisplayPanelDecoratorInterface ( ) [inline, protected]

Definition at line 59 of file pqDisplayPanelDecoratorInterface.h.


Member Function Documentation

virtual bool pqDisplayPanelDecoratorInterface::canDecorate ( pqDisplayPanel panel) const [pure virtual]

Returns true if this implementation can decorate the given panel type.

virtual void pqDisplayPanelDecoratorInterface::decorate ( pqDisplayPanel panel) const [pure virtual]

Called to allow the implementation to decorate the panel.

This is called only if canDecorate(panel) returns true.


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