pqGenericPropertyWidgetDecorator is a pqPropertyWidgetDecorator that supports multiple common use cases from a pqPropertyWidgetDecorator. More...

#include <pqGenericPropertyWidgetDecorator.h>

Inheritance diagram for pqGenericPropertyWidgetDecorator:

[legend]

Collaboration diagram for pqGenericPropertyWidgetDecorator:

[legend]

Public Member Functions
	pqGenericPropertyWidgetDecorator (vtkPVXMLElement config, pqPropertyWidget parent)

	~pqGenericPropertyWidgetDecorator () override

bool	canShowWidget (bool show_advanced) const override
	Methods overridden from pqPropertyWidget. More...

bool	enableWidget () const override
	Override this method to override the enable state of the widget in the panel. More...

Public Member Functions inherited from pqPropertyWidgetDecorator
	pqPropertyWidgetDecorator (vtkPVXMLElement xml, pqPropertyWidget parent)
	Constructor. More...

	~pqPropertyWidgetDecorator () override

pqPropertyWidget *	parentWidget () const
	Returns the pqPropertyWidget parent. More...

Additional Inherited Members
Signals inherited from pqPropertyWidgetDecorator
void	visibilityChanged ()
	This signal is fired whenever the decorator has determined that the panel may need a refresh since the state of the system has changed which would deem changes in the widget visibility or enable state. More...

void	enableStateChanged ()

Static Public Member Functions inherited from pqPropertyWidgetDecorator
static pqPropertyWidgetDecorator *	create (vtkPVXMLElement xml, pqPropertyWidget parent)
	Creates a new decorator, given the xml config and the parent pqPropertyWidget for the decorator. More...

Protected Member Functions inherited from pqPropertyWidgetDecorator
vtkPVXMLElement *	xml () const

Detailed Description

pqGenericPropertyWidgetDecorator is a pqPropertyWidgetDecorator that supports multiple common use cases from a pqPropertyWidgetDecorator.

The use cases supported are as follows:

1. enabling the pqPropertyWidget when the value of another property element matches a specific value (disabling otherwise).
2. similar to 1, except instead of enabling/disabling the widget is made "default" when the values match and "advanced" otherwise.
3. enabling the pqPropertyWidget when the array named in the property has a specified number of components.
4. as well as "inverse" of all the above i.e. when the value doesn't match the specified value. Example usages:
VectorScaleMode, Stride, Seed, MaximumNumberOfSamplePoints properties on the Glyph proxy.

Definition at line 27 of file pqGenericPropertyWidgetDecorator.h.

Constructor & Destructor Documentation

◆ pqGenericPropertyWidgetDecorator()

pqGenericPropertyWidgetDecorator::pqGenericPropertyWidgetDecorator	(	vtkPVXMLElement *	config,
		pqPropertyWidget *	parent
	)

◆ ~pqGenericPropertyWidgetDecorator()

pqGenericPropertyWidgetDecorator::~pqGenericPropertyWidgetDecorator ( )

override

Member Function Documentation

◆ canShowWidget()

bool pqGenericPropertyWidgetDecorator::canShowWidget ( bool show_advanced ) const

overridevirtual

Methods overridden from pqPropertyWidget.

Reimplemented from pqPropertyWidgetDecorator.

◆ enableWidget()

bool pqGenericPropertyWidgetDecorator::enableWidget ( ) const

overridevirtual

Override this method to override the enable state of the widget in the panel.

This is called after the generic tests for advanced and text filtering are passed. Since there can be multiple decorators, the first decorator that returns 'false' wins. Default implementation returns true. Thus subclasses typically override this method only to force the widget disabled given the current state.