DataContext acts as a container for data. More...

#include <kanzi/core.ui/data/data_context.hpp>

Inheritance diagram for kanzi::DataContext:

Classes
struct	ModifiedSubscription
	Subscription entry. More...

Public Types
typedef function< void()>	ModifiedFunction
	Callback function type for change subscriptions.

typedef shared_ptr< void >	ModifiedSubscriptionToken
	Token type that can be used to identify the change subscription.

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

Public Member Functions
ModifiedSubscriptionToken	addModifiedNotificationHandler (ModifiedFunction callback)
	Allows to subscribe to modifications in this data context.

virtual DataObjectSharedPtr	getData ()=0
	Retrieves the root object of the underlying data tree.

virtual DataContextSharedPtr	lookupDataContext (string_view relativePath)=0
	Performs object look-up by path.

template<typename Type >
shared_ptr< Type >	lookupDataContextOfType (string_view relativePath)

void	notifyModified ()
	Triggers modification procedure in this data context, which invokes the subscriptions.

void	removeModifiedNotificationHandler (ModifiedSubscriptionToken token)
	Allows to unsubscribe from modifications in this data context.

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource.

const string &	getName () const
	Gets the resource name.

const string &	getUrl () const
	Gets the resource URL.

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set.

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag.

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

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

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

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

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

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

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

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

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

	Object (Domain *domain)

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

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~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.

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	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

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, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

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

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

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

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

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

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

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.

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.

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

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

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

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

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

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

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

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

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

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

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.

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.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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

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

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

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

Protected Types
typedef vector< ModifiedSubscriptionSharedPtr >	ModifiedSubscriptionContainer
	Container for subscriptions.

typedef shared_ptr< ModifiedSubscription >	ModifiedSubscriptionSharedPtr
	Subscription shared pointer type.

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

Protected Member Functions
	DataContext (Domain *domain, string_view name)
	Protected standard constructor.

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor.

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.

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

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

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

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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.

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

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

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

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

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.

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

void	onCopy (const PropertyObject &other)

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

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

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Attributes
unsigned int	m_notificationPassGuard
	Notification pass guard integer for triggering removal at end.

ModifiedSubscriptionContainer	m_subscriptions
	Subscriptions to data context being modified.

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

Properties
static PropertyType< ResourceSharedPtr >	DataContextProperty
	DataContext property.

static PropertyType< ResourceSharedPtr >	ItemsSourceProperty
	ItemsSource property.

static ResourceSharedPtr	getDataContext (const Node &node)
	Gets the value of DataContextProperty.

static void	setDataContext (Node &node, ResourceSharedPtr value)
	Sets the value of DataContextProperty.

static ResourceSharedPtr	getItemsSource (const Node &node)
	Gets the value of ItemsSourceProperty.

static void	setItemsSource (Node &node, ResourceSharedPtr value)
	Sets the value of ItemsSourceProperty.

Detailed Description

DataContext acts as a container for data.

All data within the data context is described as a tree of data objects. The class provides access and look-up functionality of the contained data objects.

Member Typedef Documentation

◆ ModifiedFunction

typedef function<void()> kanzi::DataContext::ModifiedFunction

Callback function type for change subscriptions.

◆ ModifiedSubscriptionToken

typedef shared_ptr<void> kanzi::DataContext::ModifiedSubscriptionToken

Token type that can be used to identify the change subscription.

◆ ModifiedSubscriptionSharedPtr

typedef shared_ptr<ModifiedSubscription> kanzi::DataContext::ModifiedSubscriptionSharedPtr

protected

Subscription shared pointer type.

◆ ModifiedSubscriptionContainer

typedef vector<ModifiedSubscriptionSharedPtr> kanzi::DataContext::ModifiedSubscriptionContainer

protected

Container for subscriptions.

Constructor & Destructor Documentation

◆ DataContext()

kanzi::DataContext::DataContext	(	Domain *	domain,
		string_view	name )

explicitprotected

Protected standard constructor.

Parameters

domain	The UI domain.
name	Name of the data context.

Member Function Documentation

◆ getDataContext()

