Encapsulates management of activities through a controller property. More...

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

Public Member Functions
	ActivityHostControllerPropertyManager (ValueControlledExclusiveActivityHostConcept &activityHost)
	Constructor.

PropertyDataType	getDataType () const
	Returns the data type of a controller source.

string	getValueProviderPath () const
	Returns the path to the ControllerPropertySource.

bool	hasValidControllerInput () const
	Returns whether an Activity Host node is controlled by a valid controller input.

void	synchronizeActivation ()
	Synchronizes the state of activities with the controller property value.

void	trySynchronizeControllerValue (string_view activityName)
	Forces the ControllerPropertySource to set the ControllerProperty value to be the same as that provided by an Activity node.

void	updateAfterControllingPropertyChanged ()
	Configures this object to trigger the activation of an Activity node according to the value of the property selected as the ControllerProperty and value of that property in the child Activity nodes.

void	updateAfterSourceChange ()
	Configures this object to trigger the activation of an Activity node according to the value from a data source and values provided in the child Activity nodes.

virtual	~ActivityHostControllerPropertyManager ()
	Destructor.

Detailed Description

Encapsulates management of activities through a controller property.

This is a helper class for exclusive activity host classes.

Constructor & Destructor Documentation

◆ ActivityHostControllerPropertyManager()

kanzi::ActivityHostControllerPropertyManager::ActivityHostControllerPropertyManager ( ValueControlledExclusiveActivityHostConcept & activityHost )

explicit

Constructor.

Parameters

activityHost The Activity Host node that this controller property manager handles.

◆ ~ActivityHostControllerPropertyManager()

virtual kanzi::ActivityHostControllerPropertyManager::~ActivityHostControllerPropertyManager ( )

virtual

Destructor.

Member Function Documentation

◆ updateAfterSourceChange()

void kanzi::ActivityHostControllerPropertyManager::updateAfterSourceChange ( )

Configures this object to trigger the activation of an Activity node according to the value from a data source and values provided in the child Activity nodes.

◆ updateAfterControllingPropertyChanged()

void kanzi::ActivityHostControllerPropertyManager::updateAfterControllingPropertyChanged ( )

Configures this object to trigger the activation of an Activity node according to the value of the property selected as the ControllerProperty and value of that property in the child Activity nodes.

◆ getValueProviderPath()

string kanzi::ActivityHostControllerPropertyManager::getValueProviderPath ( ) const

Returns the path to the ControllerPropertySource.

Returns: The path to the ControllerPropertySource.

◆ trySynchronizeControllerValue()

void kanzi::ActivityHostControllerPropertyManager::trySynchronizeControllerValue ( string_view activityName )

Forces the ControllerPropertySource to set the ControllerProperty value to be the same as that provided by an Activity node.

Parameters

activityName The name of the Activity node that provides the new value for the ControllerProperty.

◆ synchronizeActivation()

void kanzi::ActivityHostControllerPropertyManager::synchronizeActivation ( )

Synchronizes the state of activities with the controller property value.

◆ getDataType()

PropertyDataType kanzi::ActivityHostControllerPropertyManager::getDataType ( ) const

Returns the data type of a controller source.

Returns: Data type of a controller source.

Since: Kanzi 3.9.0

◆ hasValidControllerInput()

bool kanzi::ActivityHostControllerPropertyManager::hasValidControllerInput ( ) const

Returns whether an Activity Host node is controlled by a valid controller input.

Returns: If the Activity Host is controlled by a valid property on the node, its ancestor, or a valid data source input, true, otherwise false.

Since: Kanzi 3.9.0

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

kanzi/ui/node/concept/activity/activity_host_controller_property_manager.hpp

Public Member Functions