pqTextLinker Struct Reference

Ease of use object that connects two pqLinkedObjectInterface together. More...

#include <pqTextLinker.h>

Public Member Functions
	pqTextLinker () noexcept=default
	Default constructor with empty connections. More...
template<typename T , typename U >
	pqTextLinker (T *, U *)
	Templated constructors that takes abritrary QTextEdit like objects. More...
pqTextLinker &	operator= (const pqTextLinker &other)
	Copy assignement operators performs a deep copy of the underlying data (only if they exist) More...
void	link ()
	Links both objects to each other. More...
void	unlink ()
	Unlinks both objects. More...
bool	isLinked () const noexcept
	Returns true if one object is linked to the other. More...
bool	isLinkedTo (const QObject *Obj) const
	Returns true if the linked object is the given input parameter. More...
QString	getFirstObjectName () const
	Returns the first object name. More...
QString	getSecondObjectName () const
	Returns the second object name. More...

Detailed Description

Ease of use object that connects two pqLinkedObjectInterface together.

Note that the two objects are automatically unlinked when this get destroyed.

Definition at line 24 of file pqTextLinker.h.

Constructor & Destructor Documentation

pqTextLinker() [1/2]

pqTextLinker::pqTextLinker ( )

defaultnoexcept

Default constructor with empty connections.

pqTextLinker() [2/2]

template<typename T , typename U >

pqTextLinker::pqTextLinker ( T *  , U *    )

inlineexplicit

Templated constructors that takes abritrary QTextEdit like objects.

Definition at line 36 of file pqTextLinker.h.

Member Function Documentation

operator=()

pqTextLinker& pqTextLinker::operator= ( const pqTextLinker &  other )

inline

Copy assignement operators performs a deep copy of the underlying data (only if they exist)

Definition at line 46 of file pqTextLinker.h.

link()

void pqTextLinker::link ( )

inline

Links both objects to each other.

Definition at line 66 of file pqTextLinker.h.

unlink()

void pqTextLinker::unlink ( )

inline

Unlinks both objects.

Definition at line 78 of file pqTextLinker.h.

isLinked()

bool pqTextLinker::isLinked ( ) const

inlinenoexcept

Returns true if one object is linked to the other.

Definition at line 92 of file pqTextLinker.h.

isLinkedTo()

bool pqTextLinker::isLinkedTo ( const QObject *  Obj ) const

inline

Returns true if the linked object is the given input parameter.

Definition at line 111 of file pqTextLinker.h.

getFirstObjectName()

QString pqTextLinker::getFirstObjectName ( ) const

inline

Returns the first object name.

Definition at line 130 of file pqTextLinker.h.

getSecondObjectName()

QString pqTextLinker::getSecondObjectName ( ) const

inline

Returns the second object name.

Definition at line 143 of file pqTextLinker.h.

---

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

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