Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass > Class Template Reference

Implementation of common functionality of ExclusiveActivityHost and DataDrivenExclusiveActivityHost classes. More...

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

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

Public Member Functions

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...
 
NodeSharedPtr onPrefabLoaded (PrefabTemplateSharedPtr prefabTemplate, string_view activityName) override
 ExclusiveActivityHostConcept::onPrefabLoaded implementation. More...
 
void setActivationModifier (string_view activityName, BindingTokenWeakPtr weakModifier) override
 ActivityHostConcept::setActivationModifier implementation. More...
 
- Public Member Functions inherited from kanzi::ActivityHostConceptImpl< TBaseClass, TDerivedClass >
void deserialize (string_view data) override
 ActivityElement::deserialize implementation. More...
 
void notifyChildrenNodeTreeAvailable () override
 ActivityElement::notifyChildrenNodeTreeAvailable implementation. More...
 
string serialize () override
 ActivityElement::serialize implementation. 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::ExclusiveActivityHostConcept
virtual ~ExclusiveActivityHostConcept ()=default
 Destructor. More...
 

Protected Member Functions

void activate (const ActivityHostConcept::ActivityInfo &activity)
 Requests the ExclusiveActivityHost to activate an Activity node. More...
 
void activate (const ActivityHostConcept::ActivityInfo &activity, string_view activationPath)
 Requests the ExclusiveActivityHost to activate an Activity node, and to forward the activation path to activate the children of the Activity node, if the Activity node is already active or activating. More...
 
void deactivate ()
 Requests the ExclusiveActivityHost to deactivate the currently active Activity node. More...
 
 ExclusiveActivityHostBaseImpl (Domain *domain, string_view name)
 Constructor. More...
 
vector< string > getActivatingNames () override
 ActivityHostConcept::getActivatingNames implementation. More...
 
string getActiveOrActivatingName () const
 Gets the currently active or activating Activity node. More...
 
vector< NodeWeakPtrgetActiveOrAttachedActivating () override
 ActivityHostConceptImpl::getActiveOrAttachedActivating implementation. More...
 
const vector< ExclusiveActivityHostConcept::ActivityInExclusiveHostInfo > & getActivitiesInfo () const override
 ExclusiveActivityHostConcept::getActivitiesInfo implementation. More...
 
optional< ActivityHostConcept::ActivityInfogetActivityInfo (string_view name) const override
 ActivityHostConceptImpl::getActivityInfo implementation. More...
 
vector< NodeWeakPtrgetAttachedActivityNodes () override
 ActivityHostConceptImpl::getAttachedActivityNodes implementation. More...
 
NodegetNode () override
 ExclusiveActivityHostConcept::getNode implementation. More...
 
const NodegetNode () const override
 ExclusiveActivityHostConcept::getNode implementation. More...
 
void initialize ()
 Initializes this exclusive activity host. More...
 
template<typename Iterator >
string nextToActivate (Iterator iterBegin, Iterator iterEnd, string_view current, bool looping) const
 Calculates which Activity node is going to be activated if the current active Activity node deactivates. More...
 
void onActivateActivityOverride (string_view activationPath, bool resetHistory) override
 ActivityHostConcept::onActivateActivityOverride implementation. More...
 
void onActivityActivated (NodeSharedPtr activity, string_view prefabPath) override
 ExclusiveActivityHostConcept::onActivityActivated implementation. More...
 
void onActivityDeactivated (NodeSharedPtr activity) override
 ExclusiveActivityHostConcept::onActivityDeactivated implementation. More...
 
void onAttachedOverride () override
 ActivityElement::onAttachedOverride implementation. More...
 
void onDetached () override
 Node::onDetached implementation. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged implementation. More...
 
void resolveFocusWithPolicy (Node &activityNode) override
 ActivityHostConcept::resolveFocusWithPolicy implementation. More...
 
virtual ~ExclusiveActivityHostBaseImpl ()=default
 Destructor. 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...
 
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...
 
- Protected Member Functions inherited from kanzi::ExclusiveActivityHostConcept
virtual void onNavigateNextMessage (const ExclusiveActivityHostConcept::ImplicitActivityChangeRequestMessageArguments &args)=0
 Message handler for ExclusiveActivityHostConcept::NavigateNextMessage. More...
 
virtual void onNavigatePreviousMessage (const ExclusiveActivityHostConcept::ImplicitActivityChangeRequestMessageArguments &args)=0
 Message handler for ExclusiveActivityHostConcept::NavigatePreviousMessage. More...
 

Additional Inherited Members

- 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::ExclusiveActivityHostConcept
enum  ExclusiveActivityHostFocusingPolicy { ExclusiveActivityHostFocusingPolicy::WhenHostHasFocus, ExclusiveActivityHostFocusingPolicy::AlwaysFocus, ExclusiveActivityHostFocusingPolicy::NeverFocus }
 Specifies the focusing policy that Kanzi applies to an activating Activity in an Exclusive Activity Host. More...
 
- 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::ExclusiveActivityHostConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Returns PropertyType editor info of exclusive activity concept. More...
 
- Static Public Attributes inherited from kanzi::ActivityElement
static PropertyType< bool > AttachedProperty
 
static PropertyType< bool > PreserveHistoryProperty
 Enables the preservation of Activity property values when that Activity becomes inactive. More...
 
- 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::ExclusiveActivityHostConcept
static MessageType< ImplicitActivityChangeRequestMessageArgumentsNavigateNextMessage
 In an Exclusive Activity Host requests the activation of the next Activity node in that Exclusive Activity Host node. More...
 
