Signals | Public Member Functions | Properties | List of all members
pqDataAssemblyPropertyWidget Class Reference

pqPropertyWidget for properties with vtkDataAssembly More...

#include <pqDataAssemblyPropertyWidget.h>

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

Signals

void chosenPathsChanged ()
 
- 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...
 

Public Member Functions

 pqDataAssemblyPropertyWidget (vtkSMProxy *smproxy, vtkSMPropertyGroup *smgroup, QWidget *parent=nullptr)
 
 pqDataAssemblyPropertyWidget (vtkSMProxy *smproxy, vtkSMProperty *smproperty, QWidget *parent=nullptr)
 
 ~pqDataAssemblyPropertyWidget () override
 
void setChosenPaths (const QStringList &paths)
 API for getting/setting selected/chosen path strings. More...
 
const QStringList & chosenPaths () const
 API for getting/setting selected/chosen path strings. More...
 
void setChosenPaths (const QList< QVariant > &paths)
 API for getting/setting selected/chosen path strings. More...
 
QList< QVariant > chosenPathsAsVariantList () const
 API for getting/setting selected/chosen path strings. More...
 
- Public Member Functions inherited from pqPropertyWidget
 pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=0)
 
 ~pqPropertyWidget () override
 
virtual void apply ()
 
virtual void reset ()
 
virtual void select ()
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
virtual void deselect ()
 
bool isSelected () const
 
virtual void updateWidget (bool showing_advanced_properties)
 
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)
 

Properties

QList< QVariant > chosenPaths
 

Additional Inherited Members

- Public Slots inherited from pqPropertyWidget
virtual void setView (pqView *)
 called to set the active view. 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

pqPropertyWidget for properties with vtkDataAssembly

pqDataAssemblyPropertyWidget is intended for properties that rely on a vtkDataAssembly i.e. use a vtkSMDataAssemblyDomain. Currently, this only support getting/setting the list of chosen paths based on the vtkDataAssembly. In the future, we will add support for additional properties such as color, opacity etc.

Definition at line 51 of file pqDataAssemblyPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqDataAssemblyPropertyWidget() [1/2]

pqDataAssemblyPropertyWidget::pqDataAssemblyPropertyWidget ( vtkSMProxy smproxy,
vtkSMPropertyGroup smgroup,
QWidget *  parent = nullptr 
)

◆ pqDataAssemblyPropertyWidget() [2/2]

pqDataAssemblyPropertyWidget::pqDataAssemblyPropertyWidget ( vtkSMProxy smproxy,
vtkSMProperty smproperty,
QWidget *  parent = nullptr 
)

◆ ~pqDataAssemblyPropertyWidget()

pqDataAssemblyPropertyWidget::~pqDataAssemblyPropertyWidget ( )
override

Member Function Documentation

◆ setChosenPaths() [1/2]

void pqDataAssemblyPropertyWidget::setChosenPaths ( const QStringList &  paths)

API for getting/setting selected/chosen path strings.

◆ chosenPaths()

const QStringList& pqDataAssemblyPropertyWidget::chosenPaths ( ) const

API for getting/setting selected/chosen path strings.

◆ setChosenPaths() [2/2]

void pqDataAssemblyPropertyWidget::setChosenPaths ( const QList< QVariant > &  paths)

API for getting/setting selected/chosen path strings.

◆ chosenPathsAsVariantList()

QList<QVariant> pqDataAssemblyPropertyWidget::chosenPathsAsVariantList ( ) const

API for getting/setting selected/chosen path strings.

◆ chosenPathsChanged

void pqDataAssemblyPropertyWidget::chosenPathsChanged ( )
signal

Property Documentation

◆ chosenPaths

QList<QVariant> pqDataAssemblyPropertyWidget::chosenPaths
readwrite

Definition at line 56 of file pqDataAssemblyPropertyWidget.h.


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