Base class for Activity classes. More...
#include <kanzi/ui/node/concept/activity/activity_concept.hpp>
Classes | |
class | ActivityBaseArguments |
Base class for the Activity message argument classes. More... | |
class | ActivityConceptInternalArguments |
Base class for the Activity Concept message argument classes. More... | |
class | DeactivateInternalMessageArguments |
Message arguments for the DeactivateInternal message. More... | |
class | StartActivationInternalMessageArguments |
Message arguments for the StartActivationInternal message. More... | |
class | StatusChangedMessageArguments |
Message arguments for the StatusChanged message. More... | |
Public Types | |
enum | Status { Status::Active, Status::Inactive, Status::Activating, Status::Deactivating } |
Defines possible states of an Activity node. More... | |
Public Member Functions | |
virtual | ~ActivityConcept ()=default |
Destructor. More... | |
Static Public Member Functions | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Static Public Attributes | |
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... | |
Properties | |
Specifies the status of this activity. | |
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... | |
Base class for Activity classes.
This class defines common types, properties, and messages for Activity classes.
|
strong |
Defines possible states of an Activity node.
Activity Host nodes can activate and deactivate their child Activity nodes. This enumeration defines the possible states of an Activity node during the the process of activation and deactivation. You can use this functionality to react to changes in Activity node status in your application code and in Kanzi Studio.
|
virtualdefault |
Destructor.
|
static |
|
static |
|
static |
Specifies the State Manager that handles the Status property changes.
The activity will monitor transitions in this state manager to know when to progress status changes.
|
static |
Lack of a queuing mechanism for incoming messages from an Activity Host node can cause Kanzi to enter a recursive call in the setProperty().
A temporary solution to this is the StatusManagerProperty that Kanzi sets in states with different values, and adds an any-to-any transition with the duration of 1 millisecond.
|
static |
Specifies whether the activation of an Activity node is requested by modifier bindings callbacks of an ApplyAction of a DataTrigger.
Kanzi uses this property internally to disable serialization and deserialization of the activation status for such Activity nodes.
|
static |
Indicates whether to serialize the last focused child node of a focus scope Activity and restore the focus on deserialization.
If an Activity or Activity Host is a focus scope, add and set this property to True when you want to save and restore the focus from serialized Activities and Activity Host in that focus scope.
|
static |
You can subscribe to this message to receive notifications when the Status of this activity changes.
|
static |
Internal message sent by an activity host to the activity to initialize the resources of the activity.
|
static |
Internal message sent by the activity to its parent host when the activity has finished initializing its resources.
|
static |
Internal message sent by an activity host to the activity to start the parallel activation animation of the activity.
|
static |
Internal message sent by the activity to its parent host when the activity has finished the parallel activation animation of the activity.
|
static |
Internal message sent by an activity host to the activity to start the exclusive activation animation of the activity.
|
static |
Internal message sent by an activity host to the activity to start the exclusive deactivation animation of the activity.
|
static |
Internal message sent by the activity to its parent host when the activity has finished the exclusive deactivation animation of the activity.
|
static |
Internal message sent by an activity host to the activity to start the parallel deactivation animation of the activity.
|
static |
Internal message sent by the activity to its parent host when the activity has finished the parallel deactivation animation of the activity.
|
static |
Internal message sent by an activity host to the activity to deactivate the activity.
|
static |
Informs when Kanzi attaches the prefab of this Activity node.
|
static |
Informs when Kanzi detaches the prefab of this Activity node.