Base class for the Exclusive Activity Host classes. More...
#include <kanzi/ui/node/concept/activity/value_controlled_exclusive_activity_host_concept.hpp>
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 Node * | getNode () const =0 |
| Returns the underlying Node of this ValueControlledExclusiveActivityHostConcept instance. | |
| virtual Node * | getNode ()=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. | |
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.
|
virtualdefault |
Destructor.
|
static |
Provides the editor information to Kanzi Studio.
Returns the underlying Node of this ValueControlledExclusiveActivityHostConcept instance.
Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.
|
pure virtual |
Returns the underlying Node of this ValueControlledExclusiveActivityHostConcept instance.
Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.
|
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.
Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.
|
pure virtual |
ExclusiveActivityHostConcept::getActivitiesInfo implementation.
Provides access to the list of all registered Activities.
Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.
|
pure virtual |
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 >.
|
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).
| entry | Binding runtime to add. |
Implemented in kanzi::ExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostImpl< ContentLayout3D, ExclusiveActivityHost3D >.
|
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.
|
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.