xentara::workbench::bindings::CrossReferenceController Class Reference

Base class for objects that contain a cross reference from one property controller to another. More...

#include <xentara/workbench/bindings/CrossReferenceController.hpp>

Inheritance diagram for xentara::workbench::bindings::CrossReferenceController:

Public Member Functions
	CrossReferenceController () noexcept=default
	Default constructor.
	CrossReferenceController (const CrossReferenceController &other)
	Copy constructor.
	CrossReferenceController (CrossReferenceController &&other) noexcept
	Move constructor.
virtual	~CrossReferenceController ()=0
	Virtual destructor.
auto	operator= (const CrossReferenceController &rhs) -> CrossReferenceController &
	Copy assignment operator.
auto	operator= (CrossReferenceController &&rhs) noexcept -> CrossReferenceController &
	Move assignment operator that does not actually assign anything.
auto	setReferringController (PropertyController &referringController) -> void
	Sets the referring controller, that is the property controller that contains this object.
auto	referringController () const -> PropertyController *
	Gets the referring controller.

Detailed Description

Base class for objects that contain a cross reference from one property controller to another.

Constructor & Destructor Documentation

CrossReferenceController() [1/3]

xentara::workbench::bindings::CrossReferenceController::CrossReferenceController ( )

defaultnoexcept

Default constructor.

CrossReferenceController() [2/3]

xentara::workbench::bindings::CrossReferenceController::CrossReferenceController

(

const CrossReferenceController &

other

)

Copy constructor.

This constructor does not copy the reference to the referring controller. The new container will not have a referring controller.

Parameters

other

The container that is to be copied

CrossReferenceController() [3/3]

xentara::workbench::bindings::CrossReferenceController::CrossReferenceController ( CrossReferenceController &&  other )

noexcept

Move constructor.

This constructor does not move the reference to the referring controller. The new container will not have a referring controller.

Parameters

other

The container that is to be moved

~CrossReferenceController()

xentara::workbench::bindings::CrossReferenceController::~CrossReferenceController ( )

pure virtualdefault

Virtual destructor.

Member Function Documentation

operator=() [1/2]

auto xentara::workbench::bindings::CrossReferenceController::operator=

(

const CrossReferenceController &

rhs

)

-> CrossReferenceController &

Copy assignment operator.

This assignment operator does not change the reference to the referring controller.

Parameters

rhs	The container that is to be copied

Returns

A reference to this object

operator=() [2/2]

auto xentara::workbench::bindings::CrossReferenceController::operator= ( CrossReferenceController &&  rhs ) -> CrossReferenceController &

noexcept

Move assignment operator that does not actually assign anything.

This assignment operator does not change the reference to the referring controller.

Parameters

rhs	The container that is to be moved

Returns

A reference to this object

referringController()

auto xentara::workbench::bindings::CrossReferenceController::referringController

(

)

const -> PropertyController *

Gets the referring controller.

Returns

The referring controller, or nullptr if none is set.

setReferringController()

auto xentara::workbench::bindings::CrossReferenceController::setReferringController

(

PropertyController &

referringController

)

-> void

Sets the referring controller, that is the property controller that contains this object.

Note

You do not have to call this function yourself. It is called automatically when properties are configured inside PropertyController::configureProperties().

Parameters

referringController

The referring controller.