Kanzi  3.9.4
Kanzi Engine API
kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass > Class Template Reference

ParallelActivityHostConcept implementation class. More...

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

Inheritance diagram for kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >:
[legend]

Public Types

using NodeTypeSharedPtr = shared_ptr< TBaseClass >
 
- Public Types inherited from kanzi::ActivityHostConcept
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...
 
- Public Types inherited from kanzi::ParallelActivityHostConcept
using ParallelActivityHostContent = vector< ActivityInParallelHostInfo >
 Container for the content information for a ParallelActivityHost. More...
 
enum  ParallelActivityHostFocusingPolicy { ParallelActivityHostFocusingPolicy::WhenHostHasFocus, ParallelActivityHostFocusingPolicy::AlwaysFocus, ParallelActivityHostFocusingPolicy::NeverFocus }
 Specifies the focusing policy that Kanzi applies to an activating Activity in a Parallel Activity Host. More...
 

Public Member Functions

void activate (const ActivityHostConcept::ActivityInfo &activityInfo, string_view restOfActivationPath)
 Activates a child Activity node. More...
 
void deactivate (string_view name)
 Deactivates a child Activity node. More...
 
void deserialize (string_view data) override
 ActivityElement::deserialize implementation. More...
 
void onFinishedExclusiveDeactivatingAnimationInternal (const ActivityConcept::StatusChangedInternalMessageArguments &args)
 Message handler for FinishedExclusiveDeactivatingAnimationInternal message. More...
 
void onFinishedParallelActivatingAnimationInternal (const ActivityConcept::StatusChangedInternalMessageArguments &args)
 Message handler for FinishedParallelActivatingAnimationInternal message. More...
 
void onFinishedParallelDeactivatingAnimationInternal (const ActivityConcept::StatusChangedInternalMessageArguments &args)
 Message handler for FinishedParallelDeactivatingAnimationInternal message. More...
 
void setActivationModifier (string_view activityName, BindingTokenWeakPtr weakModifier) override
 ActivityHostConcept::setActivationModifier implementation. More...
 
- Public Member Functions inherited from kanzi::ActivityHostConceptImpl< TBaseClass, TDerivedClass >
void notifyChildrenNodeTreeAvailable () override
 ActivityElement::notifyChildrenNodeTreeAvailable implementation. More...
 
string serialize () override
 ActivityElement::serialize implementation. More...
 
- Public Member Functions inherited from kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >
NodegetNode () override
 Gets the underlying Node object. More...
 
const NodegetNode () const override
 Gets the underlying Node object. More...
 
- Public Member Functions inherited from kanzi::ActivityElement
vector< NodeSharedPtr >::const_iterator beginChildHosts () const
 Returns the begin iterator to the registered child Activity Host. More...
 
vector< NodeSharedPtr >::const_iterator endChildHosts () const
 Returns the end iterator to the registered child Activity Host. More...
 
NodefindChildHost (string_view hostName)
 Finds a child Activity Host by name. More...
 
vector< string > getCommands () const
 Gets the list of commands handled by code behind of this activity element. More...
 
ActivityHistoryManagergetHistoryManager () const
 Gets the history manager of this activity element. More...
 
ActivityElementgetParentElement ()
 Gets the parent ActivityElement type node. More...
 
bool isLeafActivityNode () const
 Returns whether an ActivityElement has a child Activity Host. More...
 
void setCodeBehind (const Metaclass *metaclass)
 Instantiates and attaches a code behind object by specifying its metaclass. More...
 
void setCodeBehind (CodeBehindSharedPtr codeBehind)
 Attaches a code behind object. More...
 
virtual ~ActivityElement ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::ActivityHostConcept
virtual ~ActivityHostConcept ()=default
 Destructor. More...
 
- Public Member Functions inherited from kanzi::ParallelActivityHostConcept
virtual ~ParallelActivityHostConcept ()=default
 Destructor. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ActivityElement
static string getFirstElement (string_view activationSequence)
 Gets the first element of the activation sequence. More...
 
static string getRestToForward (string_view activationSequence)
 Gets the remainder of the activation sequence. More...
 
template<typename Type >
static bool isActivityElement (const Type &object)
 Returns whether an object is an ActivityElement. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ActivityHostConcept
template<typename Type >
static bool isActivityHost (const Type &object)
 Determines if an object is an ActivityHost. More...
 
static bool isActivityHostMetaclass (const Metaclass *metaclass)
 Checks whether the given Metaclass is an ActivityHostConcept metaclass or contains it as a mixin metaclass. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ParallelActivityHostConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Returns the PropertyType editor information for a Parallel Activity Host Concept. More...
 

Protected Member Functions

vector< string > getActivatingNames () override
 ActivityHostConcept::getActivatingNames implementation. More...
 
