pqPropertyGroupWidget is a (custom) widget created for a PropertyGroup. More...

#include <pqPropertyGroupWidget.h>

Inheritance diagram for pqPropertyGroupWidget:

[legend]

Collaboration diagram for pqPropertyGroupWidget:

Public Member Functions
	pqPropertyGroupWidget (vtkSMProxy proxy, vtkSMPropertyGroup smGroup, QWidget *parent=nullptr)

vtkSMPropertyGroup *	propertyGroup () 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)

pqView *	view () const

vtkSMProxy *	proxy () const

vtkSMProperty *	property () 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...

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

Additional Inherited Members
Public Slots inherited from pqPropertyWidget
virtual void	setView (pqView *)
	called to set the active view. 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...

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

pqPropertyGroupWidget is a (custom) widget created for a PropertyGroup.

It provides functions for linking standard controls with Server Manager properties as well as storing the property group.

See also: vtkSMPropertyGroup

Definition at line 29 of file pqPropertyGroupWidget.h.

Constructor & Destructor Documentation

◆ pqPropertyGroupWidget()

pqPropertyGroupWidget::pqPropertyGroupWidget	(	vtkSMProxy *	proxy,
		vtkSMPropertyGroup *	smGroup,
		QWidget *	parent = `nullptr`
	)

Member Function Documentation

◆ propertyGroup()

vtkSMPropertyGroup* pqPropertyGroupWidget::propertyGroup ( ) const

inline

Definition at line 36 of file pqPropertyGroupWidget.h.

◆ addPropertyLink() [1/9]

void pqPropertyGroupWidget::addPropertyLink	(	QComboBox *	cb,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [2/9]

void pqPropertyGroupWidget::addPropertyLink	(	QLineEdit *	edit,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [3/9]

void pqPropertyGroupWidget::addPropertyLink	(	QCheckBox *	button,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [4/9]

void pqPropertyGroupWidget::addPropertyLink	(	QToolButton *	button,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [5/9]

void pqPropertyGroupWidget::addPropertyLink	(	QGroupBox *	groupBox,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [6/9]

void pqPropertyGroupWidget::addPropertyLink	(	QDoubleSpinBox *	spinBox,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [7/9]

void pqPropertyGroupWidget::addPropertyLink	(	QSpinBox *	spinBox,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [8/9]

void pqPropertyGroupWidget::addPropertyLink	(	pqColorChooserButton *	color,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ addPropertyLink() [9/9]

void pqPropertyGroupWidget::addPropertyLink	(	pqDoubleSliderWidget *	slider,
		const char *	propertyName,
		int	smindex = `-1`
	)

◆ panelVisibility()

char* pqPropertyGroupWidget::panelVisibility ( ) const

overridevirtual

Overwrite pqPropertyWidget to forward calls to vtkSMPropertyGroup.

Reimplemented from pqPropertyWidget.

◆ setPanelVisibility()

void pqPropertyGroupWidget::setPanelVisibility ( const char * vis )