static MessageType< ImplicitActivityChangeRequestMessageArgumentsNavigatePreviousMessage
 In an Exclusive Activity Host requests the activation of the previous Activity node in that Exclusive Activity Host node. More...
 
static PropertyType< string > ExclusiveActivityHostContentProperty
 Describes the content of an Exclusive Activity Host node. More...
 
static PropertyType< string > ActiveActivityProperty
 The name of the child Activity node of an Exclusive Activity Host, that is either in ActivityConcept::Status::Active or in ActivityConcept::Status::Activating state. More...
 
static PropertyType< string > ActivationPathProperty
 The activation path containing the branch of the Activity tree that is requested to be activated. More...
 
static PropertyType< ExclusiveActivityHostFocusingPolicyFocusOnActivatingActivityProperty
 Sets the policy that an Exclusive Activity Host uses to decide whether it tries to set focus to an activating Activity. 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::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >

Implementation of common functionality of ExclusiveActivityHost and DataDrivenExclusiveActivityHost classes.

This is a helper class for the Exclusive Activity Host type classes.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

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

Constructor.

Parameters
domainThe domain the new node belongs to.
nameThe name of the node.
template<typename TBaseClass, typename TDerivedClass>
virtual kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::~ExclusiveActivityHostBaseImpl ( )
protectedvirtualdefault

Destructor.

Member Function Documentation

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

Message handler for FinishedParallelActivatingAnimationInternal message.

Parameters
argsMessage arguments.
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onFinishedParallelDeactivatingAnimationInternal ( const ActivityConcept::StatusChangedInternalMessageArguments args)

Message handler for FinishedParallelDeactivatingAnimationInternal message.

Parameters
argsMessage arguments.
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onFinishedExclusiveDeactivatingAnimationInternal ( const ActivityConcept::StatusChangedInternalMessageArguments args)

Message handler for FinishedExclusiveDeactivatingAnimationInternal message.

Parameters
argsMessage arguments.
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::setActivationModifier ( string_view  activityName,
BindingTokenWeakPtr  weakModifier 
)
overridevirtual
template<typename TBaseClass , typename TDerivedClass >
NodeSharedPtr kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onPrefabLoaded ( PrefabTemplateSharedPtr  prefabTemplate,
string_view  activityName 
)
overridevirtual
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::initialize ( )
protected

Initializes this exclusive activity host.

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onDetached ( )
overrideprotected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onNodePropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotected
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onAttachedOverride ( )
overrideprotectedvirtual
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onActivateActivityOverride ( string_view  activationPath,
bool  resetHistory 
)
overrideprotectedvirtual

ActivityHostConcept::onActivateActivityOverride implementation.

Since
Kanzi 3.9.8 added resetHistory.

Implements kanzi::ActivityHostConcept.

template<typename TBaseClass , typename TDerivedClass >
vector< NodeWeakPtr > kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::getActiveOrAttachedActivating ( )
overrideprotectedvirtual
template<typename TBaseClass , typename TDerivedClass >
vector< NodeWeakPtr > kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::getAttachedActivityNodes ( )
overrideprotectedvirtual
template<typename TBaseClass , typename TDerivedClass >
vector< string > kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::getActivatingNames ( )
overrideprotectedvirtual
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onActivityActivated ( NodeSharedPtr  activity,
string_view  prefabPath 
)
overrideprotectedvirtual
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::onActivityDeactivated ( NodeSharedPtr  activity)
overrideprotectedvirtual
template<typename TBaseClass , typename TDerivedClass >
optional< ActivityHostConcept::ActivityInfo > kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::getActivityInfo ( string_view  name) const
overrideprotectedvirtual
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::activate ( const ActivityHostConcept::ActivityInfo activity)
protected

Requests the ExclusiveActivityHost to activate an Activity node.

Parameters
activityThe ActivityInfo object of the Activity node to activate.
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::activate ( const ActivityHostConcept::ActivityInfo activity,
string_view  activationPath 
)
protected

Requests the ExclusiveActivityHost to activate an Activity node, and to forward the activation path to activate the children of the Activity node, if the Activity node is already active or activating.

Parameters
activityThe ActivityInfo object of the Activity node to activate.
activationPathActivation path to activate the children of the Activity node.
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::deactivate ( )
protected

Requests the ExclusiveActivityHost to deactivate the currently active Activity node.

template<typename TBaseClass , typename TDerivedClass >
template<typename Iterator >
string kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::nextToActivate ( Iterator  iterBegin,
Iterator  iterEnd,
string_view  current,
bool  looping 
) const
protected

Calculates which Activity node is going to be activated if the current active Activity node deactivates.

This method uses reverse iterator type as Iterator to get the previous Activity node.

Parameters
iterBeginIterator type pointing to the beginning of the list of the child Activity nodes.
iterEndIterator type pointing to the end of the list of the child Activity nodes.
currentNode to which the next activity is searched.
loopingWhen the function reaches the end of the list:
  • If looping is set to true, this method returns the iterBegin as the next element.
  • If looping is set to false, this method returns an empty string.
Returns
The name of the Activity node to activate when the current active Activity node deactivates. If Kanzi cannot activate any of the child Activity nodes, returns nullptr.
template<typename TBaseClass , typename TDerivedClass >
string kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::getActiveOrActivatingName ( ) const
protected

Gets the currently active or activating Activity node.

Returns
The name of the Activity node that is currently active or activating, empty string if no active or activating Activity node is found.
template<typename TBaseClass , typename TDerivedClass >
void kanzi::ExclusiveActivityHostBaseImpl< TBaseClass, TDerivedClass >::resolveFocusWithPolicy ( Node activityNode)
overrideprotectedvirtual

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