decorator to show/hide or enable/disable property widget based on the session. More...

#include <pqSessionTypeDecorator.h>

Inheritance diagram for pqSessionTypeDecorator:

Collaboration diagram for pqSessionTypeDecorator:

Public Member Functions
	pqSessionTypeDecorator (vtkPVXMLElement config, pqPropertyWidget parent)

	~pqSessionTypeDecorator () override


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

bool	enableWidget () const override
	Methods overridden from pqPropertyWidget. 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

decorator to show/hide or enable/disable property widget based on the session.

pqSessionTypeDecorator is a pqPropertyWidgetDecorator subclass that can be used to show/hide or enable/disable a pqPropertyWidget based on the current session.

The XML config for this decorate takes two attributes 'requires' and 'mode'. 'mode' can have values 'visibility' or 'enabled_state' which dictates whether the decorator shows/hides or enables/disables the widget respectively.

'requires' can have values 'remote', 'parallel', 'parallel_data_server', or 'parallel_render_server' indicating if the session must be remote, or parallel with either data server or render server having more than 1 rank, or parallel data-server, or parallel render-server respectively.

Definition at line 29 of file pqSessionTypeDecorator.h.

Constructor & Destructor Documentation

◆ pqSessionTypeDecorator()

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

◆ ~pqSessionTypeDecorator()

pqSessionTypeDecorator::~pqSessionTypeDecorator ( )

override

Member Function Documentation

◆ canShowWidget()

bool pqSessionTypeDecorator::canShowWidget ( bool show_advanced ) const

overridevirtual

Methods overridden from pqPropertyWidget.

Reimplemented from pqPropertyWidgetDecorator.

◆ enableWidget()

bool pqSessionTypeDecorator::enableWidget ( ) const