Signals | Public Member Functions | Protected Slots | Properties | List of all members
pqSelectionListPropertyWidget Class Reference

pqSelectionListPropertyWidget is a custom widget used to associate a label for each selectionNode from an input selection. More...

#include <pqSelectionListPropertyWidget.h>

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

Signals

void labelsChanged ()
 Signal for the labels proxy changed. 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...
 

Public Member Functions

 pqSelectionListPropertyWidget (vtkSMProxy *smproxy, vtkSMPropertyGroup *smgroup, QWidget *parentObject=nullptr)
 
 ~pqSelectionListPropertyWidget () override
 
QList< QVariant > labels () const
 Methods used to set/get the label values for the widget. More...
 
void setLabels (const QList< QVariant > &labels)
 
- Public Member Functions inherited from pqPropertyGroupWidget
 pqPropertyGroupWidget (vtkSMProxy *proxy, vtkSMPropertyGroup *smGroup, QWidget *parent=nullptr)
 
vtkSMPropertyGrouppropertyGroup () const
 
void addPropertyLink (QComboBox *cb, const char *propertyName, int smindex=-1)
 
void addPropertyLink (QLineEdit *edit, const char *propertyName, int smindex=-1)
 
void addPropertyLink (QCheckBox *button, const char *propertyName, int smindex=-1)
 
void addPropertyLink (QToolButton *button, const char *propertyName, int smindex=-1)
 
void addPropertyLink (QGroupBox *groupBox, const char *propertyName, int smindex=-1)
 
void addPropertyLink (QDoubleSpinBox *spinBox, const char *propertyName, int smindex=-1)
 
void addPropertyLink (QSpinBox *spinBox, const char *propertyName, int smindex=-1)
 
void addPropertyLink (pqColorChooserButton *color, const char *propertyName, int smindex=-1)
 
void addPropertyLink (pqDoubleSliderWidget *slider, const char *propertyName, int smindex=-1)
 
char * panelVisibility () const override
 Overwrite pqPropertyWidget to forward calls to vtkSMPropertyGroup. More...
 
void setPanelVisibility (const char *vis) override
 
- 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)
 
pqViewview () const
 
vtkSMProxyproxy () const
 
vtkSMPropertyproperty () const
 
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...
 

Protected Slots

void populateRowLabels (pqSMProxy appendSelection)
 Clone the active selection handled by the selection manager. More...
 

Properties

QList< QVariant > labels
 

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...
 
static std::vector< std::stringparseComponentLabels (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...
 
pqPropertyLinkslinks ()
 Provides access to the pqPropertyLinks instance. More...
 

Detailed Description

pqSelectionListPropertyWidget is a custom widget used to associate a label for each selectionNode from an input selection.

It also use the pqSelectionInputWidget to know the number of labels we need to define, by copying the active selection.

Definition at line 25 of file pqSelectionListPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqSelectionListPropertyWidget()

pqSelectionListPropertyWidget::pqSelectionListPropertyWidget ( vtkSMProxy smproxy,
vtkSMPropertyGroup smgroup,
QWidget *  parentObject = nullptr 
)

◆ ~pqSelectionListPropertyWidget()

pqSelectionListPropertyWidget::~pqSelectionListPropertyWidget ( )
override

Member Function Documentation

◆ labels()

QList<QVariant> pqSelectionListPropertyWidget::labels ( ) const

Methods used to set/get the label values for the widget.

The number of labels required depend of the number of SelectionNode in the activeSelection provided by the pqSelectionInputWidget.

◆ setLabels()

void pqSelectionListPropertyWidget::setLabels ( const QList< QVariant > &  labels)

◆ labelsChanged

void pqSelectionListPropertyWidget::labelsChanged ( )
signal

Signal for the labels proxy changed.

◆ populateRowLabels

void pqSelectionListPropertyWidget::populateRowLabels ( pqSMProxy  appendSelection)
protectedslot

Clone the active selection handled by the selection manager.

Property Documentation

◆ labels

QList<QVariant> pqSelectionListPropertyWidget::labels
readwrite

Definition at line 29 of file pqSelectionListPropertyWidget.h.


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