pqSignalAdaptorSelectionTreeWidget Class Reference

pqSignalAdaptorSelectionTreeWidget has two roles. More...

#include <pqSignalAdaptorSelectionTreeWidget.h>

Inherits QObject.

Public Slots
void	setValues (const QList< QList< QVariant >> &values)
	Set the selected value on the widget. More...

Signals
void	valuesChanged ()
	Fired whenever the values change. More...

Public Member Functions
	pqSignalAdaptorSelectionTreeWidget (QTreeWidget *treeWidget, vtkSMProperty *property)
	Constructor. More...
	~pqSignalAdaptorSelectionTreeWidget () override
QList< QList< QVariant > >	values () const
	Returns a list of strings which correspond to the currently selected values. More...
void	setItemCreatorFunction (QTreeWidgetItem *(fptr)(QTreeWidget *, const QStringList &))
	This adaptor create QTreeWidgetItem instances by default when new entries are to be shown in the widget. More...

Properties
QList	QList

Detailed Description

pqSignalAdaptorSelectionTreeWidget has two roles.

• It is used to connect a selection property with a QTreeWidget (typically pqTreeWidget) It also updates the list of available values every time the domain changes. Example use of this adaptor is to connect :
• "AddVolumeArrayName" property of a CTHPart filter to a pqTreeWidget widget.
• "Functions" property of "P3DReader" with a pqTreeWidget.

Definition at line 28 of file pqSignalAdaptorSelectionTreeWidget.h.

Constructor & Destructor Documentation

pqSignalAdaptorSelectionTreeWidget()

pqSignalAdaptorSelectionTreeWidget::pqSignalAdaptorSelectionTreeWidget	(	QTreeWidget *	treeWidget,
		vtkSMProperty *	property
	)

Constructor.

Parameters

treeWidget	The QTreeWidget controlled by this adaptor.
property	The property linked to the widget.

~pqSignalAdaptorSelectionTreeWidget()

pqSignalAdaptorSelectionTreeWidget::~pqSignalAdaptorSelectionTreeWidget ( )

override

Member Function Documentation

values()

QList<QList<QVariant> > pqSignalAdaptorSelectionTreeWidget::values

(

)

const

Returns a list of strings which correspond to the currently selected values.

i.e. only the strings for items currently selected by the user are returned.

setItemCreatorFunction()

void pqSignalAdaptorSelectionTreeWidget::setItemCreatorFunction ( QTreeWidgetItem *  fptr)(QTreeWidget *, const QStringList & )

inline

This adaptor create QTreeWidgetItem instances by default when new entries are to be shown in the widget.

To change the type of QTreeWidgetItem subclass created, simply set a function pointer to a callback which will be called every time a new item is needed. The signature for the callback is: QTreeWidgetItem* callback(QTreeWidget* parent, const QStringList& val)

Definition at line 57 of file pqSignalAdaptorSelectionTreeWidget.h.

valuesChanged

void pqSignalAdaptorSelectionTreeWidget::valuesChanged ( )

signal

Fired whenever the values change.

setValues

void pqSignalAdaptorSelectionTreeWidget::setValues ( const QList< QList< QVariant >> &  values )

slot

Set the selected value on the widget.

All the strings in the

Parameters

values

are set as selected in the tree widget. If a string is present that is not in the domain, it will be ignored.

Property Documentation

QList

QList pqSignalAdaptorSelectionTreeWidget::QList

readwrite

Definition at line 31 of file pqSignalAdaptorSelectionTreeWidget.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqSignalAdaptorSelectionTreeWidget.h