pqPropertyWidget that can be used for any proxy with a vtkSMProxyListDomain. More...

#include <pqProxySelectionWidget.h>

Inheritance diagram for pqProxySelectionWidget:

Collaboration diagram for pqProxySelectionWidget:

Signals
void	chosenProxyChanged ()
	Signal fired by setChosenProxy() when the proxy changes. 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
	pqProxySelectionWidget (vtkSMProperty property, vtkSMProxy proxy, QWidget *parent=nullptr)
	constructor requires the proxy, property. More...

	~pqProxySelectionWidget () override

vtkSMProxy *	chosenProxy () const
	get the selected proxy More...

void	setChosenProxy (vtkSMProxy *proxy)

void	apply () override
	Overridden to forward the call to the internal pqProxyWidget maintained for the chosen proxy. More...

void	reset () override

void	select () override
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

void	deselect () override
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

void	updateWidget (bool showing_advanced_properties) override

void	setPanelVisibility (const char *vis) override

void	setView (pqView *) override
	called to set the active view. More...

Public Member Functions inherited from pqPropertyWidget
	pqPropertyWidget (vtkSMProxy proxy, QWidget parent=nullptr)

	~pqPropertyWidget () override

pqView *	view () const

vtkSMProxy *	proxy () const

vtkSMProperty *	property () const

virtual char *	panelVisibility () const
	Forward calls to vtkSMProperty. More...

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	selectPort (int portIndex)
	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
pqSMProxy	chosenProxy

Additional Inherited Members
Public Slots inherited from pqPropertyWidget
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

pqPropertyWidget that can be used for any proxy with a vtkSMProxyListDomain.

pqProxyPropertyWidget automatically creates this widget when it encounters a property with vtkSMProxyListDomain.

Definition at line 21 of file pqProxySelectionWidget.h.

Constructor & Destructor Documentation

◆ pqProxySelectionWidget()

pqProxySelectionWidget::pqProxySelectionWidget	(	vtkSMProperty *	property,
		vtkSMProxy *	proxy,
		QWidget *	parent = `nullptr`
	)

constructor requires the proxy, property.

Note that this will abort if the property does not have a ProxyListDomain.

◆ ~pqProxySelectionWidget()

pqProxySelectionWidget::~pqProxySelectionWidget ( )

override

Member Function Documentation

◆ chosenProxy()

vtkSMProxy* pqProxySelectionWidget::chosenProxy ( ) const

get the selected proxy

◆ setChosenProxy()

void pqProxySelectionWidget::setChosenProxy ( vtkSMProxy * proxy )

◆ apply()

void pqProxySelectionWidget::apply ( )

overridevirtual

Overridden to forward the call to the internal pqProxyWidget maintained for the chosen proxy.

Reimplemented from pqPropertyWidget.

◆ reset()

void pqProxySelectionWidget::reset ( )

overridevirtual

Reimplemented from pqPropertyWidget.

◆ select()

void pqProxySelectionWidget::select ( )

overridevirtual

These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive.

Only widgets that have interactive widgets need to override these methods to select/deselect the interactive widgets. selectPort(int) allows to specify an output port index and conditionnaly select the interactive widget if the XML hint WidgetVisibilityLink has been set. Default implementation does nothing.

Reimplemented from pqPropertyWidget.

◆ deselect()

void pqProxySelectionWidget::deselect ( )

overridevirtual

These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive.

Only widgets that have interactive widgets need to override these methods to select/deselect the interactive widgets. selectPort(int) allows to specify an output port index and conditionnaly select the interactive widget if the XML hint WidgetVisibilityLink has been set. Default implementation does nothing.

Reimplemented from pqPropertyWidget.

◆ updateWidget()

void pqProxySelectionWidget::updateWidget ( bool showing_advanced_properties )

overridevirtual

Reimplemented from pqPropertyWidget.

◆ setPanelVisibility()

void pqProxySelectionWidget::setPanelVisibility ( const char * vis )

overridevirtual

Reimplemented from pqPropertyWidget.

◆ setView()

void pqProxySelectionWidget::setView ( pqView * )

overridevirtual

called to set the active view.

This will fire the viewChanged() signal.

Reimplemented from pqPropertyWidget.

◆ chosenProxyChanged

void pqProxySelectionWidget::chosenProxyChanged ( )

signal

Signal fired by setChosenProxy() when the proxy changes.

Property Documentation

◆ chosenProxy

pqSMProxy pqProxySelectionWidget::chosenProxy

readwrite

Definition at line 25 of file pqProxySelectionWidget.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqProxySelectionWidget.h

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqProxySelectionWidget()

◆ ~pqProxySelectionWidget()

Member Function Documentation

◆ chosenProxy()

◆ setChosenProxy()

◆ apply()

◆ reset()

◆ select()

◆ deselect()

◆ updateWidget()

◆ setPanelVisibility()

◆ setView()

◆ chosenProxyChanged

Property Documentation

◆ chosenProxy