Base class for Activity classes. More...
#include <kanzi/ui/node/concept/activity/activity_concept.hpp>
Classes | |
class | ActivityInternalMessageArguments |
Class for all the internal Activity messages that do not require any message arguments. More... | |
class | ActivityMessageArguments |
Message arguments that hold the name of the Activity included in the message. More... | |
class | StartActivationInternalMessageArguments |
Message arguments for the StartActivationInternalMessage. More... | |
class | StatusChangedInternalMessageArguments |
Message arguments for internal Activity messages related to Activity status changes. More... | |
class | StatusChangedMessageArguments |
Message arguments for the StatusChangedMessage. More... | |
Public Types | |
enum | Status { Status::Active, Status::Inactive, Status::Activating, Status::Deactivating } |
Defines possible states of an Activity. More... | |
Public Member Functions | |
virtual | ~ActivityConcept ()=default |
Destructor. More... | |
Static Public Member Functions | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Static Public Attributes | |
Properties | |
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... | |
Messages | |
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... | |
Internal Messages | |
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... | |
Base class for Activity classes.
This class defines common types, properties, and messages for Activity classes.
|
strong |
Defines possible states of an Activity.
Activity Host nodes can activate and deactivate their child Activities. This enumeration defines the possible states of an Activity during the the process of activation and deactivation. You can use this functionality to react to changes in Activity status in your application code and in Kanzi Studio.
|
virtualdefault |
Destructor.
|
static |
|
static |
Specifies the status of this Activity.
|
static |
Lack of a queuing mechanism for incoming messages from an Activity Host can cause Kanzi to enter a recursive call in the setProperty().
A temporary solution to this is the DummyStateManagerProperty 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 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 Activities.
|
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 |
Subscribe to this message to receive notifications when the ActivityConcept::Status of this Activity changes.
|
static |
Subscribe to this message to receive notifications when this Activity is in the activating state.
|
static |
Subscribe to this message to receive notifications when this Activity is activated.
|
static |
Subscribe to this message to receive notifications when this Activity is in the deactivating state.
|
static |
Subscribe to this message to receive notifications when this Activity is deactivated.
|
static |
Internal message sent by an Activity Host to the Activity to initialize the resources of the Activity.
|
static |
Internal message sent by an Activity Host to the Activity to deactivate the Activity.
|
static |
Internal message sent by the Activity to its parent Activity 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 Activity 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 Activity 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 Activity Host when the Activity has finished the parallel deactivation animation of the Activity.