Implementation class for ActivityConcept. More...
#include <kanzi/ui/node/concept/activity/activity_concept_impl.hpp>
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... | |
| Node * | getNode () override |
| Gets the underlying Node object. More... | |
| const Node * | getNode () const override |
| Gets the underlying Node object. More... | |
| ActivityConcept * | getParentActivity () 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 > | |
| Node * | getNode () override |
| Gets the underlying Node object. More... | |
| const Node * | getNode () 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... | |
| Node * | findChildHost (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... | |
| ActivityHistoryManager * | getHistoryManager () const |
| Gets the history manager of this activity element. More... | |
| ActivityElement * | getParentElement () |
| 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::ActivityID > | getActivityID () 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< Status > | StatusProperty |
| 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< StatusChangedMessageArguments > | StatusChangedMessage |
| Subscribe to this message to receive notifications when the ActivityConcept::Status of this Activity changes. More... | |
| static MessageType< ActivityMessageArguments > | ActivityActivatingMessage |
| Subscribe to this message to receive notifications when this Activity is in the activating state. More... | |
| static MessageType< ActivityMessageArguments > | ActivityActivatedMessage |
| Subscribe to this message to receive notifications when this Activity is activated. More... | |
| static MessageType< ActivityMessageArguments > | ActivityDeactivatingMessage |
| Subscribe to this message to receive notifications when this Activity is in the deactivating state. More... | |
| static MessageType< ActivityMessageArguments > | ActivityDeactivatedMessage |
| Subscribe to this message to receive notifications when this Activity is deactivated. More... | |
| static MessageType< StartActivationInternalMessageArguments > | StartActivationInternalMessage |
| Internal message sent by an Activity Host to the Activity to initialize the resources of the Activity. More... | |
| static MessageType< ActivityInternalMessageArguments > | StartDeactivationInternalMessage |
| Internal message sent by an Activity Host to the Activity to deactivate the Activity. More... | |
| static MessageType< StatusChangedInternalMessageArguments > | ReadyForActivationAnimationInternalMessage |
| Internal message sent by the Activity to its parent Activity Host when the Activity has finished initializing its resources. More... | |
| static MessageType< ActivityInternalMessageArguments > | StartParallelActivatingAnimationInternalMessage |
| Internal message sent by an Activity Host to the Activity to start the parallel activation animation of the Activity. More... | |
| static MessageType< StatusChangedInternalMessageArguments > | FinishedParallelActivatingAnimationInternalMessage |
| 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< ActivityInternalMessageArguments > | StartExclusiveActivatingAnimationInternalMessage |
| Internal message sent by an Activity Host to the Activity to start the exclusive activation animation of the Activity. More... | |
| static MessageType< ActivityInternalMessageArguments > | StartExclusiveDeactivatingAnimationInternalMessage |
| Internal message sent by an Activity Host to the Activity to start the exclusive deactivation animation of the Activity. More... | |
| static MessageType< StatusChangedInternalMessageArguments > | FinishedExclusiveDeactivatingAnimationInternalMessage |
| 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< ActivityInternalMessageArguments > | StartParallelDeactivatingAnimationInternalMessage |
| Internal message sent by an Activity Host to the Activity to start the parallel deactivation animation of the Activity. More... | |
| static MessageType< StatusChangedInternalMessageArguments > | FinishedParallelDeactivatingAnimationInternalMessage |
| 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... | |
Implementation class for ActivityConcept.
|
explicitprotected |
Constructor.
| domain | The domain the new node belongs to. |
| name | The name of the node. |
|
overrideprotecteddefault |
Destructor.
|
overridevirtual |
Gets the underlying Node object.
Implements kanzi::ActivityConcept.
|
overridevirtual |
Gets the underlying Node object.
Implements kanzi::ActivityConcept.
|
overridevirtual |
ActivityElement::serialize implementation.
Reimplemented from kanzi::ActivityElement.
|
finalvirtual |
ActivityConcept::restoreLastFocusedNode implementation.
Implements kanzi::ActivityConcept.
|
finalvirtual |
ActivityConcept::setLastFocusedNodePath implementation.
Implements kanzi::ActivityConcept.
|
finalvirtual |
ActivityConcept::tryRestoreLastFocusedPathCompletely implementation.
Implements kanzi::ActivityConcept.
|
overridevirtual |
ActivityConcept::getParentActivity implementation.
Implements kanzi::ActivityConcept.
|
override |
Overrides Node::updateFocusScopeInfo().
|
overridevirtual |
Implements ActivityConcept::collectActivatingDescendantActivities.
Implements kanzi::ActivityConcept.
|
overridevirtual |
Implements ActivityConcept::notifyPendingActivationBeforeFocusFinished.
Implements kanzi::ActivityConcept.
| void kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::notifyReadyForFocus | ( | ) |
|
overridevirtual |
Overrides ActivityConcept::enableFocusRecovery().
Implements kanzi::ActivityConcept.
|
overridevirtual |
|
overridevirtual |
|
overridevirtual |
Overrides ActivityConcept::isAutoClosingBecauseFocusMove().
Implements kanzi::ActivityConcept.
|
staticprotected |
|
protected |
Initializes this activity.
|
finalprotectedvirtual |
ActivityElement::registerInParentActivityElement implementation.
Implements kanzi::ActivityElement.
|
finalprotectedvirtual |
ActivityElement::registerInParentActivityElement implementation.
Implements kanzi::ActivityElement.
|
overrideprotected |
Node::onDetached implementation.
|
overrideprotected |
Node::onAttached implementation.
|
protected |
Message handler for InputOutsideOverlayMessage message.
Only Auto-Closing Overlay Activities should handle the InputOutsideOverlayMessage with this handler.
| args | Message arguments. |
