pqPropertyLinksConnection Class Reference

pqPropertyLinksConnection is used by pqPropertyLinks to keep a QObject and vtkSMProperty linked together. More...

#include <pqPropertyLinksConnection.h>

Inherits QObject.

Public Slots
void	copyValuesFromServerManagerToQt (bool use_unchecked)
	Copy values from ServerManager to Qt. More...
void	copyValuesFromQtToServerManager (bool use_unchecked)
	Copy values from Qt to ServerManager. More...

Signals
void	qtpropertyModified ()
	Fired whenever the Qt widget changes (except during a call to copyValuesFromServerManagerToQt()). More...
void	smpropertyModified ()
	Fired whenever the ServerManager property changes (except during a call to copyValuesFromQtToServerManager()). More...

Public Member Functions
	pqPropertyLinksConnection (QObject *qobject, const char *qproperty, const char *qsignal, vtkSMProxy *smproxy, vtkSMProperty *smproperty, int smindex, bool use_unchecked_modified_event, QObject *parentObject=nullptr)
	This also sets up observers to monitor any changes. More...
	~pqPropertyLinksConnection () override
void	setUseUncheckedProperties (bool useUnchecked)
bool	operator== (const pqPropertyLinksConnection &other) const
	Comparison operator. More...
QObject *	objectQt () const
	Provides access to the Qt QObject and property name. More...
const QString &	propertyQt () const
vtkSMProxy *	proxy () const
	Provides access to the ServerManager proxy/property/index. More...
vtkSMProxy *	proxySM () const
vtkSMProperty *	propertySM () const
int	indexSM () const
void	setTraceChanges (bool trace)
	Provide access to whether changes sent from Qt to the server manager are traceable. More...
bool	traceChanges () const

Protected Member Functions
virtual void	setQtValue (const QVariant &value)
	These are the methods that subclasses can override to customize how values are updated in either directions. More...
virtual void	setServerManagerValue (bool use_unchecked, const QVariant &value)
virtual QVariant	currentQtValue () const
virtual QVariant	currentServerManagerValue (bool use_unchecked) const

Detailed Description

pqPropertyLinksConnection is used by pqPropertyLinks to keep a QObject and vtkSMProperty linked together.

pqPropertyLinksConnection handles most common types of connections. Developers can subclass this to customize the mechanisms for copy values from Qt to ServerManager and vice-versa.

Definition at line 26 of file pqPropertyLinksConnection.h.

Constructor & Destructor Documentation

pqPropertyLinksConnection()

pqPropertyLinksConnection::pqPropertyLinksConnection	(	QObject *	qobject,
		const char *	qproperty,
		const char *	qsignal,
		vtkSMProxy *	smproxy,
		vtkSMProperty *	smproperty,
		int	smindex,
		bool	use_unchecked_modified_event,
		QObject *	parentObject = nullptr
	)

This also sets up observers to monitor any changes.

This does not change any values on either items.

~pqPropertyLinksConnection()

pqPropertyLinksConnection::~pqPropertyLinksConnection ( )

override

Member Function Documentation

setUseUncheckedProperties()

void pqPropertyLinksConnection::setUseUncheckedProperties

(

bool

useUnchecked

)

operator==()

bool pqPropertyLinksConnection::operator==

(

const pqPropertyLinksConnection &

other

)

const

Comparison operator.

objectQt()

QObject* pqPropertyLinksConnection::objectQt ( ) const

inline

Provides access to the Qt QObject and property name.

Definition at line 52 of file pqPropertyLinksConnection.h.

propertyQt()

const QString& pqPropertyLinksConnection::propertyQt ( ) const

inline

Definition at line 53 of file pqPropertyLinksConnection.h.

proxy()

vtkSMProxy* pqPropertyLinksConnection::proxy ( ) const

inline

Provides access to the ServerManager proxy/property/index.

Definition at line 58 of file pqPropertyLinksConnection.h.

proxySM()

vtkSMProxy* pqPropertyLinksConnection::proxySM ( ) const

inline

Definition at line 59 of file pqPropertyLinksConnection.h.

propertySM()

vtkSMProperty* pqPropertyLinksConnection::propertySM ( ) const

inline

Definition at line 60 of file pqPropertyLinksConnection.h.

indexSM()

int pqPropertyLinksConnection::indexSM ( ) const

inline

Definition at line 61 of file pqPropertyLinksConnection.h.

setTraceChanges()

void pqPropertyLinksConnection::setTraceChanges ( bool  trace )

inline

Provide access to whether changes sent from Qt to the server manager are traceable.

Definition at line 66 of file pqPropertyLinksConnection.h.

traceChanges()

bool pqPropertyLinksConnection::traceChanges ( ) const

inline

Definition at line 67 of file pqPropertyLinksConnection.h.

copyValuesFromServerManagerToQt

void pqPropertyLinksConnection::copyValuesFromServerManagerToQt ( bool  use_unchecked )

slot

Copy values from ServerManager to Qt.

If use_unchecked is true, unchecked SMProperty values are used.

copyValuesFromQtToServerManager

void pqPropertyLinksConnection::copyValuesFromQtToServerManager ( bool  use_unchecked )

slot

Copy values from Qt to ServerManager.

If use_unchecked is true, unchecked values for SMProperty are updated.

setQtValue()

virtual void pqPropertyLinksConnection::setQtValue ( const QVariant &  value )

protectedvirtual

These are the methods that subclasses can override to customize how values are updated in either directions.

setServerManagerValue()

virtual void pqPropertyLinksConnection::setServerManagerValue ( bool  use_unchecked, const QVariant &  value  )

protectedvirtual

currentQtValue()

virtual QVariant pqPropertyLinksConnection::currentQtValue ( ) const

protectedvirtual

currentServerManagerValue()

virtual QVariant pqPropertyLinksConnection::currentServerManagerValue ( bool  use_unchecked ) const

protectedvirtual

qtpropertyModified

void pqPropertyLinksConnection::qtpropertyModified ( )

signal

Fired whenever the Qt widget changes (except during a call to copyValuesFromServerManagerToQt()).

smpropertyModified

void pqPropertyLinksConnection::smpropertyModified ( )

signal

Fired whenever the ServerManager property changes (except during a call to copyValuesFromQtToServerManager()).

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Core/pqPropertyLinksConnection.h