Public Member Functions | List of all members
pqPropertyWidgetInterface Class Reference

pqPropertyWidgetInterface is part of the ParaView Plugin infrastructure that enables support for plugins to add new pqPropertyWidget and pqPropertyWidgetDecorator types and make them available within the application. More...

#include <pqPropertyWidgetInterface.h>

Inheritance diagram for pqPropertyWidgetInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~pqPropertyWidgetInterface ()
 
virtual pqPropertyWidgetcreateWidgetForProperty (vtkSMProxy *proxy, vtkSMProperty *property, QWidget *parentWidget)
 Given a proxy and its property, create a widget for the same, of possible. More...
 
virtual pqPropertyWidgetcreateWidgetForPropertyGroup (vtkSMProxy *proxy, vtkSMPropertyGroup *group, QWidget *parentWidget)
 Given a proxy and its property group, create a widget for the same, of possible. More...
 
virtual pqPropertyWidgetDecoratorcreateWidgetDecorator (const QString &type, vtkPVXMLElement *config, pqPropertyWidget *widget)
 Given the type of the decorator and the pqPropertyWidget that needs to be decorated, create the pqPropertyWidgetDecorator instance, if possible. More...
 
virtual void createDefaultWidgetDecorators (pqPropertyWidget *widget)
 Create all default decorators for a specific widget. More...
 

Detailed Description

pqPropertyWidgetInterface is part of the ParaView Plugin infrastructure that enables support for plugins to add new pqPropertyWidget and pqPropertyWidgetDecorator types and make them available within the application.

Definition at line 52 of file pqPropertyWidgetInterface.h.

Constructor & Destructor Documentation

◆ ~pqPropertyWidgetInterface()

virtual pqPropertyWidgetInterface::~pqPropertyWidgetInterface ( )
virtual

Member Function Documentation

◆ createWidgetForProperty()

virtual pqPropertyWidget* pqPropertyWidgetInterface::createWidgetForProperty ( vtkSMProxy proxy,
vtkSMProperty property,
QWidget *  parentWidget 
)
virtual

Given a proxy and its property, create a widget for the same, of possible.

For unsupported/unknown proxies/properties, implementations should simply return nullptr without raising any errors (or messages).

Reimplemented in pqStandardPropertyWidgetInterface, pqExtrusionPropertyWidgetDecoratorPWIImplementation, pqIntegrationModelSeedHelperWidgetPWIImplementation, pqIntegrationModelSurfaceHelperWidgetPWIImplementation, and pqSESAMEConversionsPanelWidgetPWIImplementation.

◆ createWidgetForPropertyGroup()

virtual pqPropertyWidget* pqPropertyWidgetInterface::createWidgetForPropertyGroup ( vtkSMProxy proxy,
vtkSMPropertyGroup group,
QWidget *  parentWidget 
)
virtual

Given a proxy and its property group, create a widget for the same, of possible.

For unsupported/unknown proxies/property-groups, implementations should simply return nullptr without raising any errors (or messages).

Reimplemented in pqStandardPropertyWidgetInterface, pqExtrusionPropertyWidgetDecoratorPWIImplementation, pqIntegrationModelSeedHelperWidgetPWIImplementation, pqIntegrationModelSurfaceHelperWidgetPWIImplementation, and pqSESAMEConversionsPanelWidgetPWIImplementation.

◆ createWidgetDecorator()

virtual pqPropertyWidgetDecorator* pqPropertyWidgetInterface::createWidgetDecorator ( const QString &  type,
vtkPVXMLElement config,
pqPropertyWidget widget 
)
virtual

Given the type of the decorator and the pqPropertyWidget that needs to be decorated, create the pqPropertyWidgetDecorator instance, if possible.

For unsupported/unknown, implementations should simply return nullptr without raising any errors (or messages).

Reimplemented in pqStandardPropertyWidgetInterface, pqExtrusionPropertyWidgetDecoratorPWIImplementation, pqIntegrationModelSeedHelperWidgetPWIImplementation, pqIntegrationModelSurfaceHelperWidgetPWIImplementation, and pqSESAMEConversionsPanelWidgetPWIImplementation.

◆ createDefaultWidgetDecorators()

virtual void pqPropertyWidgetInterface::createDefaultWidgetDecorators ( pqPropertyWidget widget)
virtual

Create all default decorators for a specific widget.

Reimplemented in pqStandardPropertyWidgetInterface.


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