Kanzi  3.9.7
Kanzi Engine API
kanzi::ControllerPropertySource Class Referenceabstract

Abstract class whose implementation encapsulates management of controller property source for an activity host controller property. More...

#include <kanzi/ui/node/concept/activity/controller_property_source.hpp>

Inheritance diagram for kanzi::ControllerPropertySource:
[legend]

Public Member Functions

virtual BindingSourcePtr createBindingSource ()=0
 Creates a binding source from the ControllerProperty. More...
 
virtual Variant getValue () const =0
 Gets the value of the ControllerProperty. More...
 
virtual string getValueProviderPath () const =0
 Returns the path to the object that provides the value of the ControllerProperty type. More...
 
virtual bool isValid () const =0
 Returns whether the ControllerProperty source is valid. More...
 
virtual ~ControllerPropertySource ()=default
 Destructor. More...
 

Detailed Description

Abstract class whose implementation encapsulates management of controller property source for an activity host controller property.

This is a helper class for Activity Host Controller Property Manager.

Constructor & Destructor Documentation

virtual kanzi::ControllerPropertySource::~ControllerPropertySource ( )
virtualdefault

Destructor.

Member Function Documentation

virtual bool kanzi::ControllerPropertySource::isValid ( ) const
pure virtual

Returns whether the ControllerProperty source is valid.

Returns
If ControllerProperty source is valid, true, otherwise false.

Implemented in kanzi::DataSourceControllerPropertySource, and kanzi::ObjectControllerPropertySource.

virtual Variant kanzi::ControllerPropertySource::getValue ( ) const
pure virtual

Gets the value of the ControllerProperty.

Returns
The value of the ControllerProperty.

Implemented in kanzi::DataSourceControllerPropertySource, and kanzi::ObjectControllerPropertySource.

virtual BindingSourcePtr kanzi::ControllerPropertySource::createBindingSource ( )
pure virtual

Creates a binding source from the ControllerProperty.

Returns
A binding source from the ControllerProperty.

Implemented in kanzi::DataSourceControllerPropertySource, and kanzi::ObjectControllerPropertySource.

virtual string kanzi::ControllerPropertySource::getValueProviderPath ( ) const
pure virtual

Returns the path to the object that provides the value of the ControllerProperty type.

Returns
The path to the object that provides the value of the ControllerProperty type.

Implemented in kanzi::DataSourceControllerPropertySource, and kanzi::ObjectControllerPropertySource.


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