Kanzi 3.9.10
kanzi::ValueControlledExclusiveActivityHostConcept Class Referenceabstract

Base class for the Exclusive Activity Host classes. More...

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

Inheritance diagram for kanzi::ValueControlledExclusiveActivityHostConcept:
[legend]

Public Member Functions

virtual void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry)=0
 Helper function to add an already-created binding runtime.
 
virtual const vector< ExclusiveActivityHostConcept::ActivityInExclusiveHostInfo > & getActivitiesInfo () const =0
 ExclusiveActivityHostConcept::getActivitiesInfo implementation.
 
virtual PropertyDataType getControllerInputType () const =0
 Returns the data type of the ControllerProperty of the Exclusive Activity Host.
 
virtual string getInputProviderPath () const =0
 Returns the path to the object that provides the controller value source.
 
virtual const NodegetNode () const =0
 Returns the underlying Node of this ValueControlledExclusiveActivityHostConcept instance.
 
virtual NodegetNode ()=0
 Returns the underlying Node of this ValueControlledExclusiveActivityHostConcept instance.
 
virtual ~ValueControlledExclusiveActivityHostConcept ()=default
 Destructor.
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the editor information to Kanzi Studio.
 

Static Public Attributes

Properties
static PropertyType< string > ControllerProperty
 Sets the property type that the Exclusive Activity host uses to switch between its child Activities.
 
static PropertyType< string > DataSourceControllerPropertyPathProperty
 Sets the path in the DataSource object of an Exclusive Activity Host to a DataObject item that Exclusive Activity Host uses as the ControllerProperty.
 

Detailed Description

Base class for the Exclusive Activity Host classes.

This class defines the types and properties for the Exclusive Activity Host classes for which the activation of the child Activities is controlled by a property or a DataObject value.

See also
ExclusiveActivityHost2D, ExclusiveActivityHost3D.
Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ ~ValueControlledExclusiveActivityHostConcept()

virtual kanzi::ValueControlledExclusiveActivityHostConcept::~ValueControlledExclusiveActivityHostConcept ( )
virtualdefault

Destructor.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ValueControlledExclusiveActivityHostConcept::makeEditorInfo ( )
static

Provides the editor information to Kanzi Studio.

◆ getNode() [1/2]

◆ getNode() [2/2]

◆ getInputProviderPath()

virtual string kanzi::ValueControlledExclusiveActivityHostConcept::getInputProviderPath ( ) const
pure virtual

Returns the path to the object that provides the controller value source.

If the controller value is set through the ControllerProperty, this method returns the path to the Node on which the ControllerProperty is set. If the controller value is set through the DataSourceControllerPropertyPathProperty, this method returns the path the DataSource.

Returns
The path to the object that provides the controller value source.

Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.

◆ getActivitiesInfo()

virtual const vector< ExclusiveActivityHostConcept::ActivityInExclusiveHostInfo > & kanzi::ValueControlledExclusiveActivityHostConcept::getActivitiesInfo ( ) const
pure virtual

◆ getControllerInputType()

virtual PropertyDataType kanzi::ValueControlledExclusiveActivityHostConcept::getControllerInputType ( ) const
pure virtual

Returns the data type of the ControllerProperty of the Exclusive Activity Host.

Returns
The data type of the ControllerProperty of the Exclusive Activity Host.

Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.

◆ addBindingRuntime()

virtual void kanzi::ValueControlledExclusiveActivityHostConcept::addBindingRuntime ( AbstractBindingRuntimeSharedPtr entry)
pure virtual

Helper function to add an already-created binding runtime.

The implementation must call the protected function: BindingHostConcept::addBindingRuntime(AbstractBindingRuntimeSharedPtr entry, shared_ptr<void> owner).

Parameters
entryBinding runtime to add.

Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.

Member Data Documentation

◆ ControllerProperty

PropertyType<string> kanzi::ValueControlledExclusiveActivityHostConcept::ControllerProperty
static

Sets the property type that the Exclusive Activity host uses to switch between its child Activities.

By default the value of this property is empty, that is, the Exclusive Activity Host does not have a ControllerProperty.

◆ DataSourceControllerPropertyPathProperty

PropertyType<string> kanzi::ValueControlledExclusiveActivityHostConcept::DataSourceControllerPropertyPathProperty
static

Sets the path in the DataSource object of an Exclusive Activity Host to a DataObject item that Exclusive Activity Host uses as the ControllerProperty.

By default the value of this property is empty, that is, the Exclusive Activity Host does not have a DataObject that it uses for its ControllerProperty.


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