Translates server manager events into Qt-compatible slots and signals. More...

#include <pqSMAdaptor.h>

Public Types
enum	PropertyType { UNKNOWN, PROXY, PROXYLIST, PROXYSELECTION, SELECTION, ENUMERATION, SINGLE_ELEMENT, MULTIPLE_ELEMENTS, FILE_LIST, COMPOSITE_TREE }
	enumeration for types of properties this class handles More...

enum	PropertyValueType { CHECKED, UNCHECKED }

Static Public Member Functions
static PropertyType	getPropertyType (vtkSMProperty *Property)
	Get the type of the property. More...

static pqSMProxy	getProxyProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
	get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with More...

static void	addProxyProperty (vtkSMProperty *Property, pqSMProxy Value)
	get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with More...

static void	removeProxyProperty (vtkSMProperty *Property, pqSMProxy Value)

static void	setProxyProperty (vtkSMProperty *Property, pqSMProxy Value)

static void	setUncheckedProxyProperty (vtkSMProperty *Property, pqSMProxy Value)

static void	addInputProperty (vtkSMProperty *Property, pqSMProxy Value, int opport)

static void	setInputProperty (vtkSMProperty *Property, pqSMProxy Value, int opport)

static QList< QVariant >	getProxyListProperty (vtkSMProperty *Property)
	get the list of proxies for a property for example, append filter accepts a list of proxies More...

static void	setProxyListProperty (vtkSMProperty *Property, QList< QVariant > Value)
	get the list of proxies for a property for example, append filter accepts a list of proxies More...

static QList< pqSMProxy >	getProxyPropertyDomain (vtkSMProperty *Property)
	get the list of possible proxies for a property More...

static QList< QList< QVariant > >	getSelectionProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
	get the pairs of selections for a selection property More...

static QList< QVariant >	getSelectionProperty (vtkSMProperty *Property, unsigned int Index, PropertyValueType Type=CHECKED)
	get the pairs of selections for a selection property More...

static void	setSelectionProperty (vtkSMProperty *Property, QList< QList< QVariant >> Value, PropertyValueType Type=CHECKED)
	set the pairs of selections for a selection property More...

static void	setSelectionProperty (vtkSMProperty *Property, QList< QVariant > Value, PropertyValueType Type=CHECKED)
	used to set the status of an array, for example. More...

static QList< QVariant >	getSelectionPropertyDomain (vtkSMProperty *Property)
	get the possible names for the selection property More...

static QList< QVariant >	getStringListProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
	get the list of strings for the given property based on domain and current values. More...

static QVariant	getEnumerationProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
	get the enumeration for a property More...

static void	setEnumerationProperty (vtkSMProperty *Property, QVariant Value, PropertyValueType Type=CHECKED)
	set the enumeration for a property More...

static QList< QVariant >	getEnumerationPropertyDomain (vtkSMProperty *Property)
	get the possible enumerations (string) for a property More...

static QVariant	getElementProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
	get the single element of a property (integer, string, real, etc..) More...

static void	setElementProperty (vtkSMProperty *Property, QVariant Value, PropertyValueType Type=CHECKED)
	set the single element of a property (integer, string, real, etc..) More...

static QList< QVariant >	getElementPropertyDomain (vtkSMProperty *Property)
	get the range of possible values to set the single element of a property More...

static QList< QVariant >	getMultipleElementProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
	get the multiple elements of a property (integer, string, real, etc..) More...

static void	setMultipleElementProperty (vtkSMProperty *Property, QList< QVariant > Value, PropertyValueType Type=CHECKED)
	set the multiple elements of a property (integer, string, real, etc..) More...

static QList< QList< QVariant > >	getMultipleElementPropertyDomain (vtkSMProperty *Property)
	get the ranges of possible values to set the multiple elements of a property More...

static QVariant	getMultipleElementProperty (vtkSMProperty *Property, unsigned int Index, PropertyValueType Type=CHECKED)
	get one of the multiple elements of a property (integer, string, real, etc..) More...

