Kanzi  3.9.4
Kanzi Engine API
kanzi::BindingLoadInfo Struct Reference

Use the BindingLoadInfo to create the information for a binding that you need when adding the binding to an object. More...

#include <kanzi/core.ui/binding/binding_load_info.hpp>

Public Member Functions

 BindingLoadInfo ()=default
 Empty constructor. More...
 
 BindingLoadInfo (AbstractBindingSharedPtr bindingParam, AbstractPropertyType targetProperty, PropertyField targetField, optional< PropertyValuePrecedence > precedenceParam, PropertyDataType dataTypeParam, string_view targetValueParam)
 Constructor for all variants. More...
 
 BindingLoadInfo (AbstractBindingSharedPtr bindingParam, AbstractPropertyType targetProperty, PropertyField targetField, PropertyValuePrecedence precedenceParam)
 Constructor for value source binding. More...
 
 BindingLoadInfo (AbstractBindingSharedPtr bindingParam, AbstractPropertyType targetProperty, PropertyValuePrecedence precedenceParam)
 Constructor for value source binding. More...
 
 BindingLoadInfo (AbstractBindingSharedPtr bindingParam, AbstractPropertyType targetProperty, PropertyField targetField)
 Constructor for modifier binding. More...
 
 BindingLoadInfo (AbstractBindingSharedPtr bindingParam, AbstractPropertyType targetProperty)
 Constructor for modifier binding. More...
 
 BindingLoadInfo (AbstractBindingSharedPtr bindingParam, PropertyDataType dataTypeParam, string_view targetValueParam)
 Constructor for render value. More...
 
 BindingLoadInfo (AbstractBindingSharedPtr bindingParam)
 Constructor for dummy binding. More...
 

Public Attributes

AbstractBindingSharedPtr binding
 Binding information. More...
 
PropertyField field
 Target property field;. More...
 
optional< PropertyValuePrecedenceprecedence
 Property value precedence (may be empty). More...
 
AbstractPropertyType propertyType
 Target property type. More...
 
PropertyDataType targetDataType
 Target data type. More...
 
string targetRenderValue
 Target render value. More...
 

Detailed Description

Use the BindingLoadInfo to create the information for a binding that you need when adding the binding to an object.

The information includes the binding and the source with target information.

To create the information for a modifier binding, do not specify property value precedence.

Since
Kanzi 3.7.0

Constructor & Destructor Documentation

◆ BindingLoadInfo() [1/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( )
explicitdefault

Empty constructor.

◆ BindingLoadInfo() [2/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( AbstractBindingSharedPtr  bindingParam,
AbstractPropertyType  targetProperty,
PropertyField  targetField,
optional< PropertyValuePrecedence precedenceParam,
PropertyDataType  dataTypeParam,
string_view  targetValueParam 
)
inlineexplicit

Constructor for all variants.

Parameters
bindingParamBinding with source info.
targetPropertyTarget property type.
targetFieldTarget property field.
precedenceParam(Optional) Property value precedence to use. To create the load information for a modifier binding, do not set this parameter.
dataTypeParamData type for the render value.
targetValueParamRender value name.

◆ BindingLoadInfo() [3/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( AbstractBindingSharedPtr  bindingParam,
AbstractPropertyType  targetProperty,
PropertyField  targetField,
PropertyValuePrecedence  precedenceParam 
)
inlineexplicit

Constructor for value source binding.

Parameters
bindingParamBinding with source info.
targetPropertyTarget property type.
targetFieldTarget property field.
precedenceParamProperty value precedence to use.

◆ BindingLoadInfo() [4/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( AbstractBindingSharedPtr  bindingParam,
AbstractPropertyType  targetProperty,
PropertyValuePrecedence  precedenceParam 
)
inlineexplicit

Constructor for value source binding.

Parameters
bindingParamBinding with source info.
targetPropertyTarget property type.
precedenceParamProperty value precedence to use.

◆ BindingLoadInfo() [5/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( AbstractBindingSharedPtr  bindingParam,
AbstractPropertyType  targetProperty,
PropertyField  targetField 
)
inlineexplicit

Constructor for modifier binding.

Parameters
bindingParamBinding with source info.
targetPropertyTarget property type.
targetFieldTarget property field.

◆ BindingLoadInfo() [6/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( AbstractBindingSharedPtr  bindingParam,
AbstractPropertyType  targetProperty 
)
inlineexplicit

Constructor for modifier binding.

Parameters
bindingParamBinding with source info.
targetPropertyTarget property type.

◆ BindingLoadInfo() [7/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( AbstractBindingSharedPtr  bindingParam,
PropertyDataType  dataTypeParam,
string_view  targetValueParam 
)
inlineexplicit

Constructor for render value.

Parameters
bindingParamBinding with source info.
dataTypeParamData type for the render value.
targetValueParamRender value name.

◆ BindingLoadInfo() [8/8]

kanzi::BindingLoadInfo::BindingLoadInfo ( AbstractBindingSharedPtr  bindingParam)
inlineexplicit

Constructor for dummy binding.

Parameters
bindingParamBinding with source info.

Member Data Documentation

◆ binding

AbstractBindingSharedPtr kanzi::BindingLoadInfo::binding

Binding information.

◆ propertyType

AbstractPropertyType kanzi::BindingLoadInfo::propertyType

Target property type.

◆ field

PropertyField kanzi::BindingLoadInfo::field

Target property field;.

◆ precedence

optional<PropertyValuePrecedence> kanzi::BindingLoadInfo::precedence

Property value precedence (may be empty).

◆ targetDataType

PropertyDataType kanzi::BindingLoadInfo::targetDataType

Target data type.

◆ targetRenderValue

string kanzi::BindingLoadInfo::targetRenderValue

Target render value.


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