1.1 --- a/epoc32/include/gfxtranseffect/gfxtransadapter.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,123 +0,0 @@
1.4 -// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 -// All rights reserved.
1.6 -// This component and the accompanying materials are made available
1.7 -// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 -// which accompanies this distribution, and is available
1.9 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 -//
1.11 -// Initial Contributors:
1.12 -// Nokia Corporation - initial contribution.
1.13 -//
1.14 -// Contributors:
1.15 -//
1.16 -// Description:
1.17 -//
1.18 -
1.19 -#ifndef _GFXTRANSADAPTERADAPTER_H_
1.20 -#define _GFXTRANSADAPTERADAPTER_H_
1.21 -
1.22 -#include <gfxtranseffect/gfxtransclient.h>
1.23 -
1.24 -//class CTransitionControl;
1.25 -
1.26 -/**
1.27 - This is the abstract interface of a transition adapter.
1.28 - The transition engine vendor implements this interface to serve transitions.
1.29 - The implementation is a static interface dll with two exports,
1.30 - at ordinal 1, MGfxTransAdapter::CreateL() to create an adapter adapter and
1.31 - at ordinal 2, MGfxTransAdapter::Destroy() to destroy it.
1.32 - */
1.33 -class MGfxTransAdapter
1.34 - {
1.35 -public: //DLL Interface
1.36 - IMPORT_C static MGfxTransAdapter* CreateL(MGfxTransClient* aProvider);
1.37 - IMPORT_C static void Destroy(MGfxTransAdapter* aAdapter);
1.38 -public: //Adapter Interface.
1.39 - enum TClientState
1.40 - {
1.41 - EPreBeginCapture,
1.42 - EPostBeginCapture,
1.43 - EPreEndCapture,
1.44 - EPostEndCapture,
1.45 - EAbort,
1.46 - EGlobalAbort,
1.47 - EBeginGroup,
1.48 - EEndGroup,
1.49 - EFallback,
1.50 - };
1.51 - /**
1.52 - Handles a specific client state.
1.53 - @param aState a client state to handle
1.54 - @param aKey the registered control, NULL if not valid
1.55 - @param aHandle handle to the transition in progress, 0 if not valid.
1.56 - */
1.57 - virtual TInt HandleClientState(TClientState aState, const CCoeControl* aKey, TInt aHandle) = 0;
1.58 -
1.59 - /**
1.60 - Handles an update to a transition participant during transition animation.
1.61 - Is called by the client if new draw commands arrive after End, but before MGfxTransClient::TransitionFinished()
1.62 - has been called.
1.63 - @param aHandle handle to the transition.
1.64 - @param aParticipantId the id of the participant that was updated.
1.65 - @param aDrawRect
1.66 - @param aBoundingRect
1.67 - */
1.68 - virtual void HandleParticpantUpdate(TInt aHandle, const CParticipantData* aParticipant, RWsGraphicMsgBuf* aCommandBuffer, const TRect& aDrawRect, const TRect& aBoundingRect) = 0;
1.69 -
1.70 - /**
1.71 -
1.72 - @return ETrue if the adapter is ready to serve transitions.
1.73 - */
1.74 - virtual TBool IsActive() = 0;
1.75 -
1.76 - /**
1.77 - Returns the current set of transition policies.
1.78 - The engine might choose to return NULL and push all policies through MGfxTransClient::TransitionPolicyUpdate()
1.79 - @param aCount on return, contains the number of policies returned.
1.80 - @return an array of TControlPolicy pointers. caller takes responsibility for cleanup.
1.81 - */
1.82 - virtual TControlPolicy* GetTransitionPolicies(TInt &aCount) = 0;
1.83 -
1.84 - /**
1.85 - A notify of external state change.
1.86 - Same as the API function, is passed straight from the client.
1.87 - @param aState the user supplied state
1.88 - @param aArg optional arguments or NULL if not used.
1.89 - */
1.90 - virtual void NotifyExternalState(TInt aState, const TDesC8* aArg) = 0;
1.91 -
1.92 - /**
1.93 - Requests a transition finished event.
1.94 - This MUST result in a later call to MGfxTransClient::TransitionFinished().
1.95 - It can be called immediatly if adapter does not need to handle this.
1.96 - */
1.97 - virtual void StartTransition(TInt aHandle) = 0;
1.98 -
1.99 - /**
1.100 - Tells the engine to start a full screen effect.
1.101 - @param aAction Effect identifier
1.102 - @param aEffectArea the part of the framebuffer to be affected
1.103 - */
1.104 - virtual void BeginFullScreen(TUint aAction, const TRect &aEffectArea) = 0;
1.105 - /**
1.106 - Tells the engine to start a full screen effect.
1.107 - @param aAction Effect identifier
1.108 - @param aEffectArea the part of the framebuffer to be affected
1.109 - @param aType the type of the parameters.
1.110 - @param aParam the parameters.
1.111 - */
1.112 - virtual void BeginFullScreen(TUint aAction, const TRect &aEffectArea, TUint aType, const TDesC8& aParams) = 0;
1.113 -
1.114 - /**
1.115 - Informs the engine of the endpoint of a fullscreen effect.
1.116 - */
1.117 - virtual void EndFullScreen() = 0;
1.118 -
1.119 - /**
1.120 - Tells the engine to abort a fullscreen effect.
1.121 - */
1.122 - virtual void AbortFullScreen() = 0;
1.123 - };
1.124 -
1.125 -
1.126 -#endif