pqListPropertyWidget is a pqPropertyWidget that is used to show an editable list of elements. More...

#include <pqListPropertyWidget.h>

Inheritance diagram for pqListPropertyWidget:

Collaboration diagram for pqListPropertyWidget:

Signals
void	valueChanged ()

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
	pqListPropertyWidget (vtkSMProxy smproxy, vtkSMProperty smproperty, QWidget *parent=nullptr)

	~pqListPropertyWidget () override

QList< QVariant >	value () const
	Methods used to set/get the value for the widget. More...

void	setValue (const QList< QVariant > &value)

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...

virtual void	setReadOnly (bool readOnly)
	Set widget in read-only mode. 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...

Properties
QList< QVariant >	value

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::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...

Detailed Description

pqListPropertyWidget is a pqPropertyWidget that is used to show an editable list of elements.

This is suitable for int/idtype/double/string vector properties with multiple elements, useful for allowing the user to change a range of values without adding or removing entries from it.

Definition at line 20 of file pqListPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqListPropertyWidget()

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

explicit

◆ ~pqListPropertyWidget()

pqListPropertyWidget::~pqListPropertyWidget ( )

override

Member Function Documentation

◆ value()

QList<QVariant> pqListPropertyWidget::value ( ) const

Methods used to set/get the value for the widget.

◆ setValue()

void pqListPropertyWidget::setValue ( const QList< QVariant > & value )

◆ valueChanged

void pqListPropertyWidget::valueChanged ( )

signal

Property Documentation

◆ value

QList<QVariant> pqListPropertyWidget::value

readwrite

Definition at line 24 of file pqListPropertyWidget.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqListPropertyWidget.h

Signals

Public Member Functions

Properties

Additional Inherited Members