static ResourceSharedPtr kanzi::DataContext::getDataContext ( const Node & node )

inlinestatic

Gets the value of DataContextProperty.

See also: setDataContext()

◆ setDataContext()

static void kanzi::DataContext::setDataContext	(	Node &	node,
		ResourceSharedPtr	value )

inlinestatic

Sets the value of DataContextProperty.

See also: getDataContext()

◆ getItemsSource()

static ResourceSharedPtr kanzi::DataContext::getItemsSource ( const Node & node )

inlinestatic

Gets the value of ItemsSourceProperty.

See also: setItemsSource()

◆ setItemsSource()

static void kanzi::DataContext::setItemsSource	(	Node &	node,
		ResourceSharedPtr	value )

inlinestatic

Sets the value of ItemsSourceProperty.

See also: getItemsSource()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::DataContext::makeEditorInfo ( )

static

◆ addModifiedNotificationHandler()

ModifiedSubscriptionToken kanzi::DataContext::addModifiedNotificationHandler ( ModifiedFunction callback )

Allows to subscribe to modifications in this data context.

Parameters

callback Callback that is invoked when a change occurs in this data context.

Returns: Token that can be used to identify and remove given subscription.

◆ removeModifiedNotificationHandler()

void kanzi::DataContext::removeModifiedNotificationHandler ( ModifiedSubscriptionToken token )

Allows to unsubscribe from modifications in this data context.

Parameters

token Token to identify the subscription that should be removed.

◆ notifyModified()

void kanzi::DataContext::notifyModified ( )

Triggers modification procedure in this data context, which invokes the subscriptions.

Should be called by derived classes whenever the value of the object is changed.

◆ getData()

virtual DataObjectSharedPtr kanzi::DataContext::getData ( )

pure virtual

Retrieves the root object of the underlying data tree.

Needs to be implemented by the derived class.

Returns: Returns data object that is the root of the data tree.

Implemented in kanzi::DataObject, and kanzi::DataSource.

◆ lookupDataContextOfType()

template<typename Type >

shared_ptr< Type > kanzi::DataContext::lookupDataContextOfType ( string_view relativePath )

inline

◆ lookupDataContext()

virtual DataContextSharedPtr kanzi::DataContext::lookupDataContext ( string_view relativePath )

pure virtual

Performs object look-up by path.

Parameters

relativePath Path of the object where to look at, separated by '.'.

Returns: Data object that was found, or empty pointer if there was no such object.

Implemented in kanzi::DataObject, and kanzi::DataSource.

Member Data Documentation

◆ DataContextProperty

PropertyType<ResourceSharedPtr> kanzi::DataContext::DataContextProperty

static

DataContext property.

The default value is ResourceSharedPtr().

See also: setDataContext(), getDataContext()

◆ ItemsSourceProperty

PropertyType<ResourceSharedPtr> kanzi::DataContext::ItemsSourceProperty

static

ItemsSource property.

The default value is ResourceSharedPtr().

See also: setItemsSource(), getItemsSource()

◆ m_subscriptions

ModifiedSubscriptionContainer kanzi::DataContext::m_subscriptions

protected

Subscriptions to data context being modified.

◆ m_notificationPassGuard

unsigned int kanzi::DataContext::m_notificationPassGuard

protected

Notification pass guard integer for triggering removal at end.

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

kanzi/core.ui/data/data_context.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Typedef Documentation

◆ ModifiedFunction

◆ ModifiedSubscriptionToken

◆ ModifiedSubscriptionSharedPtr

◆ ModifiedSubscriptionContainer

Constructor & Destructor Documentation

◆ DataContext()

Member Function Documentation

◆ getDataContext()

◆ setDataContext()

◆ getItemsSource()

◆ setItemsSource()

◆ makeEditorInfo()

◆ addModifiedNotificationHandler()

◆ removeModifiedNotificationHandler()

◆ notifyModified()

◆ getData()

◆ lookupDataContextOfType()

◆ lookupDataContext()

Member Data Documentation

◆ DataContextProperty

◆ ItemsSourceProperty

◆ m_subscriptions

◆ m_notificationPassGuard