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.
void	executeIfPending ()
	Calls the pending-response function, if one is stored.
void	sendInactiveStatusMessages (ActivityElement &activityElement)
	Sends the messages with which an Activity reports the Inactive status to the application.
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.
void	setPendingResponse (ActivityConcept::Status status, ActivityElement &activityElement)
	Depending on the value of the StatusProperty, calls the appropriate sendMessages().

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

activityElement

The Activity element the ActivityStatusManager handles.

sendInactiveStatusMessages()

void kanzi::ActivityStatusAnimationFinishedHandler::sendInactiveStatusMessages

(

ActivityElement &

activityElement

)

Sends the messages with which an Activity reports the Inactive status to the application.

Unlike sendMessages(), does not send the internal message that tells the parent Activity Host that a deactivating animation finished. Use this when the Activity Host removes the Activity node itself and therefore waits for no such message.

Parameters

activityElement

The Activity element the ActivityStatusManager handles.

Since

Kanzi 3.9.16

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

status	Status for which messages must be sent.
activityElement	The 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:

• kanzi/ui/node/concept/activity/activity_status_animation_finished_handler.hpp