Symbian^3 Application Developer Library >

MExtensionCallbackInterface Class Reference

class MExtensionCallbackInterface

Main callback interface implemented in the engine. The extension uses this interface to add to and remove own interface implementations from the engine lists. Also, pointers to the callback interfaces implemented in the engine, can be fetched. The extension usually calls this interface during creation.

Public Member Functions
TInt AddCustomInterface ( TUid , TAny *)
TInt AddExtensionInterface ( TUid , TUid , TAny *, TInt )
void DeregisterFlags ( TUint32 )
TAny * GetCallbackInterface ( TUid )
TBool IsInterfaceSupported ( TUid )
void RegisterFlags ( TUint32 )
TInt RemoveExtensionInterface ( TUid , TAny *)

Member Functions Documentation

AddCustomInterface(TUid, TAny *)

TInt AddCustomInterface ( TUid aInterfaceUid,
TAny * aImplementationPtr
) [pure virtual]
Add an extension implemented custom interface to the list in engine. The custom interface is not called by the engine. It is called by the application. The engine gives the pointer to the application when requested. Note that there is no remove method for a custom interface because there is not specified a way to tell to the application when the interface had been removed.
Since
2.8

Parameters

TUid aInterfaceUid Specific uid for the interface.
TAny * aImplementationPtr

AddExtensionInterface(TUid, TUid, TAny *, TInt)

TInt AddExtensionInterface ( TUid aInterfaceUid,
TUid aExtensionUid,
TAny * aImplementationPtr,
TInt aInitialPriority = 0
) [pure virtual]
Add an extension implemented interface to the list in engine. The engine starts to call this interface.
Since
2.8

Parameters

TUid aInterfaceUid Uid for the interface.
TUid aExtensionUid Uid for the extension that implements the interface.
TAny * aImplementationPtr
TInt aInitialPriority = 0

DeregisterFlags(TUint32)

void DeregisterFlags ( TUint32 aFlags ) [pure virtual]
Deregister flags which have been registered before. It is not allowed to deregister flags that have not been registered earlier.
Since
2.8

Parameters

TUint32 aFlags Flags to deregister.

GetCallbackInterface(TUid)

TAny * GetCallbackInterface ( TUid aInterfaceUid ) [pure virtual]
Get an engine implemented callback interface. An extension can call this interface.
Since
2.8

Parameters

TUid aInterfaceUid Specific uid for the interface.

IsInterfaceSupported(TUid)

TBool IsInterfaceSupported ( TUid aInterfaceUid ) [pure virtual]
Check that the interface is supported by the engine.
Since
2.8

Parameters

TUid aInterfaceUid Uid for the interface.

RegisterFlags(TUint32)

void RegisterFlags ( TUint32 aFlags ) [pure virtual]
Register flags which affect general extension handling in the engine. Flags must be deregisterd when no longer needed as they can affect to the engine performance. Each registered flag must be deregistered, and only once. All the flags that are in registered state when the class is deleted, must be deregistered in the class destructor method.
Since
2.8

Parameters

TUint32 aFlags Flags to register.

RemoveExtensionInterface(TUid, TAny *)

TInt RemoveExtensionInterface ( TUid aInterfaceUid,
TAny * aImplementationPtr
) [pure virtual]
Remove an extension implemented interface from the list in engine. The engine stops calling this interface.
Since
2.8

Parameters

TUid aInterfaceUid Uid for the interface.
TAny * aImplementationPtr

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.