Kanzi  3.9.5
Kanzi Engine API
kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass > Class Template Reference

Implementation class for ActivityConcept. More...

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

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

Public Member Functions

bool collectActivatingDescendantActivities () override
 Implements ActivityConcept::collectActivatingDescendantActivities. More...
 
void enableFocusGain (bool enable) override
 Overrides ActivityConcept::enableFocusGain(). More...
 
void enableFocusRecovery (bool enable) override
 Overrides ActivityConcept::enableFocusRecovery(). More...
 
void enableInput (bool enable) override
 Overrides ActivityConcept::enableInput(). More...
 
NodegetNode () override
 Gets the underlying Node object. More...
 
const NodegetNode () const override
 Gets the underlying Node object. More...
 
ActivityConceptgetParentActivity () override
 ActivityConcept::getParentActivity implementation. More...
 
bool isAutoClosingBecauseFocusMove () const override
 Overrides ActivityConcept::isAutoClosingBecauseFocusMove(). More...
 
void notifyPendingActivationBeforeFocusFinished (string_view activityName) override
 Implements ActivityConcept::notifyPendingActivationBeforeFocusFinished. More...
 
void notifyReadyForFocus ()
 
void restoreLastFocusedNode () final
 ActivityConcept::restoreLastFocusedNode implementation. More...
 
string serialize () override
 ActivityElement::serialize implementation. More...
 
void setLastFocusedNodePath () final
 ActivityConcept::setLastFocusedNodePath implementation. More...
 
void tryRestoreLastFocusedPathCompletely (const Node *candidateChild) final
 ActivityConcept::tryRestoreLastFocusedPathCompletely implementation. More...
 
void updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo) override
 Overrides Node::updateFocusScopeInfo(). 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...
 
virtual void deserialize (string_view data)
 Deserializes the activity element from a byte buffer. 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::ActivityConcept
void cancelWaitBeforeFocus ()
 Makes an Activity no longer wait for any pending activations. More...
 
optional< string > getPathToActivity (ActivityConcept *activity) const
 Returns a path from this Activity to a given Activity, if that Activity is a descendant node of this Activity. More...
 
bool isWaitingActivationsBeforeFocus () const
 Returns whether an Activity is waiting for its descendant Activities to activate before Kanzi applies the focus policy to the activated Activity. More...
 
bool isWaitingForActivation (ActivityConcept *activity) const
 Returns whether an Activity is waiting for the activation of a given Activity. More...
 
virtual ~ActivityConcept ()=default
 Destructor. More...
 