static void	setMultipleElementProperty (vtkSMProperty *Property, unsigned int Index, QVariant Value, PropertyValueType Type=CHECKED)
	set one of the multiple elements of a property (integer, string, real, etc..) More...

static QList< QVariant >	getMultipleElementPropertyDomain (vtkSMProperty *Property, unsigned int Index)
	get one of the ranges of possible values to set the multiple elements of a property More...

static QStringList	getFileListProperty (vtkSMProperty *Property, PropertyValueType Type=CHECKED)
	get the single element of a property (integer, string, real, etc..) More...

static void	setFileListProperty (vtkSMProperty *Property, QStringList Value, PropertyValueType Type=CHECKED)
	set the single element of a property (integer, string, real, etc..) More...

static QList< QString >	getDomainTypes (vtkSMProperty *property)
	Returns a list of domains types for the property. More...

static void	clearUncheckedProperties (vtkSMProperty *property)
	Clears any unchecked values on the property. More...

static QVariant	convertToQVariant (const vtkVariant &variant)
	Converts a vtkVariant into a QVariant. More...

Protected Member Functions
	pqSMAdaptor ()

	~pqSMAdaptor ()

Detailed Description

Translates server manager events into Qt-compatible slots and signals.

Definition at line 22 of file pqSMAdaptor.h.

Member Enumeration Documentation

◆ PropertyType

enum pqSMAdaptor::PropertyType

enumeration for types of properties this class handles

Enumerator
UNKNOWN
PROXY
PROXYLIST
PROXYSELECTION
SELECTION
ENUMERATION
SINGLE_ELEMENT
MULTIPLE_ELEMENTS
FILE_LIST
COMPOSITE_TREE

Definition at line 33 of file pqSMAdaptor.h.

◆ PropertyValueType

enum pqSMAdaptor::PropertyValueType

Enumerator
CHECKED
UNCHECKED

Definition at line 47 of file pqSMAdaptor.h.

Constructor & Destructor Documentation

◆ pqSMAdaptor()

pqSMAdaptor::pqSMAdaptor ( )

protected

◆ ~pqSMAdaptor()

pqSMAdaptor::~pqSMAdaptor ( )

protected

Member Function Documentation

◆ getPropertyType()

static PropertyType pqSMAdaptor::getPropertyType ( vtkSMProperty * Property )

static

Get the type of the property.

◆ getProxyProperty()

static pqSMProxy pqSMAdaptor::getProxyProperty	(	vtkSMProperty *	Property,
		PropertyValueType	Type = `CHECKED`
	)

static

get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with

◆ addProxyProperty()

static void pqSMAdaptor::addProxyProperty	(	vtkSMProperty *	Property,
		pqSMProxy	Value
	)

static

get the proxy for a property for example, glyph filter accepts a source (proxy) to glyph with

◆ removeProxyProperty()

static void pqSMAdaptor::removeProxyProperty	(	vtkSMProperty *	Property,
		pqSMProxy	Value
	)

static

◆ setProxyProperty()

static void pqSMAdaptor::setProxyProperty	(	vtkSMProperty *	Property,
		pqSMProxy	Value
	)

static

◆ setUncheckedProxyProperty()

static void pqSMAdaptor::setUncheckedProxyProperty	(	vtkSMProperty *	Property,
		pqSMProxy	Value
	)

static

◆ addInputProperty()

static void pqSMAdaptor::addInputProperty	(	vtkSMProperty *	Property,
		pqSMProxy	Value,
		int	opport
	)

static

◆ setInputProperty()

static void pqSMAdaptor::setInputProperty	(	vtkSMProperty *	Property,
		pqSMProxy	Value,
		int	opport
	)

static

◆ getProxyListProperty()

static QList<QVariant> pqSMAdaptor::getProxyListProperty ( vtkSMProperty * Property )

static

get the list of proxies for a property for example, append filter accepts a list of proxies

