CAnimationStoryboardEventHandler Class

Implements a callback, which is called by the Animation API when the status of a storyboard is changed or a storyboard is updated.

Syntax

class CAnimationStoryboardEventHandler : public CUIAnimationStoryboardEventHandlerBase<CAnimationStoryboardEventHandler>;

Members

Public Constructors

Name Description
CAnimationStoryboardEventHandler::CAnimationStoryboardEventHandler Constructs a CAnimationStoryboardEventHandler object.

Public Methods

Name Description
CAnimationStoryboardEventHandler::CreateInstance Creates an instance of CAnimationStoryboardEventHandler callback.
CAnimationStoryboardEventHandler::OnStoryboardStatusChanged Handles OnStoryboardStatusChanged events, which occur when a storyboard's status changes (Overrides CUIAnimationStoryboardEventHandlerBase::OnStoryboardStatusChanged.)
CAnimationStoryboardEventHandler::OnStoryboardUpdated Handles OnStoryboardUpdated events, which occur when a storyboard is updated (Overrides CUIAnimationStoryboardEventHandlerBase::OnStoryboardUpdated.)
CAnimationStoryboardEventHandler::SetAnimationController Stores a pointer to animation controller to route events.

Remarks

This event handler is created and passed to IUIAnimationStoryboard::SetStoryboardEventHandler method, when you call CAnimationController::EnableStoryboardEventHandler.

Inheritance Hierarchy

CUIAnimationCallbackBase

CUIAnimationStoryboardEventHandlerBase

CAnimationStoryboardEventHandler

Requirements

Header: afxanimationcontroller.h

CAnimationStoryboardEventHandler::CAnimationStoryboardEventHandler

Constructs a CAnimationStoryboardEventHandler object.

CAnimationStoryboardEventHandler();

CAnimationStoryboardEventHandler::CreateInstance

Creates an instance of CAnimationStoryboardEventHandler callback.

static COM_DECLSPEC_NOTHROW HRESULT CreateInstance(
    CAnimationController* pAnimationController,
    IUIAnimationStoryboardEventHandler** ppHandler);

Parameters

pAnimationController
A pointer to animation controller, which will receive events.

ppHandler

Return Value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

CAnimationStoryboardEventHandler::OnStoryboardStatusChanged

Handles OnStoryboardStatusChanged events, which occur when a storyboard's status changes

IFACEMETHOD(OnStoryboardStatusChanged) (
    __in IUIAnimationStoryboard* storyboard,
    __in UI_ANIMATION_STORYBOARD_STATUS newStatus,
    __in UI_ANIMATION_STORYBOARD_STATUS previousStatus);

Parameters

storyboard
A pointer to storyboard whose status has changed.

newStatus
Specifies new storyboard status.

previousStatus
Specifies previous storyboard status.

Return Value

S_OK if the method succeeds; otherwise E_FAIL.

CAnimationStoryboardEventHandler::OnStoryboardUpdated

Handles OnStoryboardUpdated events, which occur when a storyboard is updated

IFACEMETHOD(OnStoryboardUpdated) (__in IUIAnimationStoryboard* storyboard);

Parameters

storyboard
A pointer to storyboard, which was updated.

Return Value

S_OK if the method succeeds; otherwise E_FAIL.

CAnimationStoryboardEventHandler::SetAnimationController

Stores a pointer to animation controller to route events.

void SetAnimationController(CAnimationController* pAnimationController);

Parameters

pAnimationController
A pointer to animation controller, which will receive events.

See also

Classes