vector< NodeWeakPtrgetActiveOrAttachedActivating () override
 ActivityHostConceptImpl::getActiveOrAttachedActivating implementation. More...
 
optional< ActivityHostConcept::ActivityInfogetActivityInfo (string_view name) const override
 ActivityHostConceptImpl::getActivityInfo implementation. More...
 
vector< NodeWeakPtrgetAttachedActivityNodes () override
 ActivityHostConceptImpl::getAttachedActivityNodes implementation. More...
 
void initialize ()
 Initializes this parallel activity host. More...
 
void onDetached () override
 Node::onDetached implementation. More...
 
 ParallelActivityHostImpl (Domain *domain, string_view name)
 Constructor. More...
 
void resolveFocusWithPolicy (Node &activityNode) override
 ActivityHostConceptImpl::resolveFocusWithPolicy implementation. More...
 
- Protected Member Functions inherited from kanzi::ActivityHostConceptImpl< TBaseClass, TDerivedClass >
 ActivityHostConceptImpl (Domain *domain, string_view name)
 Constructor. More...
 
void clearCurrentActivationTarget () const
 Clears current activation target. More...
 
void initialize ()
 Initializes this Activity Host Concept. More...
 
void registerInParentActivityElement () final
 ActivityElement::registerInParentActivityElement implementation. More...
 
void resolveFocusOnActivated (Node &activityNode)
 Performs the necessary operations to fix the application focus when an Activity has activated in this Activity Host. More...
 
void unregisterInParentActivityElement () final
 ActivityElement::unregisterInParentActivityElement implementation. More...
 
virtual ~ActivityHostConceptImpl ()=default
 Destructor. More...
 
- Protected Member Functions inherited from kanzi::ActivityElementImpl< TBaseClass, TDerivedClass >
 ActivityElementImpl (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 Initializes the activity element. More...
 
void onAttached () override
 Node::onAttached implementation. More...
 
virtual void onAttachedOverride ()
 Overrides the onAttached method. More...
 
void onDetached () override
 Node::onDetached implementation. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged implementation. More...
 
 ~ActivityElementImpl () override=default
 Destructor. More...
 
- Protected Member Functions inherited from kanzi::ActivityElement
optional< ActivityBrowserController::ActivityIDgetActivityID () const
 Gets the unique ID that is used by the implementation of the Activity Browser. More...
 
string getPathInParent ()
 Gets the activation path of this activity element relative to its parent. More...
 
void initialize ()
 Initializes the activity element. More...
 
bool isRootActivityElement () const
 Returns whether an ActivityElement is the root Activity Host node of the Screen node. More...
 
void onForceTrigger (const ActivityBrowserController::ForceTriggerMessageArguments &args)
 Message handler for ActivityBrowserController::ForceTriggerMessage. More...
 
void onNodeInfoTreeAvailable (const ActivityBrowserController::NodeInfoTreeAvailableArguments &)
 Message handler for ActivityBrowserController::NodeInfoTreeAvailableMessage. More...
 
void registerChildHost (string_view hostPath)
 Registers a child host in this activity element. More...
 
void setActivityID (optional< ActivityBrowserController::ActivityID > activityID)
 Sets the unique ID that is used by the implementation of the Activity Browser. More...
 
void unregisterChildHost (string_view hostName)
 Unregisters a child host from this activity element. More...
 
void updateActivityBrowserProperties ()
 Triggers the Activity Browser to update the properties of the Activity Element. More...
 

Additional Inherited Members

- Static Public Attributes inherited from kanzi::ActivityElement
static PropertyType< bool > AttachedProperty
 
- Static Public Attributes inherited from kanzi::ActivityHostConcept
static MessageType< ActivationMessageArgumentsActivateActivityMessage
 You can send ActivateActivity to the Activity Host to activate an Activity. More...
 
static MessageType< ActivationMessageArgumentsDeactivateActivityMessage
 You can send DeactivateActivity to the Activity Host to deactivate an Activity. More...
 
static MessageType< ActivityPrefabMessageArgumentsActivityPrefabAttachedMessage
 An Activity Host sends this message when it attaches the prefab of the Activity that is activated. More...
 
static MessageType< ActivityPrefabMessageArgumentsActivityPrefabDetachedMessage
 An Activity Host sends this message when it attaches the prefab of the Activity that is activated. More...
 
static MessageType< RegisterActivityElementInternalMessageArgumentsRegisterHostInternalMessage
 Internal message sent by an Activity Host to its parent Activity or Activity Host to register the Activity Host in the parent. More...
 
static MessageType< UnregisterActivityElementInternalMessageArgumentsUnregisterHostInternalMessage
 Internal message sent by an Activity Host to its parent Activity or Activity Host to unregister the Activity Host from the parent. More...
 
- Static Public Attributes inherited from kanzi::ParallelActivityHostConcept
static PropertyType< bool > BringActivatedToFrontProperty
 Sets whether to show the activated Activity in front within its Parallel Activity Host. More...
 
static PropertyType< bool > ActivationStackProperty
 Sets whether a Parallel Activity Host keeps a child Activity node active to satisfy the request from both ActivateActivityMessage activation and ApplyActivationAction mechanism. More...
 
static PropertyType< string > ParallelActivityHostContentProperty
 Describes the content of a Parallel Activity Host node. More...
 
static PropertyType< ParallelActivityHostFocusingPolicyFocusOnActivationProperty
 Sets the focusing policy that Kanzi uses to decide whether it tries to set focus to an activating Activity in a Parallel Activity Host. More...
 
- Protected Attributes inherited from kanzi::ActivityHostConceptImpl< TBaseClass, TDerivedClass >
string m_activationTarget
 The name of the Activity that is the candidate to be the activation target. More...
 
bool m_deserializing
 Indicates that this Activity Host is performing property deserialization. More...
 
bool m_hostHadFocus
 Indicates that the Activity Host had focus before it started to activate new activation target Activity. More...
 

Detailed Description

template<typename TBaseClass, typename TDerivedClass>
class kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >

ParallelActivityHostConcept implementation class.

This is a helper class for parallel activity hosts.

Member Typedef Documentation

◆ NodeTypeSharedPtr

template<typename TBaseClass, typename TDerivedClass>
using kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::NodeTypeSharedPtr = shared_ptr<TBaseClass>

Constructor & Destructor Documentation

◆ ParallelActivityHostImpl()

template<typename TBaseClass , typename TDerivedClass >
kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::ParallelActivityHostImpl ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe domain the new node belongs to.
nameThe name of the node.

Member Function Documentation

◆ makeEditorInfo()

template<typename TBaseClass , typename TDerivedClass >
PropertyTypeEditorInfoSharedPtr kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )
static

