Range binding processor is a binding processor for accessing properties from property objects in ranges. More...

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

Inheritance diagram for kanzi::RangeBindingProcessor:

Public Member Functions
BindingProcessorRuntimePtr	createRuntimeOverride () override
	InstructionBindingProcessor::createRuntimeOverride() implementation. More...

AbstractPropertyType	getPropertyType () const
	Returns the AbstractPropertyType held by the range processor. More...

Public Member Functions inherited from kanzi::InstructionBindingProcessor
PropertyField	getInputField1 () const

PropertyField	getInputField2 () const

PropertyField	getInputField3 () const

BindingExpressionArgumentType	getInputRegister1Type () const
	Returns The first input register type. More...

BindingExpressionArgumentType	getInputRegister2Type () const

BindingExpressionArgumentType	getInputRegister3Type () const

PropertyField	getOutputField () const

unsigned int	getOutputRegisterIndex () const

void	setInputFields (PropertyField field1, PropertyField field2, PropertyField field3)
	Sets the input fields. More...

void	setInputFields (PropertyField field1, PropertyField field2)
	Sets the first two input fields to property fields field1 and field2, and the third input field to whole property. More...

void	setInputFields (PropertyField field1)
	Sets the first input field to property field field1, and the second and third input fields to whole property. More...

void	setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type, BindingExpressionArgumentType inputRegister2Type, BindingExpressionArgumentType inputRegister3Type)
	Sets the input register types. More...

void	setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type, BindingExpressionArgumentType inputRegister2Type)
	Sets the input register types. More...

void	setInputRegisterTypes (BindingExpressionArgumentType inputRegister1Type)
	Sets the input register types. More...

void	setOutputField (PropertyField outputField)
	Sets the output field. More...

void	setOutputRegisterIndex (unsigned int outputRegisterIndex)
	Sets the output register index. More...

Public Member Functions inherited from kanzi::BindingProcessor
BindingProcessorRuntimePtr	createRuntime ()
	Creates a runtime for the binding processor. More...

virtual	~BindingProcessor ()=default
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static RangeBindingProcessorSharedPtr	create (Domain *domain, BindingExpressionArgumentType inputRegisterType, AbstractPropertyType propertyType, unsigned int outputRegisterIndex)
	Creates a range binding processor. More...

static RangeBindingProcessorSharedPtr	create (Domain *domain)
	Creates an empty range binding processor. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
	RangeBindingProcessor (Domain *domain, BindingExpressionArgumentType inputRegisterType, AbstractPropertyType propertyType, unsigned int outputRegisterIndex)
	Constructor. More...

	RangeBindingProcessor (Domain *domain)
	Constructor. More...

Protected Member Functions inherited from kanzi::InstructionBindingProcessor
	InstructionBindingProcessor (Domain *domain)
	Constructor. More...

Protected Member Functions inherited from kanzi::BindingProcessor
	BindingProcessor (Domain *domain)
	Constructor. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Attributes
AbstractPropertyType	m_propertyType
	Property type derived from the parameters. More...

Protected Attributes inherited from kanzi::InstructionBindingProcessor
PropertyField	m_inputField1
	Input range field. More...

PropertyField	m_inputField2
	Input range field. More...

PropertyField	m_inputField3
	Input range field. More...

BindingExpressionArgumentType	m_inputRegister1Type
	Input register type. More...

BindingExpressionArgumentType	m_inputRegister2Type
	Input register type. More...

BindingExpressionArgumentType	m_inputRegister3Type
	Input register type. More...

PropertyField	m_outputField
	Input range field. More...

unsigned int	m_outputRegisterIndex
	Output register index. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Additional Inherited Members
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Static Protected Member Functions inherited from kanzi::BindingProcessor
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Detailed Description

Range binding processor is a binding processor for accessing properties from property objects in ranges.

Use RangeBindingProcessor to transform a range containing property objects into a range containing values. A RangeBindingProcessor reads a range and extracts given property from each property object in a range. The values are stored into a value range stored into the output register.

Since: Kanzi 3.9.0

Constructor & Destructor Documentation

◆ RangeBindingProcessor() [1/2]

kanzi::RangeBindingProcessor::RangeBindingProcessor	(	Domain *	domain,
		BindingExpressionArgumentType	inputRegisterType,
		AbstractPropertyType	propertyType,
		unsigned int	outputRegisterIndex
	)

explicitprotected

Constructor.

Parameters

domain	Domain to use.
inputRegisterType	Input register to read
propertyType	Property to access.
outputRegisterIndex	Output register index.

◆ RangeBindingProcessor() [2/2]

kanzi::RangeBindingProcessor::RangeBindingProcessor ( Domain * domain )

explicitprotected

Constructor.

This function is intended for use with clone().

Parameters

domain Domain to use.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::RangeBindingProcessor::makeEditorInfo ( )

static

◆ create() [1/2]

static RangeBindingProcessorSharedPtr kanzi::RangeBindingProcessor::create	(	Domain *	domain,
		BindingExpressionArgumentType	inputRegisterType,
		AbstractPropertyType	propertyType,
		unsigned int	outputRegisterIndex
	)

static

Creates a range binding processor.

Parameters

domain	Domain to use.
inputRegisterType	Input register to read
propertyType	Property to access.
outputRegisterIndex	Output register index.

Returns: Range binding processor.

◆ create() [2/2]

static RangeBindingProcessorSharedPtr kanzi::RangeBindingProcessor::create ( Domain * domain )

static

Creates an empty range binding processor.

This function is intended for use with clone().

Parameters

domain Domain to use.

Returns: Range binding processor.

◆ createRuntimeOverride()

BindingProcessorRuntimePtr kanzi::RangeBindingProcessor::createRuntimeOverride ( )

overridevirtual

InstructionBindingProcessor::createRuntimeOverride() implementation.

Reimplemented from kanzi::InstructionBindingProcessor.

◆ getPropertyType()

AbstractPropertyType kanzi::RangeBindingProcessor::getPropertyType ( ) const

inline

Returns the AbstractPropertyType held by the range processor.

Returns: The AbstractPropertyType held by the range processor.

Member Data Documentation

◆ m_propertyType

AbstractPropertyType kanzi::RangeBindingProcessor::m_propertyType

protected

Property type derived from the parameters.

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

kanzi/core.ui/binding/range_binding_processor.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RangeBindingProcessor() [1/2]

◆ RangeBindingProcessor() [2/2]

Member Function Documentation

◆ makeEditorInfo()

◆ create() [1/2]

◆ create() [2/2]

◆ createRuntimeOverride()

◆ getPropertyType()

Member Data Documentation

◆ m_propertyType