Symbian^3 Application Developer Library >

MAlfTransEffectPlugin Class Reference

class MAlfTransEffectPlugin

This interface class is implmented by plugins for Alf transition effect framework

Public Member Functions
~MAlfTransEffectPlugin ()
TInt Abort ()
TInt AddEventObserver ( MAlfTransEffectObserver *, TInt , const TDesC8 *)
TInt GetEventState ( TInt , TInt *, TDes8 *)
TInt GetSupportedEffects ( RArray < TInt > &)
MAlfTransEffectPlugin * NewExtensionL ( TUid )
TInt RemoveEventObserver ( MAlfTransEffectObserver *, TInt )
TInt StartPhase ( TInt , TInt , CAlfSrvEffectEnv &, const TDesC8 *)
Public Member Enumerations
enum TContext {
EContextNone , EContextFocusGained , EContextFocusLost , EContextStart , EContextExit , EContextEmbeddedStart , EContextEmbeddedExit
}
enum TPhase { EPhaseNone , EFirstPhase , ESecondPhase }
enum TReturnParameterTypes { }
Public Attributes
TUid iDtor_ID_Key

Constructor & Destructor Documentation

~MAlfTransEffectPlugin()

~MAlfTransEffectPlugin ( ) [inline, virtual]
Virtual destructor.
Since
2.8

Member Functions Documentation

Abort()

TInt Abort ( ) [pure virtual]

Not yet implemented

AddEventObserver(MAlfTransEffectObserver *, TInt, const TDesC8 *)

TInt AddEventObserver ( MAlfTransEffectObserver * aObserver,
TInt aEvents,
const TDesC8 * aParams = NULL
) [pure virtual]

Not yet implemented

Parameters

MAlfTransEffectObserver * aObserver
TInt aEvents
const TDesC8 * aParams = NULL

GetEventState(TInt, TInt *, TDes8 *)

TInt GetEventState ( TInt aEvent,
TInt * aState,
TDes8 * aParams = NULL
) [pure virtual]

Not yet implemented

Parameters

TInt aEvent
TInt * aState
TDes8 * aParams = NULL

GetSupportedEffects(RArray< TInt > &)

TInt GetSupportedEffects ( RArray < TInt > & aSupportedEffectIds ) [pure virtual]

Get all effect IDs that are supported.

Parameters

RArray < TInt > & aSupportedEffectIds Array of supported effect IDs.

NewExtensionL(TUid)

MAlfTransEffectPlugin * NewExtensionL ( TUid aImplementationUid ) [static]

Creates the plugin implementation.

Parameters

TUid aImplementationUid UID of the effect plugin implementation.

RemoveEventObserver(MAlfTransEffectObserver *, TInt)

TInt RemoveEventObserver ( MAlfTransEffectObserver * aObserver,
TInt aEvents
) [pure virtual]

Not yet implemented

Parameters

MAlfTransEffectObserver * aObserver
TInt aEvents

StartPhase(TInt, TInt, CAlfSrvEffectEnv &, const TDesC8 *)

TInt StartPhase ( TInt aPhaseId,
TInt aEffectId,
CAlfSrvEffectEnv & aEffectEnv,
const TDesC8 * aParams = NULL
) [pure virtual]

Starts a new phase in the effect.

Parameters

TInt aPhaseId Phase that is started.
TInt aEffectId Effect ID.
CAlfSrvEffectEnv & aEffectEnv Effect environment for this session.
const TDesC8 * aParams = NULL Other parameters.

Member Enumerations Documentation

Enum TContext

System effect contexts

Enumerators

EContextNone
EContextFocusGained
EContextFocusLost
EContextStart
EContextExit
EContextEmbeddedStart
EContextEmbeddedExit

Enum TPhase

Default phase numbers for the effects

Enumerators

EPhaseNone
EFirstPhase
ESecondPhase

Enum TReturnParameterTypes

Types of data that may be returned by CAlfGfxEffects::HandleMessageL The caller

Member Data Documentation

TUid iDtor_ID_Key

TUid iDtor_ID_Key

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.