◆ deserialize()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::deserialize ( string_view  data)
overridevirtual

ActivityElement::deserialize implementation.

Deserializes the currently active child Activity nodes.

Reimplemented from kanzi::ActivityHostConceptImpl< TBaseClass, TDerivedClass >.

◆ onFinishedParallelActivatingAnimationInternal()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::onFinishedParallelActivatingAnimationInternal ( const ActivityConcept::StatusChangedInternalMessageArguments args)

Message handler for FinishedParallelActivatingAnimationInternal message.

Parameters
argsMessage arguments.

◆ onFinishedParallelDeactivatingAnimationInternal()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::onFinishedParallelDeactivatingAnimationInternal ( const ActivityConcept::StatusChangedInternalMessageArguments args)

Message handler for FinishedParallelDeactivatingAnimationInternal message.

Parameters
argsMessage arguments.

◆ onFinishedExclusiveDeactivatingAnimationInternal()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::onFinishedExclusiveDeactivatingAnimationInternal ( const ActivityConcept::StatusChangedInternalMessageArguments args)

Message handler for FinishedExclusiveDeactivatingAnimationInternal message.

Parameters
argsMessage arguments.

◆ setActivationModifier()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::setActivationModifier ( string_view  activityName,
BindingTokenWeakPtr  weakModifier 
)
overridevirtual

◆ activate()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::activate ( const ActivityHostConcept::ActivityInfo activityInfo,
string_view  restOfActivationPath 
)

Activates a child Activity node.

Parameters
activityInfoThe Activity information of the node to activate.
restOfActivationPathThe path of the activation sequence to forward to the activated Activity node, once the given Activity node is activated.

◆ deactivate()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::deactivate ( string_view  name)

Deactivates a child Activity node.

Parameters
nameThe name of the Activity node to deactivate.

◆ initialize()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::initialize ( )
protected

Initializes this parallel activity host.

◆ onDetached()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::onDetached ( )
overrideprotected

Node::onDetached implementation.

◆ getActivityInfo()

template<typename TBaseClass , typename TDerivedClass >
optional< ActivityHostConcept::ActivityInfo > kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::getActivityInfo ( string_view  name) const
overrideprotectedvirtual

◆ getActiveOrAttachedActivating()

template<typename TBaseClass , typename TDerivedClass >
vector< NodeWeakPtr > kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::getActiveOrAttachedActivating ( )
overrideprotectedvirtual

◆ getAttachedActivityNodes()

template<typename TBaseClass , typename TDerivedClass >
vector< NodeWeakPtr > kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::getAttachedActivityNodes ( )
overrideprotectedvirtual

◆ getActivatingNames()

template<typename TBaseClass , typename TDerivedClass >
vector< string > kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::getActivatingNames ( )
overrideprotectedvirtual

◆ resolveFocusWithPolicy()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ParallelActivityHostImpl< TBaseClass, TDerivedClass >::resolveFocusWithPolicy ( Node activityNode)
overrideprotectedvirtual

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