Implementation class for ActivityConcept. More...
#include <kanzi/ui/node/concept/activity/activity_concept_impl.hpp>
Public Member Functions | |
| TDerivedClass * | getThisObject () |
| Internal accessor for curiously recurring template pattern. More... | |
| const TDerivedClass * | getThisObject () const |
| Internal accessor for curiously recurring template pattern. 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 | |
| virtual void | deserialize (string_view data) |
| Deserializes the activity element from a byte buffer. 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... | |
| const Node * | restoreLastFocusedNode () |
| Restores the focus to a child node of this Activity node, if the Activity node: More... | |
| virtual string | serialize () |
| Serializes the activity element to a byte buffer. 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... | |
| void | setLastFocusedNodePath () |
| Sets the last focused node path of this Activity node to the currently focused child node, if the Activity node: More... | |
| virtual | ~ActivityElement ()=default |
| Destructor. More... | |
| Public Member Functions inherited from kanzi::ActivityConcept | |
| 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 | 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... | |
| TDerivedClass * | getThisObject () |
| Internal accessor for curiously recurring template pattern. More... | |
| const TDerivedClass * | getThisObject () const |
| Internal accessor for curiously recurring template pattern. 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 node. 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) |
| Checks if and object is an ActivityElement. More... | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Static Public Member Functions inherited from kanzi::ActivityConcept | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Static Public Attributes inherited from kanzi::ActivityElement | |
| static PropertyType< bool > | AttachedProperty |
| Static Public Attributes inherited from kanzi::ActivityConcept | |
| static MessageType< DeactivateInternalMessageArguments > | DeactivateInternalMessage |
| Internal message sent by an activity host to the activity to deactivate the activity. More... | |
| static MessageType< ActivityBaseArguments > | FinishedExclusiveDeactivatingAnimationInternalMessage |
| Internal message sent by the activity to its parent host when the activity has finished the exclusive deactivation animation of the activity. More... | |
| static MessageType< ActivityBaseArguments > | FinishedParallelActivatingAnimationInternalMessage |
| Internal message sent by the activity to its parent host when the activity has finished the parallel activation animation of the activity. More... | |
| static MessageType< ActivityBaseArguments > | FinishedParallelDeactivatingAnimationInternalMessage |
| Internal message sent by the activity to its parent host when the activity has finished the parallel deactivation animation of the activity. More... | |
| static MessageType< ActivityBaseArguments > | PrefabAttachedMessage |
| Informs when Kanzi attaches the prefab of this Activity node. More... | |
| static MessageType< ActivityBaseArguments > | PrefabDetachedMessage |
| Informs when Kanzi detaches the prefab of this Activity node. More... | |
| static MessageType< ActivityBaseArguments > | ReadyForActivationAnimationInternalMessage |
| Internal message sent by the activity to its parent host when the activity has finished initializing its resources. 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< ActivityConceptInternalArguments > | StartExclusiveActivatingAnimationInternalMessage |
| Internal message sent by an activity host to the activity to start the exclusive activation animation of the activity. More... | |
| static MessageType< ActivityConceptInternalArguments > | StartExclusiveDeactivatingAnimationInternalMessage |
| Internal message sent by an activity host to the activity to start the exclusive deactivation animation of the activity. More... | |
| static MessageType< ActivityConceptInternalArguments > | StartParallelActivatingAnimationInternalMessage |
| Internal message sent by an activity host to the activity to start the parallel activation animation of the activity. More... | |
| static MessageType< ActivityConceptInternalArguments > | StartParallelDeactivatingAnimationInternalMessage |
| Internal message sent by an activity host to the activity to start the parallel deactivation animation of the activity. More... | |
| static MessageType< StatusChangedMessageArguments > | StatusChangedMessage |
| You can subscribe to this message to receive notifications when the Status of this activity changes. More... | |
| static PropertyType< Status > | StatusProperty |
| static PropertyType< ResourceSharedPtr > | StatusManagerProperty |
| Specifies the State Manager that handles the Status property changes. More... | |
| static PropertyType< float > | DummyStateManagerProperty |
| Lack of a queuing mechanism for incoming messages from an Activity Host node can cause Kanzi to enter a recursive call in the setProperty(). More... | |
| static PropertyType< bool > | ActivatedByActivationModifierProperty |
| Specifies whether the activation of an Activity node 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... | |
Implementation class for ActivityConcept.
|
explicitprotected |
Constructor.
| domain | The domain the new node belongs to. |
| name | The name of the node. |
|
overrideprotecteddefault |
Destructor.
| TDerivedClass * kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::getThisObject | ( | ) |
Internal accessor for curiously recurring template pattern.
| const TDerivedClass * kanzi::ActivityConceptImpl< TBaseClass, TDerivedClass >::getThisObject | ( | ) | const |
Internal accessor for curiously recurring template pattern.
|
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.
