Covers the management of the StatusProperty in the State Manager that the prefab of an Activity node uses for transition animations. More...

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

Public Member Functions
	ActivityStatusManager (ActivityElement &activityElement)
	Constructor.

void	reportDeactivation ()
	Sets the Status to Inactive and reports that status.

	~ActivityStatusManager ()
	Destructor.

Static Public Member Functions
static bool	hasStateForStatus (StateManager::StateGroup &stateGroup, ActivityConcept::Status status)
	Returns whether a State Group in a State Manager contains a specific state for transition animation.

Detailed Description

Covers the management of the StatusProperty in the State Manager that the prefab of an Activity node uses for transition animations.

This is a helper class for Activity classes.

Constructor & Destructor Documentation

◆ ActivityStatusManager()

kanzi::ActivityStatusManager::ActivityStatusManager ( ActivityElement & activityElement )

explicit

Constructor.

Parameters

activityElement The activity this status manager handles.

◆ ~ActivityStatusManager()

kanzi::ActivityStatusManager::~ActivityStatusManager ( )

Destructor.

Member Function Documentation

◆ hasStateForStatus()

static bool kanzi::ActivityStatusManager::hasStateForStatus	(	StateManager::StateGroup &	stateGroup,
		ActivityConcept::Status	status )

static

Returns whether a State Group in a State Manager contains a specific state for transition animation.

Parameters

stateGroup	State Group for which you want to check whether it contains a specific state.
status	Value for which to check whether a state exists.

Returns: If a state controlled by the given status exists, true, otherwise false.

◆ reportDeactivation()

void kanzi::ActivityStatusManager::reportDeactivation ( )

Sets the Status to Inactive and reports that status.

Use this when the Activity Host removes the Activity node itself, instead of requesting the deactivation with ActivityConcept::StartParallelDeactivatingAnimationInternalMessage. When the status write starts no transition, this function reports the status to the application only, and does not tell the parent Activity Host that a deactivating animation finished, because an Activity Host that removes the Activity node itself waits for no such message. When the status write starts a transition in the State Group controlled with the StatusProperty, that transition reports the status when it finishes, and that report reaches the Activity Host as well.

Since: Kanzi 3.9.16

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

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

Public Member Functions