◆ setProxyListProperty()

static void pqSMAdaptor::setProxyListProperty	(	vtkSMProperty *	Property,
		QList< QVariant >	Value
	)

static

get the list of proxies for a property for example, append filter accepts a list of proxies

◆ getProxyPropertyDomain()

static QList<pqSMProxy> pqSMAdaptor::getProxyPropertyDomain ( vtkSMProperty * Property )

static

get the list of possible proxies for a property

◆ getSelectionProperty() [1/2]

static QList<QList<QVariant> > pqSMAdaptor::getSelectionProperty	(	vtkSMProperty *	Property,
		PropertyValueType	Type = `CHECKED`
	)

static

get the pairs of selections for a selection property

◆ getSelectionProperty() [2/2]

static QList<QVariant> pqSMAdaptor::getSelectionProperty	(	vtkSMProperty *	Property,
		unsigned int	Index,
		PropertyValueType	Type = `CHECKED`
	)

static

get the pairs of selections for a selection property

◆ setSelectionProperty() [1/2]

static void pqSMAdaptor::setSelectionProperty	(	vtkSMProperty *	Property,
		QList< QList< QVariant >>	Value,
		PropertyValueType	Type = `CHECKED`
	)

static

set the pairs of selections for a selection property

◆ setSelectionProperty() [2/2]

static void pqSMAdaptor::setSelectionProperty	(	vtkSMProperty *	Property,
		QList< QVariant >	Value,
		PropertyValueType	Type = `CHECKED`
	)

static

used to set the status of an array, for example.

note that this method can only be used for properties with vtkSMArraySelectionDomain or vtkSMStringListRangeDomain.

◆ getSelectionPropertyDomain()

static QList<QVariant> pqSMAdaptor::getSelectionPropertyDomain ( vtkSMProperty * Property )

static

get the possible names for the selection property

◆ getStringListProperty()

static QList<QVariant> pqSMAdaptor::getStringListProperty	(	vtkSMProperty *	Property,
		PropertyValueType	Type = `CHECKED`
	)

static

get the list of strings for the given property based on domain and current values.

◆ getEnumerationProperty()

static QVariant pqSMAdaptor::getEnumerationProperty	(	vtkSMProperty *	Property,
		PropertyValueType	Type = `CHECKED`
	)

static

get the enumeration for a property

◆ setEnumerationProperty()

static void pqSMAdaptor::setEnumerationProperty	(	vtkSMProperty *	Property,
		QVariant	Value,
		PropertyValueType	Type = `CHECKED`
	)

static

set the enumeration for a property

◆ getEnumerationPropertyDomain()

static QList<QVariant> pqSMAdaptor::getEnumerationPropertyDomain ( vtkSMProperty * Property )

static

get the possible enumerations (string) for a property

◆ getElementProperty()

static QVariant pqSMAdaptor::getElementProperty	(	vtkSMProperty *	Property,
		PropertyValueType	Type = `CHECKED`
	)

static

get the single element of a property (integer, string, real, etc..)

◆ setElementProperty()

static void pqSMAdaptor::setElementProperty	(	vtkSMProperty *	Property,
		QVariant	Value,
		PropertyValueType	Type = `CHECKED`
	)

static

set the single element of a property (integer, string, real, etc..)

◆ getElementPropertyDomain()

static QList<QVariant> pqSMAdaptor::getElementPropertyDomain ( vtkSMProperty * Property )

static

get the range of possible values to set the single element of a property

◆ getMultipleElementProperty() [1/2]

static QList<QVariant> pqSMAdaptor::getMultipleElementProperty	(	vtkSMProperty *	Property,
		PropertyValueType	Type = `CHECKED`
	)

static

get the multiple elements of a property (integer, string, real, etc..)

◆ setMultipleElementProperty() [1/2]

static void pqSMAdaptor::setMultipleElementProperty	(	vtkSMProperty *	Property,
		QList< QVariant >	Value,
		PropertyValueType	Type = `CHECKED`
	)

