xentara::workbench::bindings::ToggleSwitch Class Reference

A toggle switch for selecting a Boolean option. More...

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

Inheritance diagram for xentara::workbench::bindings::ToggleSwitch:

Classes
struct	Options
	Options for the binding. More...

Public Member Functions
template<Bindable< bool > Property>
	ToggleSwitch (PropertyController &propertyController, Property &property, Options options)
	Constructor that accesses the variable holding a property’s value directly.
template<typename Object , Getter< bool, Object > GetterType, Setter< bool, Object > SetterType>
	ToggleSwitch (const PropertyHandle &property, Object &object, GetterType get, SetterType set, Options options)
	Constructor that uses a getter and setter to access a property.

Detailed Description

A toggle switch for selecting a Boolean option.

Constructor & Destructor Documentation

ToggleSwitch() [1/2]

template<Bindable< bool > Property>

xentara::workbench::bindings::ToggleSwitch::ToggleSwitch	(	PropertyController &	propertyController,
		Property &	property,
		Options	options
	)

Constructor that accesses the variable holding a property’s value directly.

Attention

This constructor can only be used for address-based properties.

Parameters

propertyController	The property controller that manages the property
property	A reference to the variable holding the property’s value.
options	The binding options

ToggleSwitch() [2/2]

template<typename Object , Getter< bool, Object > GetterType, Setter< bool, Object > SetterType>

xentara::workbench::bindings::ToggleSwitch::ToggleSwitch	(	const PropertyHandle &	property,
		Object &	object,
		GetterType	get,
		SetterType	set,
		Options	options
	)

Constructor that uses a getter and setter to access a property.

Parameters

property	A handle to the bound property
object	The object on which the getter and setter should be called
get	The getter function
set	The setter function
options	The binding options