Base class for the Data-Driven Exclusive Activity Host classes. More...
#include <kanzi/ui/node/concept/activity/data_driven_exclusive_activity_host_concept.hpp>
Public Member Functions | |
int | getActiveActivityIndex () const |
Gets the value of the ActiveActivityIndexProperty. More... | |
ResourceSharedPtr | getActivitySource () const |
Gets the value of the ActivitySourceProperty. More... | |
string | getActivityTemplate () const |
Gets the value of the ActivityTemplateProperty. More... | |
virtual Node * | getNode ()=0 |
Returns the underlying Node of this DataDrivenExclusiveActivityHostConcept instance. More... | |
virtual const Node * | getNode () const =0 |
Returns the underlying Node of this DataDrivenExclusiveActivityHostConcept instance. More... | |
void | setActiveActivityIndex (int value) |
Sets the value of the ActiveActivityIndexProperty. More... | |
void | setActivitySource (ResourceSharedPtr value) |
Sets the value of the ActivitySourceProperty. More... | |
void | setActivityTemplate (string_view prefabUrl) |
Sets the value of the ActivityTemplateProperty. More... | |
virtual | ~DataDrivenExclusiveActivityHostConcept ()=default |
Destructor. More... | |
Static Public Member Functions | |
static string | getNameForIndex (int index) |
Returns a unique name for the data Activity at the given index in the Data Source List. More... | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Returns PropertyType editor info of DataDrivenExclusiveActivityHostConcept. More... | |
Static Public Attributes | |
static constexpr const char * | s_activeDataActivityName |
Public name which Kanzi uses to refer to the currently and exclusively active data Activity of a Data-Driven Exclusive Activity Host. More... | |
static constexpr int | s_defaultActiveActivityIndex |
The default value of the DataDrivenExclusiveActivityHostConcept::ActiveActivityIndexProperty. More... | |
Properties | |
static PropertyType< ResourceSharedPtr > | ActivitySourceProperty |
Sets the DataObject that provides the data for the Activities of a Data-Driven Exclusive Activity Host. More... | |
static PropertyType< string > | ActivityTemplateProperty |
Sets the prefab template that a Data-Driven Exclusive Activity Host uses for the Activities that it creates. More... | |
static PropertyType< int > | ActiveActivityIndexProperty |
The index of the active Activity in the Data-Driven Exclusive Activity Host. More... | |
Base class for the Data-Driven Exclusive Activity Host classes.
This class defines the common types, functionality, and properties for the Data-Driven Exclusive Activity Host classes.
|
virtualdefault |
Destructor.
|
static |
Returns PropertyType editor info of DataDrivenExclusiveActivityHostConcept.
|
pure virtual |
Returns the underlying Node of this DataDrivenExclusiveActivityHostConcept instance.
Implemented in kanzi::DataDrivenExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::DataDrivenExclusiveActivityHostImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, and kanzi::DataDrivenExclusiveActivityHostImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >.
|
pure virtual |
Returns the underlying Node of this DataDrivenExclusiveActivityHostConcept instance.
Implemented in kanzi::DataDrivenExclusiveActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::DataDrivenExclusiveActivityHostImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, and kanzi::DataDrivenExclusiveActivityHostImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >.
ResourceSharedPtr kanzi::DataDrivenExclusiveActivityHostConcept::getActivitySource | ( | ) | const |
Gets the value of the ActivitySourceProperty.
void kanzi::DataDrivenExclusiveActivityHostConcept::setActivitySource | ( | ResourceSharedPtr | value | ) |
Sets the value of the ActivitySourceProperty.
value | The DataObject that provides the data for Activities of this Data-Driven Exclusive Activity Host. |
string kanzi::DataDrivenExclusiveActivityHostConcept::getActivityTemplate | ( | ) | const |
Gets the value of the ActivityTemplateProperty.
void kanzi::DataDrivenExclusiveActivityHostConcept::setActivityTemplate | ( | string_view | prefabUrl | ) |
Sets the value of the ActivityTemplateProperty.
prefabUrl | The path of the prefab template that this Data-Driven Exclusive Activity Host uses to create Activities. |
int kanzi::DataDrivenExclusiveActivityHostConcept::getActiveActivityIndex | ( | ) | const |
Gets the value of the ActiveActivityIndexProperty.
void kanzi::DataDrivenExclusiveActivityHostConcept::setActiveActivityIndex | ( | int | value | ) |
Sets the value of the ActiveActivityIndexProperty.
value | The index of the active Activity in this Data-Driven Exclusive Activity Host. |
|
static |
Returns a unique name for the data Activity at the given index in the Data Source List.
index | Index of the data Activity in the Data Source List. |
|
static |
Sets the DataObject that provides the data for the Activities of a Data-Driven Exclusive Activity Host.
The default value is ResourceSharedPtr().
|
static |
Sets the prefab template that a Data-Driven Exclusive Activity Host uses for the Activities that it creates.
The default value is "".
|
static |
The index of the active Activity in the Data-Driven Exclusive Activity Host.
After instantiating all Activities from a Data Source, this property refers to the only currently active Activity in the Data-Driven Exclusive Activity Host. To deactivate all the Activities in an Activity Host, set this property to -1. By default the value of this index is -1 and all Activities are inactive.
|
static |
Public name which Kanzi uses to refer to the currently and exclusively active data Activity of a Data-Driven Exclusive Activity Host.
The Activity with this name internally holds the data of the currently active Activity from the Data Source List.
|
static |
The default value of the DataDrivenExclusiveActivityHostConcept::ActiveActivityIndexProperty.
Set the DataDrivenExclusiveActivityHostConcept::ActiveActivityIndexProperty to this value to deactivate all the Activities in a Data-Driven Exclusive Activity Host.