static

set the multiple elements of a property (integer, string, real, etc..)

◆ getMultipleElementPropertyDomain() [1/2]

static QList<QList<QVariant> > pqSMAdaptor::getMultipleElementPropertyDomain ( vtkSMProperty * Property )

static

get the ranges of possible values to set the multiple elements of a property

◆ getMultipleElementProperty() [2/2]

static QVariant pqSMAdaptor::getMultipleElementProperty	(	vtkSMProperty *	Property,
		unsigned int	Index,
		PropertyValueType	Type = `CHECKED`
	)

static

get one of the multiple elements of a property (integer, string, real, etc..)

◆ setMultipleElementProperty() [2/2]

static void pqSMAdaptor::setMultipleElementProperty	(	vtkSMProperty *	Property,
		unsigned int	Index,
		QVariant	Value,
		PropertyValueType	Type = `CHECKED`
	)

static

set one of the multiple elements of a property (integer, string, real, etc..)

◆ getMultipleElementPropertyDomain() [2/2]

static QList<QVariant> pqSMAdaptor::getMultipleElementPropertyDomain	(	vtkSMProperty *	Property,
		unsigned int	Index
	)

static

get one of the ranges of possible values to set the multiple elements of a property

◆ getFileListProperty()

static QStringList pqSMAdaptor::getFileListProperty	(	vtkSMProperty *	Property,
		PropertyValueType	Type = `CHECKED`
	)

static

get the single element of a property (integer, string, real, etc..)

◆ setFileListProperty()

static void pqSMAdaptor::setFileListProperty	(	vtkSMProperty *	Property,
		QStringList	Value,
		PropertyValueType	Type = `CHECKED`
	)

static

set the single element of a property (integer, string, real, etc..)

◆ getDomainTypes()

static QList<QString> pqSMAdaptor::getDomainTypes ( vtkSMProperty * property )

static

Returns a list of domains types for the property.

eg. if a property has vtkSMBoundsDomain and vtkSMArrayListDomain then this method will returns ["vtkSMBoundsDomain", "vtkSMArrayListDomain"].

◆ clearUncheckedProperties()

static void pqSMAdaptor::clearUncheckedProperties ( vtkSMProperty * property )

static

Clears any unchecked values on the property.

◆ convertToQVariant()

static QVariant pqSMAdaptor::convertToQVariant ( const vtkVariant & variant )

static

Converts a vtkVariant into a QVariant.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Core/pqSMAdaptor.h

Public Types

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ PropertyType

◆ PropertyValueType

Constructor & Destructor Documentation

◆ pqSMAdaptor()

◆ ~pqSMAdaptor()

Member Function Documentation

◆ getPropertyType()

◆ getProxyProperty()

◆ addProxyProperty()

◆ removeProxyProperty()

◆ setProxyProperty()

◆ setUncheckedProxyProperty()

◆ addInputProperty()

◆ setInputProperty()

◆ getProxyListProperty()

◆ setProxyListProperty()

◆ getProxyPropertyDomain()

◆ getSelectionProperty() [1/2]

◆ getSelectionProperty() [2/2]

◆ setSelectionProperty() [1/2]

◆ setSelectionProperty() [2/2]

◆ getSelectionPropertyDomain()

◆ getStringListProperty()

◆ getEnumerationProperty()

◆ setEnumerationProperty()

◆ getEnumerationPropertyDomain()

◆ getElementProperty()

◆ setElementProperty()

◆ getElementPropertyDomain()

◆ getMultipleElementProperty() [1/2]

◆ setMultipleElementProperty() [1/2]

◆ getMultipleElementPropertyDomain() [1/2]

◆ getMultipleElementProperty() [2/2]

◆ setMultipleElementProperty() [2/2]

◆ getMultipleElementPropertyDomain() [2/2]

◆ getFileListProperty()

◆ setFileListProperty()

◆ getDomainTypes()

◆ clearUncheckedProperties()

◆ convertToQVariant()