COpenWfcStreamMap Class Reference

#include "streammap.h"

Link against: wfcinterop.lib

class COpenWfcStreamMap : public CBase

Inherits from

  • COpenWfcStreamMap

    Constructor & Destructor Documentation

    COpenWfcStreamMap ( )

    COpenWfcStreamMap()[protected]

    Constructor

    ~COpenWfcStreamMap ( )

    ~COpenWfcStreamMap()[protected]

    Destructor.

    Member Function Documentation

    AcquireL ( const TSurfaceId & )

    CSurfaceStream *AcquireL(const TSurfaceId &aSurfaceId)

    Look up a specified TSurfaceId key in the associative array and return a pointer to the corresponding to a native stream. The reference of the native stream is incremented by one. If no native stream is found a new native stream instance is created.

    ParameterDescription
    aSurfaceIdThe TSurfaceId key to look up

    Returns: A pointer to the corresponding native stream, if the specified TSurfacId was found NULL if the look up did not succeed

    Count ( )

    IMPORT_C TIntCount()

    Query the number of elements stored in the stream hash map.

    Returns: The number of the key-value pairs stored

    Find ( const TSurfaceId & )

    CSurfaceStream *Find(const TSurfaceId &aSurfaceId)

    Look up a specified TSurfaceId key in the associative array and return a pointer to the corresponding to a native stream. The reference counter of the native stream is incremented by one.

    ParameterDescription
    aSurfaceIdThe TSurfaceId key to look up

    Returns: A pointer to the corresponding native stream, if the specified TSurfacId was found NULL if the look up did not succeed

    GetMainHeap ( )

    IMPORT_C RHeap *GetMainHeap()

    Returns a pointer to the main heap

    Returns: A pointer to the main heap

    InstanceL ( )

    IMPORT_C COpenWfcStreamMap &InstanceL()[static]

    Returns a reference to the singleton instance.

    Returns: The pointer to the singleton instance

    LockDestroy ( CSurfaceStream * )

    TInt LockDestroy(CSurfaceStream *aStream)[protected]

    Destroys the specified native stream IF the native stream reference counter is zero. The counter reference of the native stream is tested prior its destruction and if positive the destruction will not happen

    ParameterDescription
    aStreamThe stream to be destroyed

    Returns: KErrNone if the native stream is removed KErrArgument if the parameter is invalid KErrInUse if the stream has a owner KErrNotFound if the TSurfaceId key was not found

    RegisterScreenNotifications ( TInt, TInt, TInt )

    TInt RegisterScreenNotifications(TIntaScreenNum,
    TIntaPriority,
    TIntaInternalVersion
    )

    Register a screen number for surface update notifications.

    ParameterDescription
    aScreenNumThe screen for which we enable the notification mechanism
    aPriorityThe internal version

    Returns: KErrNone if operation is completed successfully

    RegisteredScreenNotifications ( TInt )

    CExtensionContainer *RegisteredScreenNotifications(TIntaScreenNum)

    Retieves the screen updater associate with the specified screen

    ParameterDescription
    aScreenNumThe screen number

    Returns: Pointer to screen updater id successful or NULL otherwise

    Reserve ( TInt )

    IMPORT_C TIntReserve(TIntaExpand)

    Expands the array to accommodate a specified number of key-value pairs. If the hash map already has enough space for the specified number of elements, no action is taken. Any elements already in the map are retained.

    ParameterDescription
    aExpandThe number of key-value pairs for which space should be allocated.

    Returns: KErrNone if the operation completed aInternalVersion. KErrNoMemory if sufficient memory could not be allocated.

    SetMainHeap ( )

    voidSetMainHeap()

    Sets the main heap

    SurfaceManager ( )

    RSurfaceManager &SurfaceManager()

    Returns a reference to the surface manager.

    Returns: A reference to the local SurfaceManager

    UnregisterScreenNotifications ( TInt )

    TInt UnregisterScreenNotifications(TIntaScreenNum)

    Unregister the screen updater

    ParameterDescription
    aScreenNumThe screen number

    Returns: KErrNone if operation is completed successfully