AUI Framework  master
Cross-platform module-based framework for developing C++20 desktop applications
ADataBinding< Model > Class Template Reference

Data binding implementation. More...

Detailed Description

template<typename Model>
class ADataBinding< Model >

Data binding implementation.

Template Parameters
ModelYour model type.

If const reference of your model passed, ADataBinding will create and manage its own copy of your model.

If pointer of your model passed, ADataBinding will reference to your model and write directly to your model. When ADataBinding is destructed the pointer will not be deleted.

Example:

_new<ATextField>() && dataBinding(&User::username)

This code will bind ATextField with username field in the User model.

Another example:

class MyWindow: public AWindow {
public:
MyWindow(): AWindow("Test") {
struct Model {
int value = 0;
};
auto data = _new<ADataBinding<Model>>(Model{});
data->addObserver(&Model::value, [](int v) {
ALogger::info("Debug") << "New value: " << v;
});
setContents(Centered {
Label { } let {
data->addObserver(&Model::value, [it](int v) {
it->setText("{}"_format(v));
});
},
Button{"+"}.clicked(this, [data] {
data->getEditableModel().value += 1;
data->notifyUpdate();
}),
Button{"-"}.clicked(this, [data] {
data->getEditableModel().value -= 1;
data->notifyUpdate();
}),
},
}
});
}
};
Represents a window in the underlying windowing system.
Definition: AWindow.h:45
#define let
Performs multiple operations on a single object without repeating its name (in place) This function c...
Definition: kAUI.h:262

Here, we use getEditableModel() in order to change data in our model and notifyUpdate() to notify.

Also, we use let construction to define custom format for label.

Public Member Functions

 ADataBinding (const Model &m)
 
 ADataBinding (Model *m)
 
template<typename View , typename ModelField , typename SetterArg >
auto operator() (ModelField(Model::*field), void(View::*setterFunc)(SetterArg))
 Create a connection to setter only. More...
 
template<typename ModelField , typename SetterLambda >
auto operator() (ModelField(Model::*field), SetterLambda setterLambda)
 Create a connection to specified lambda setter only. More...
 
template<typename View , typename ModelField , typename GetterRV , aui::invocable< View *, const ModelField & > Setter>
auto operator() (ModelField(Model::*field), ASignal< GetterRV >(View::*getter), Setter setter=(void(View::*)(const ModelField &)) nullptr)
 Create a connection to specified pointer-to-member-field signal and pointer-to-member-function setter. More...
 
template<typename Data >
auto operator() (Data(Model::*field))
 Create a connection via ADataBindingDefault. More...
 
template<typename Data , aui::invocable< Data > Projection>
ADataBindingLinker2< Model, Data, Projection > operator() (Data(Model::*field), Projection projection)
 Create a connection via ADataBindingDefault and projection (setter only). More...
 
const Model & getModel () const noexcept
 
Model const * operator-> () const noexcept
 
Model & getEditableModel ()
 
void setModel (const Model &model)
 
void setModel (Model *model)
 
const void * getExclusion () const
 
void notifyUpdate (void *except=nullptr, unsigned field=-1)
 
template<typename ModelField >
void notifyUpdate (ModelField(Model::*field))
 
template<typename ModelField , aui::convertible_to< ModelField > U>
void setValue (ModelField(Model::*field), U &&value)
 
void addObserver (Observer applier)
 
template<aui::invocable T>
void addObserver (T &&applier)
 
template<typename ModelField , typename FieldObserver >
void addObserverNoInitialCall (ModelField(Model::*field), FieldObserver &&observer)
 
template<typename ModelField , typename FieldObserver >
void addObserver (ModelField(Model::*field), FieldObserver &&observer)
 
- Public Member Functions inherited from AObject
_< AObjectsharedPtr ()
 
_weak< AObjectweakPtr ()
 
void clearSignals () noexcept
 
template<AAnySignal Signal, ACompatibleSlotFor< Signal > Function>
void connect (Signal &signal, Function &&function)
 
void setSignalsEnabled (bool enabled)
 
