Utilize pqMetaDataPropertyWidget when you need to update the metadata information of a vtkSMSourceProxy. More...
#include <pqMetaDataPropertyWidget.h>
Public Member Functions | |
| pqMetaDataPropertyWidget (vtkSMProxy *proxy, vtkSMPropertyGroup *smgroup, QWidget *parent=nullptr) | |
| ~pqMetaDataPropertyWidget () override | |
| void | updateMetadata (vtkObject *, unsigned long, void *) |
 Public Member Functions inherited from pqPropertyWidget | |
| pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=nullptr) | |
| ~pqPropertyWidget () override | |
| virtual void | apply () |
| virtual void | reset () |
| virtual void | updateWidget (bool showing_advanced_properties) |
| pqView * | view () const |
| vtkSMProxy * | proxy () const |
| vtkSMProperty * | property () 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 | select () |
| These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More... | |
| virtual void | selectPort (int portIndex) |
| These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More... | |
| virtual void | deselect () |
| 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... | |
| static std::vector< std::string > | parseComponentLabels (vtkPVXMLElement *hints, unsigned int elemCount=0) |
| Parse a XML element as a list of label to use for this widget. 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... | |
| pqPropertyLinks & | links () |
| Provides access to the pqPropertyLinks instance. More... | |
Utilize pqMetaDataPropertyWidget when you need to update the metadata information of a vtkSMSourceProxy.
For example, The list of arrays in array selection views may need to be refreshed when data access properties on the reader are modified.
How to use? Group all properties that could affect the metadata inside a property group, then, set this widget as the panel_widget.
Example:
* <PropertyGroup name="DatabaseProperties", panel_widget="MetadataPropertyWidget"> * <Property name="Foo"/> * <Property name="Bar"/> * <Property name="VeryInterestingProperty"/> * </PropertyGroup> *
Under the hood, it uses pqProxyWidget::createPropertyWidget` to auto generate pq[Int,Double,String]VectorPropertyWidget instances for simple properties - (Int, Double, String)VectorProperty.
When any of those properties are modified, from GUI or Python or wherever, the unchecked values are pushed to the source proxy's vtk object. After that, UpdatePipelineInformation() is invoked on the source proxy. This enables it to reload the information based on the new property values.
Definition at line 46 of file pqMetaDataPropertyWidget.h.
| pqMetaDataPropertyWidget::pqMetaDataPropertyWidget | ( | vtkSMProxy * | proxy, |
| vtkSMPropertyGroup * | smgroup, | ||
| QWidget * | parent = nullptr |
||
| ) |
|
override |
| void pqMetaDataPropertyWidget::updateMetadata | ( | vtkObject * | , |
| unsigned | long, | ||
| void * | |||
| ) |
1.8.13 on Thu Mar 28 2024