Kanzi  3.9.6
Kanzi Engine API
kanzi::ActivityStatusAnimationFinishedHandler Class Reference

Encapsulates dispatching of messages when an activating or a deactivating activity animation is finished. More...

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

Public Member Functions

void clear ()
 Removes the stored pending-response function. More...
 
void executeIfPending ()
 Calls the pending-response function, if one is stored. More...
 
template<ActivityConcept::Status value>
void sendMessages (ActivityElement &activityElement)
 Depending on the value of the StatusProperty, sends messages that Kanzi sends after the transition in a state manager is completed. More...
 
void setPendingResponse (ActivityConcept::Status status, ActivityElement &activityElement)
 Depending on the value of the StatusProperty, calls the appropriate sendMessages(). More...
 

Detailed Description

Encapsulates dispatching of messages when an activating or a deactivating activity animation is finished.

This is a helper class for ActivityStatusManager.

Member Function Documentation

◆ sendMessages()

template<ActivityConcept::Status value>
void kanzi::ActivityStatusAnimationFinishedHandler::sendMessages ( ActivityElement activityElement)

Depending on the value of the StatusProperty, sends messages that Kanzi sends after the transition in a state manager is completed.

Parameters
activityElementThe Activity element the ActivityStatusManager handles.

◆ setPendingResponse()

void kanzi::ActivityStatusAnimationFinishedHandler::setPendingResponse ( ActivityConcept::Status  status,
ActivityElement activityElement 
)

Depending on the value of the StatusProperty, calls the appropriate sendMessages().

See also
ActivityStatusAnimationFinishedHandler::sendMessages().
Parameters
statusStatus for which messages must be sent.
activityElementThe Activity element the ActivityStatusManager handles.

◆ executeIfPending()

void kanzi::ActivityStatusAnimationFinishedHandler::executeIfPending ( )

Calls the pending-response function, if one is stored.

◆ clear()

void kanzi::ActivityStatusAnimationFinishedHandler::clear ( )

Removes the stored pending-response function.


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