bool isSignalsEnabled () const noexcept
 
template<ASignalInvokable T>
void operator^ (T &&t)
 
_< AAbstractThreadgetThread () const
 
bool isSlotsCallsOnlyOnMyThread () const noexcept
 
void setSlotsCallsOnlyOnMyThread (bool slotsCallsOnlyOnMyThread)
 
- Public Member Functions inherited from aui::noncopyable
 noncopyable (const noncopyable &)=delete
 
noncopyableoperator= (const noncopyable &)=delete
 

Signals and public fields

emits modelChanged
 Data in the model has changed.
 

Additional Inherited Members

- Static Public Member Functions inherited from AObject
static void disconnect ()
 
template<AAnySignal Signal, aui::derived_from< AObject > Object, ACompatibleSlotFor< Signal > Function>
static void connect (Signal &signal, Object *object, Function &&function)
 
template<AAnySignal Signal, aui::derived_from< AObject > Object, ACompatibleSlotFor< Signal > Function>
static void connect (Signal &signal, Object &object, Function &&function)
 
template<AAnySignal Signal, aui::derived_from< AObject > Object, ACompatibleSlotFor< Signal > Function>
static void connect (Signal &signal, _< Object > object, Function &&function)
 
static void moveToThread (aui::no_escape< AObject > object, _< AAbstractThread > thread)
 
- Protected Member Functions inherited from AObject
void setThread (_< AAbstractThread > thread)
 Set thread of the object.
 

Member Function Documentation

◆ operator()() [1/5]

template<typename Model >
template<typename Data >
auto ADataBinding< Model >::operator() ( DataModel::*  field)
inline

Create a connection via ADataBindingDefault.

Parameters
fieldpointer-to-member-field of model.

ADataBindingDefault must be defined for model type and your view.

◆ operator()() [2/5]

template<typename Model >
template<typename Data , aui::invocable< Data > Projection>
ADataBindingLinker2< Model, Data, Projection > ADataBinding< Model >::operator() ( DataModel::*  field,
Projection  projection 
)
inline

Create a connection via ADataBindingDefault and projection (setter only).

ADataBindingDefault must be defined for model type and your view.

◆ operator()() [3/5]

template<typename Model >
template<typename View , typename ModelField , typename GetterRV , aui::invocable< View *, const ModelField & > Setter>
auto ADataBinding< Model >::operator() ( ModelFieldModel::*  field,
ASignal< GetterRV >View::*  getter,
Setter  setter = (void(View::*)(const ModelField&))nullptr 
)
inline

Create a connection to specified pointer-to-member-field signal and pointer-to-member-function setter.

Parameters
fieldpointer-to-member-field of model.

◆ operator()() [4/5]

template<typename Model >
template<typename ModelField , typename SetterLambda >
auto ADataBinding< Model >::operator() ( ModelFieldModel::*  field,
SetterLambda  setterLambda 
)
inline

Create a connection to specified lambda setter only.

Parameters
fieldpointer-to-member-field of model.
setterLambdalambda which accepts reference to your view type and const reference to data (see examples).

View type is deduces from the first argument of your lambda.

struct Model {
};
auto model = _new<ADataBinding<Model>>(Model{});
_new<ALabel>() && model(&Model::text, [](ALabel& view, const AString& data) {
view.setText(data);
});
Represents a simple single-line text display view.
Definition: ALabel.h:23
Represents a Unicode character string.
Definition: AString.h:37
Definition: Text.h:21

◆ operator()() [5/5]

template<typename Model >
template<typename View , typename ModelField , typename SetterArg >
auto ADataBinding< Model >::operator() ( ModelFieldModel::*  field,
void(View::*)(SetterArg)  setterFunc 
)
inline

Create a connection to setter only.

Parameters
fieldpointer-to-member-field of model.
setterFuncpointer-to-member-function setter.

#include <AUI/Util/ADataBinding.h>


The documentation for this class was generated from the following file:
Inheritance diagram for ADataBinding< Model >:
Collaboration diagram for ADataBinding< Model >: