Property widget that can be used to edit a proxy set as the value of a ProxyProperty in a pop-up dialog. More...

#include <pqProxyEditorPropertyWidget.h>

Inheritance diagram for pqProxyEditorPropertyWidget:

Collaboration diagram for pqProxyEditorPropertyWidget:

Public Slots
void	setProxyToEdit (pqSMProxy)

Public Slots inherited from pqPropertyWidget
virtual void	setView (pqView *)
	called to set the active view. More...

Signals
void	dummySignal ()

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

	~pqProxyEditorPropertyWidget () override

pqSMProxy	proxyToEdit () const

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

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	buttonClicked ()

Properties
pqSMProxy	proxyToEdit

Additional Inherited Members
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

Property widget that can be used to edit a proxy set as the value of a ProxyProperty in a pop-up dialog.

e.g. RenderView proxy has a "GridActor3D" ProxyProperty which is set to a "GridActor3D" proxy. Using this widget allows the users to edit the properties on this GridActor3D, when present.

To use this widget, add 'panel_widget="proxy_editor"' to the property's XML.

Since it's common to have a property on the proxy being edited in the popup dialog which controls its visibility (or enabled state), we add support for putting that property as a checkbox in this pqProxyEditorPropertyWidget itself. For that, one can use ProxyEditorPropertyWidget hints.

Example XML:

<ProxyProperty name="AxesGrid" ...  >
  <ProxyListDomain name="proxy_list">
    <Proxy group="annotations" name="GridAxes3DActor" />
  </ProxyListDomain>
  <Hints>
    <ProxyEditorPropertyWidget property="Visibility" />
  </Hints>
</ProxyProperty>

Definition at line 40 of file pqProxyEditorPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqProxyEditorPropertyWidget()

pqProxyEditorPropertyWidget::pqProxyEditorPropertyWidget	(	vtkSMProxy *	proxy,
		vtkSMProperty *	smproperty,
		QWidget *	parent = `nullptr`
	)

◆ ~pqProxyEditorPropertyWidget()

pqProxyEditorPropertyWidget::~pqProxyEditorPropertyWidget ( )

override

Member Function Documentation

◆ proxyToEdit()

pqSMProxy pqProxyEditorPropertyWidget::proxyToEdit ( ) const

◆ setProxyToEdit

void pqProxyEditorPropertyWidget::setProxyToEdit ( pqSMProxy )

slot

◆ buttonClicked

void pqProxyEditorPropertyWidget::buttonClicked ( )

protectedslot

◆ dummySignal

void pqProxyEditorPropertyWidget::dummySignal ( )

signal

Property Documentation

◆ proxyToEdit

pqSMProxy pqProxyEditorPropertyWidget::proxyToEdit

readwrite

Definition at line 44 of file pqProxyEditorPropertyWidget.h.

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

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

Public Slots

Signals

Public Member Functions

Protected Slots

Properties

Additional Inherited Members