Public Member Functions | List of all members
pqProxyPropertyWidget Class Reference

This is a widget for a vtkSMProxyProperty. More...

#include <pqProxyPropertyWidget.h>

Inheritance diagram for pqProxyPropertyWidget:
Inheritance graph
[legend]
Collaboration diagram for pqProxyPropertyWidget:
Collaboration graph
[legend]

Public Member Functions

 pqProxyPropertyWidget (vtkSMProperty *property, vtkSMProxy *proxy, QWidget *parent=nullptr)
 
void apply () override
 Overridden to pass the calls to internal widgets. More...
 
void reset () override
 
void select () override
 These methods are called when the pqProxyPropertiesPanel containing the widget is activated/deactivated. More...
 
void deselect () override
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
void updateWidget (bool showing_advanced_properties) override
 Overridden to hide the properties for proxies in a vtkSMProxyListDomain if requested. More...
 
- Public Member Functions inherited from pqPropertyWidget
 pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=nullptr)
 
 ~pqPropertyWidget () override
 
pqViewview () const
 
vtkSMProxyproxy () const
 
vtkSMPropertyproperty () const
 
virtual char * panelVisibility () const
 Forward calls to vtkSMProperty. More...
 
virtual void setPanelVisibility (const char *vis)
 
virtual bool isSingleRowItem () const
 Determines if the PropertyWidget must be constructed using a single row. More...
 
bool showLabel () const
 
const QList< QPointer< pqPropertyWidgetDecorator > > & decorators () const
 Provides access to the decorators for this widget. More...
 
void setProperty (vtkSMProperty *property)
 
virtual void selectPort (int portIndex)
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
bool isSelected () const
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 

Additional Inherited Members

- Public Slots inherited from pqPropertyWidget
virtual void setView (pqView *)
 called to set the active view. More...
 
- Signals inherited from pqPropertyWidget
void viewChanged (pqView *view)
 This signal is emitted when the current view changes. More...
 
void changeAvailable ()
 This signal is fired as soon as the user starts editing in the widget. More...
 
void changeFinished ()
 This signal is fired as soon as the user is done with making an atomic change. More...
 
void restartRequired ()
 Indicates that a restart of the program is required for the setting to take effect. More...
 
- Static Public Member Functions inherited from pqPropertyWidget
template<class T >
static QString getXMLName (T *object)
 Description: This static utility method returns the XML name for an object as a QString. More...
 
static QString getTooltip (vtkSMProperty *property)
 Returns the tooltip to use for the property. More...
 
static int hintsWidgetHeightNumberOfRows (vtkPVXMLElement *hints, int defaultValue=10)
 Helper method to return value from WidgetHeight XML hint, if any. More...
 
- Protected Member Functions inherited from pqPropertyWidget
void addPropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProperty *smproperty, int smindex=-1)
 
void addPropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProxy *smproxy, vtkSMProperty *smproperty, int smindex=-1)
 
void removePropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProperty *smproperty, int smindex=-1)
 
void removePropertyLink (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProxy *smproxy, vtkSMProperty *smproperty, int smindex=-1)
 
void setShowLabel (bool show)
 
void setChangeAvailableAsChangeFinished (bool status)
 For most pqPropertyWidget subclasses a changeAvailable() signal, corresponds to a changeFinished() signal. More...
 
void addDecorator (pqPropertyWidgetDecorator *)
 Register a decorator. More...
 
void removeDecorator (pqPropertyWidgetDecorator *)
 Unregisters a decorator. More...
 
pqPropertyLinkslinks ()
 Provides access to the pqPropertyLinks instance. More...
 

Detailed Description

This is a widget for a vtkSMProxyProperty.

It handles a "SelectionInput" property and properties with ProxyListDomain.

Definition at line 46 of file pqProxyPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqProxyPropertyWidget()

pqProxyPropertyWidget::pqProxyPropertyWidget ( vtkSMProperty property,
vtkSMProxy proxy,
QWidget *  parent = nullptr 
)

Member Function Documentation

◆ apply()

void pqProxyPropertyWidget::apply ( )
overridevirtual

Overridden to pass the calls to internal widgets.

Reimplemented from pqPropertyWidget.

◆ reset()

void pqProxyPropertyWidget::reset ( )
overridevirtual

Reimplemented from pqPropertyWidget.

◆ select()

void pqProxyPropertyWidget::select ( )
overridevirtual

These methods are called when the pqProxyPropertiesPanel containing the widget is activated/deactivated.

Only widgets that have 3D widgets need to override these methods to select/deselect the 3D widgets.

Reimplemented from pqPropertyWidget.

◆ deselect()

void pqProxyPropertyWidget::deselect ( )
overridevirtual

These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive.

Only widgets that have interactive widgets need to override these methods to select/deselect the interactive widgets. selectPort(int) allows to specify an output port index and conditionnaly select the interactive widget if the XML hint WidgetVisibilityLink has been set. Default implementation does nothing.

Reimplemented from pqPropertyWidget.

◆ updateWidget()

void pqProxyPropertyWidget::updateWidget ( bool  showing_advanced_properties)
overridevirtual

Overridden to hide the properties for proxies in a vtkSMProxyListDomain if requested.

Reimplemented from pqPropertyWidget.


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