Base class for Activity Host classes. More...

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

Inheritance diagram for kanzi::ActivityHostConcept:

Classes
struct	ActivatingActivity
	Class to manage storing and switching of Activity nodes. More...

class	ActivationMessageArguments
	Message arguments for ActivateActivity and DeactivateActivity messages. More...

struct	ActiveActivity
	Class to manage storing and switching of Activity nodes. More...

class	ActivityHostConceptInternalArguments
	Message arguments for RestoreFocusInternalMessage. More...

struct	ActivityInfo
	Stores information that identifies an Activity node. More...

struct	DeactivatingActivity
	Class to manage storing and switching of Activity nodes. More...

class	RegisterActivityElementInternalMessageArguments
	Message arguments for RegisterActivityElementInternal message. More...

class	UnregisterActivityElementInternalMessageArguments
	Message arguments for UnregisterActivityElementInternal message. More...

Public Types
enum	ActivationStatus { ActivationStatus::PreparingForActivation, ActivationStatus::ParallelAnimation, ActivationStatus::ExclusiveAnimation }
	Specifies possible stages for internal tracking of activation of an activity. More...

using	ActivityInfoContainer = vector< ActivityInfo >

enum	DeactivationStatus { DeactivationStatus::ExclusiveAnimation, DeactivationStatus::ParallelAnimation, DeactivationStatus::WaitingForRelease }
	Specifies possible stages for internal tracking of deactivation of an activity. More...

enum	FocusLostFlag { FocusLostFlag::FocusLossObserved, FocusLostFlag::NoFocusLossObserved }
	An Activity Host uses this enum to keep track of whether it has lost focus during Activity switching. More...

Public Member Functions
virtual void	onActivateActivityOverride (string_view activationPath)=0
	Derived classes implement this method to react to ActivateActivity message. More...

virtual void	setActivationModifier (string_view activityName, BindingTokenWeakPtr weakModifier)=0
	Sets a property modifier to apply activation to a child Activity Node of an Activity Host. More...

virtual	~ActivityHostConcept ()=default
	Destructor. More...

Static Public Member Functions
template<typename Type >
static bool	isActivityHost (const Type &object)
	Determines if an object is an ActivityHost. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static MessageType< ActivationMessageArguments >	ActivateActivityMessage
	You can send ActivateActivity to the host to activate an activity. More...

static MessageType< ActivationMessageArguments >	DeactivateActivityMessage
	You can send DeactivateActivity to the host to deactivate an activity. More...

static MessageType< RegisterActivityElementInternalMessageArguments >	RegisterHostInternalMessage
	Internal message sent by an activity host to its parent activity or activity host to register the host in the parent. More...

static MessageType< ActivityHostConceptInternalArguments >	RestoreFocusInternalMessage
	Internal message sent by an Activity Host to its ancestor parent Activity Hosts to trigger the focus resolving. More...

static MessageType< UnregisterActivityElementInternalMessageArguments >	UnregisterHostInternalMessage
	Internal message sent by an activity host to its parent activity or activity host to unregister the host from the parent. More...

Detailed Description

Base class for Activity Host classes.

This class defines common types, properties and messages for Activity Host classes.

See also: ExclusiveActivityHost2D, ExclusiveActivityHost3D, ParallelActivityHost2D, ParallelActivityHost3D.

Member Typedef Documentation

◆ ActivityInfoContainer

using kanzi::ActivityHostConcept::ActivityInfoContainer = vector<ActivityInfo>

Member Enumeration Documentation

◆ ActivationStatus

enum kanzi::ActivityHostConcept::ActivationStatus

strong

Specifies possible stages for internal tracking of activation of an activity.

Enumerator

PreparingForActivation

The activity is preparing for the activation sequence.

For example, resources can be loaded at this stage.

ParallelAnimation

The activity is in animation stage parallel to another activity.

ExclusiveAnimation

The activity is in exclusive animation stage.

◆ DeactivationStatus

enum kanzi::ActivityHostConcept::DeactivationStatus

strong

Specifies possible stages for internal tracking of deactivation of an activity.

Enumerator
ExclusiveAnimation	The activity is in exclusive animation stage.
ParallelAnimation	The activity is in animation stage parallel to another activity.
WaitingForRelease	The activity has finished all possible actions during the deactivation.

◆ FocusLostFlag

enum kanzi::ActivityHostConcept::FocusLostFlag

strong

An Activity Host uses this enum to keep track of whether it has lost focus during Activity switching.

In case an Activity Host has lost focus, the Activity Host uses the value of this enum to try and restore the focus.

For example, when an Activity Host activates an Activity that used to have focus, and if the activated Activity has resources or dynamic content, such as an Activity Host with other Activities, which are loaded asynchronously, Kanzi cannot correctly restore the focus. In such cases, the Activity Host uses this enum to decide whether to restore the focus.

Since: Kanzi 3.9.0