Protected Member Functions

 ActivityConceptImpl (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 Initializes this activity. More...
 
void onAttached () override
 Node::onAttached implementation. More...
 
void onDetached () override
 Node::onDetached implementation. More...
 
void onInputOutsideOverlay (FocusManager::InputOutsideOverlayMessageArguments &args)
 Message handler for InputOutsideOverlayMessage message. More...
 
void registerInParentActivityElement () final
 ActivityElement::registerInParentActivityElement implementation. More...
 
void unregisterInParentActivityElement () final
 ActivityElement::registerInParentActivityElement implementation. More...
 
 ~ActivityConceptImpl () override=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...
 
virtual void notifyChildrenNodeTreeAvailable ()
 Notifies child activity elements that node info tree is available. 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...
 

Static Protected Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Additional Inherited Members

- Public Types inherited from kanzi::ActivityConcept
enum  Status { Status::Active, Status::Inactive, Status::Activating, Status::Deactivating }
 Defines possible states of an Activity. 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::ActivityConcept
template<typename Type >
static bool isActivity (const Type &object)
 Returns whether an object is an Activity. More...
 
static bool isActivityMetaclass (const Metaclass *metaclass)
 Checks whether the given Metaclass is an ActivityConcept metaclass or contains it as a mixin metaclass. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Attributes inherited from kanzi::ActivityElement
static PropertyType< bool > AttachedProperty
 
- Static Public Attributes inherited from kanzi::ActivityConcept
static NodeWeakPtr s_activationTargetActivity
 The Activity that is the activation target. More...
 
static PropertyType< StatusStatusProperty
 Specifies the status of this Activity. More...
 
static PropertyType< float > DummyStateManagerProperty
 Lack of a queuing mechanism for incoming messages from an Activity Host can cause Kanzi to enter a recursive call in the setProperty(). More...
 
static PropertyType< bool > ActivatedByActivationModifierProperty
 Specifies whether the activation of an Activity is requested by modifier bindings callbacks of an ApplyAction of a DataTrigger. More...
 
static PropertyType< bool > SaveLastFocusedNodeProperty
 Indicates whether to serialize the last focused child node of a focus scope Activity and restore the focus on deserialization. More...
 
static MessageType< StatusChangedMessageArgumentsStatusChangedMessage
 Subscribe to this message to receive notifications when the ActivityConcept::Status of this Activity changes. More...
 
static MessageType< ActivityMessageArgumentsActivityActivatingMessage
 Subscribe to this message to receive notifications when this Activity is in the activating state. More...
 
static MessageType< ActivityMessageArgumentsActivityActivatedMessage
 Subscribe to this message to receive notifications when this Activity is activated. More...
 
static MessageType< ActivityMessageArgumentsActivityDeactivatingMessage
 Subscribe to this message to receive notifications when this Activity is in the deactivating state. More...
 
static MessageType< ActivityMessageArgumentsActivityDeactivatedMessage
 Subscribe to this message to receive notifications when this Activity is deactivated. More...
 
static MessageType< StartActivationInternalMessageArgumentsStartActivationInternalMessage
 Internal message sent by an Activity Host to the Activity to initialize the resources of the Activity. More...
 
static MessageType< ActivityInternalMessageArgumentsStartDeactivationInternalMessage
 Internal message sent by an Activity Host to the Activity to deactivate the Activity. More...
 
static MessageType< StatusChangedInternalMessageArgumentsReadyForActivationAnimationInternalMessage
 Internal message sent by the Activity to its parent Activity Host when the Activity has finished initializing its resources. More...
 
static MessageType< ActivityInternalMessageArgumentsStartParallelActivatingAnimationInternalMessage
 Internal message sent by an Activity Host to the Activity to start the parallel activation animation of the Activity. More...
 
static MessageType< StatusChangedInternalMessageArgumentsFinishedParallelActivatingAnimationInternalMessage
 Internal message sent by the Activity to its parent Activity Host when the Activity has finished the parallel activation animation of the Activity. More...
 
static MessageType< ActivityInternalMessageArgumentsStartExclusiveActivatingAnimationInternalMessage
 Internal message sent by an Activity Host to the Activity to start the exclusive activation animation of the Activity. More...
 
static MessageType< ActivityInternalMessageArgumentsStartExclusiveDeactivatingAnimationInternalMessage
 Internal message sent by an Activity Host to the Activity to start the exclusive deactivation animation of the Activity. More...
 
static MessageType< StatusChangedInternalMessageArgumentsFinishedExclusiveDeactivatingAnimationInternalMessage
 Internal message sent by the Activity to its parent Activity Host when the Activity has finished the exclusive deactivation animation of the Activity. More...
 
static MessageType< ActivityInternalMessageArgumentsStartParallelDeactivatingAnimationInternalMessage
 Internal message sent by an Activity Host to the Activity to start the parallel deactivation animation of the Activity. More...
 
static MessageType< StatusChangedInternalMessageArgumentsFinishedParallelDeactivatingAnimationInternalMessage
 Internal message sent by the Activity to its parent Activity Host when the Activity has finished the parallel deactivation animation of the Activity. More...
 
- Protected Attributes inherited from kanzi::ActivityConcept
vector< string > m_pendingActivationsBeforeFocus
 The paths of the activating Activities that this Activity is waiting to be activated. More...
 

Detailed Description

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

Implementation class for ActivityConcept.

Constructor & Destructor Documentation

◆ ActivityConceptImpl()

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

Constructor.

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

◆ ~ActivityConceptImpl()

template<typename TBaseClass, typename TDerivedClass>
kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::~ActivityConceptImpl ( )
overrideprotecteddefault

Destructor.

Member Function Documentation

◆ getNode() [1/2]

template<typename TBaseClass , typename TDerivedClass >
Node * kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::getNode ( )
overridevirtual

Gets the underlying Node object.

Returns
The underlying Node object pointer.

Implements kanzi::ActivityConcept.

◆ getNode() [2/2]

template<typename TBaseClass , typename TDerivedClass >
const Node * kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::getNode ( ) const
overridevirtual

Gets the underlying Node object.

Returns
The underlying Node object pointer.

Implements kanzi::ActivityConcept.

◆ serialize()

template<typename TBaseClass , typename TDerivedClass >
string kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::serialize ( )
overridevirtual

ActivityElement::serialize implementation.

Since
Kanzi 3.9.2

Reimplemented from kanzi::ActivityElement.

◆ restoreLastFocusedNode()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::restoreLastFocusedNode ( )
finalvirtual

ActivityConcept::restoreLastFocusedNode implementation.

Since
Kanzi 3.9.2

Implements kanzi::ActivityConcept.

◆ setLastFocusedNodePath()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::setLastFocusedNodePath ( )
finalvirtual

ActivityConcept::setLastFocusedNodePath implementation.

Since
Kanzi 3.9.2

Implements kanzi::ActivityConcept.

◆ tryRestoreLastFocusedPathCompletely()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::tryRestoreLastFocusedPathCompletely ( const Node candidateChild)
finalvirtual

◆ getParentActivity()

template<typename TBaseClass , typename TDerivedClass >
ActivityConcept * kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::getParentActivity ( )
overridevirtual

◆ updateFocusScopeInfo()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::updateFocusScopeInfo ( FocusScopePtr nodeScopeInfo)
override

◆ collectActivatingDescendantActivities()

template<typename TBaseClass , typename TDerivedClass >
bool kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::collectActivatingDescendantActivities ( )
overridevirtual

◆ notifyPendingActivationBeforeFocusFinished()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::notifyPendingActivationBeforeFocusFinished ( string_view  activityName)
overridevirtual

◆ notifyReadyForFocus()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::notifyReadyForFocus ( )

◆ enableFocusRecovery()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::enableFocusRecovery ( bool  enable)
overridevirtual

Overrides ActivityConcept::enableFocusRecovery().

Since
Kanzi 3.9.3

Implements kanzi::ActivityConcept.

◆ enableFocusGain()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::enableFocusGain ( bool  enable)
overridevirtual

Overrides ActivityConcept::enableFocusGain().

Since
Kanzi 3.9.3

Implements kanzi::ActivityConcept.

◆ enableInput()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::enableInput ( bool  enable)
overridevirtual

Overrides ActivityConcept::enableInput().

Since
Kanzi 3.9.4

Implements kanzi::ActivityConcept.

◆ isAutoClosingBecauseFocusMove()

template<typename TBaseClass , typename TDerivedClass >
bool kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::isAutoClosingBecauseFocusMove ( ) const
overridevirtual

◆ makeEditorInfo()

template<typename TBaseClass , typename TDerivedClass >
PropertyTypeEditorInfoSharedPtr kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )
staticprotected

◆ initialize()

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

Initializes this activity.

◆ registerInParentActivityElement()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::registerInParentActivityElement ( )
finalprotectedvirtual

◆ unregisterInParentActivityElement()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::unregisterInParentActivityElement ( )
finalprotectedvirtual

◆ onDetached()

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

Node::onDetached implementation.

◆ onAttached()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::onAttached ( )
overrideprotected

Node::onAttached implementation.

◆ onInputOutsideOverlay()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::onInputOutsideOverlay ( FocusManager::InputOutsideOverlayMessageArguments args)
protected

Message handler for InputOutsideOverlayMessage message.

Only Auto-Closing Overlay Activities should handle the InputOutsideOverlayMessage with this handler.

Parameters
argsMessage arguments.
Since
Kanzi 3.9.3

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