xentara-workbench-plugin v1.0.1
The Xentara Workbench Plugin Framework
Loading...
Searching...
No Matches
xentara::workbench::bindings::InfoField Class Referencefinal

A read-only text field that can be used to show some non-editable information. More...

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

+ Inheritance diagram for xentara::workbench::bindings::InfoField:

Classes

struct  Options
 Options for the binding. More...
 

Public Member Functions

template<std::convertible_to< ui::String > Property>
 InfoField (PropertyController &propertyController, Property &property, Options options)
 Constructor that accesses the variable holding a property’s value directly.
 
template<typename Object , Getter< ui::String, Object > GetterType>
 InfoField (const PropertyHandle &property, const Object &object, GetterType get, Options options)
 Constructor that uses a getter to access a property.
 

Detailed Description

A read-only text field that can be used to show some non-editable information.

Constructor & Destructor Documentation

◆ InfoField() [1/2]

template<std::convertible_to< ui::String > Property>
xentara::workbench::bindings::InfoField::InfoField ( 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
propertyControllerThe property controller that manages the property
propertyA reference to the variable holding the property’s value.
optionsThe binding options

◆ InfoField() [2/2]

template<typename Object , Getter< ui::String, Object > GetterType>
xentara::workbench::bindings::InfoField::InfoField ( const PropertyHandle property,
const Object &  object,
GetterType  get,
Options  options 
)

Constructor that uses a getter to access a property.

Parameters
propertyA handle to the bound property
objectThe object on which the getter should be called
getThe getter function
optionsThe binding options