Enumerator
FocusLossObserved	The Activity Host has observed a focus loss during Activity switching.
NoFocusLossObserved	The Activity Host has not observed a focus loss during Activity switching or the focus has been restored.

Constructor & Destructor Documentation

◆ ~ActivityHostConcept()

virtual kanzi::ActivityHostConcept::~ActivityHostConcept ( )

virtualdefault

Destructor.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ActivityHostConcept::makeEditorInfo ( )

static

◆ isActivityHost()

template<typename Type >

static bool kanzi::ActivityHostConcept::isActivityHost ( const Type & object )

inlinestatic

Determines if an object is an ActivityHost.

Parameters

object Object to test.

Returns: Returns true if the object is an ActivityHost, false otherwise.

◆ setActivationModifier()

virtual void kanzi::ActivityHostConcept::setActivationModifier	(	string_view	activityName,
		BindingTokenWeakPtr	weakModifier
	)

pure virtual

Sets a property modifier to apply activation to a child Activity Node of an Activity Host.

The created modifier is a BindingToken for the property that keeps a child Activity node activated for as long as the token is alive. ApplyActivationAction uses this method to apply activation to an Activity Node, upon invocation.

For ParallelActivityHost:

This modifier binding is created for the ParallelActivityHostConcept::ActivationStackProperty.
This property must be set on the child Activity node as the lifetime of an Activity node is completely independent of the sibling Activity nodes.

For ExclusiveActivityHost:

This modifier binding is created for the ExclusiveActivityHostConcept::ActiveActivityProperty.
This property must be set on the ExclusiveActivityHost itself.

Parameters

activityName The name of the Activity node that the ApplyActivationAction activates.

weakModifier A BindingToken owned by the ApplyActivationAction. For ParallelActivityHost, Kanzi waits until the child Activity node prefab is instantiated. Only after the prefab is instantiated can Kanzi set the property modifier binding on the child Activity node. For ExclusiveActivityHost Kanzi does not have to wait for prefab to instantiate because it sets the property modifier directly on the Activity Host and not on its child Activity nodes.

Since: Kanzi 3.9.0

Implemented in kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >, kanzi::ParallelActivityHostImpl< ContentLayout3D, ParallelActivityHost3D >, kanzi::ParallelActivityHostImpl< ContentLayout2D, ParallelActivityHost2D >, kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostBaseImpl< ContentLayout3D, ExclusiveActivityHost3D >.

◆ onActivateActivityOverride()

virtual void kanzi::ActivityHostConcept::onActivateActivityOverride ( string_view activationPath )

pure virtual

Derived classes implement this method to react to ActivateActivity message.

Parameters

activationPath Activation path to activate the child Activities of the Activity Host.

Implemented in kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout3D, DataDrivenExclusiveActivityHost3D >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ExclusiveActivityHostBaseImpl< ContentLayout3D, ExclusiveActivityHost3D >.

Member Data Documentation

◆ ActivateActivityMessage

MessageType<ActivationMessageArguments> kanzi::ActivityHostConcept::ActivateActivityMessage

static

You can send ActivateActivity to the host to activate an activity.

Exclusive Activity host deactivates the previously active activity at the same time.

◆ DeactivateActivityMessage

MessageType<ActivationMessageArguments> kanzi::ActivityHostConcept::DeactivateActivityMessage

static

You can send DeactivateActivity to the host to deactivate an activity.

Exclusive Activity host ignores this message.

◆ RegisterHostInternalMessage

MessageType<RegisterActivityElementInternalMessageArguments> kanzi::ActivityHostConcept::RegisterHostInternalMessage

static

Internal message sent by an activity host to its parent activity or activity host to register the host in the parent.

◆ UnregisterHostInternalMessage

MessageType<UnregisterActivityElementInternalMessageArguments> kanzi::ActivityHostConcept::UnregisterHostInternalMessage

static

Internal message sent by an activity host to its parent activity or activity host to unregister the host from the parent.

◆ RestoreFocusInternalMessage

MessageType<ActivityHostConceptInternalArguments> kanzi::ActivityHostConcept::RestoreFocusInternalMessage

static

Internal message sent by an Activity Host to its ancestor parent Activity Hosts to trigger the focus resolving.

Since: Kanzi 3.9.0

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ActivityInfoContainer

Member Enumeration Documentation

◆ ActivationStatus

◆ DeactivationStatus

◆ FocusLostFlag

Constructor & Destructor Documentation

◆ ~ActivityHostConcept()

Member Function Documentation

◆ makeEditorInfo()

◆ isActivityHost()

◆ setActivationModifier()

◆ onActivateActivityOverride()

Member Data Documentation

◆ ActivateActivityMessage

◆ DeactivateActivityMessage

◆ RegisterHostInternalMessage

◆ UnregisterHostInternalMessage

◆ RestoreFocusInternalMessage