Symbian^3 Application Developer Library >

MMPXData Class Reference

class MMPXData

Base class for managing data in global heap.

mpxcommon.lib

Public Member Functions
void AddClientRef ( TUint )
void AddRef ( TUint )
TInt Append ( TUint , const TMPXAttribute &, TMPXAttributeType , const TDesC8 &)
const TMPXAttribute & Attribute ( TUint , TInt )
TMPXAttributeType AttributeType ( TUint , TInt )
TUint ClientHandle ()
TInt Count ( TUint )
MMPXData * Data ( TUint , TUint )
MMPXData * Data ( TUint , const TDesC8 &)
MMPXData * Data ( TUint , TAny *, TInt )
TUint DataHandle ( TUint )
void Delete ( TUint , TInt )
void HeapMemoryInfoL ( TInt &, TInt &)
TInt Index ( TUint , const TMPXAttribute &)
TInt Index ( TUint , TInt )
TInt Insert ( TUint , const TMPXAttribute &, TMPXAttributeType , const TDesC8 &, TInt )
void LockHeap ( TUint )
MMPXData * NewL ( TUint )
MMPXData * NewL ( TUint , const MMPXData &)
void Release ( TUint )
void ReleaseClient ( TUint )
void Reset ( TUint )
void Set ( TUint , const TMPXAttribute &, TMPXAttributeType , const TDesC8 &, TInt )
TInt SetSupportedIds ( TUint , const TArray < TInt > &)
TArray < TInt > SupportedIds ( TUint )
TInt Uid ( TUint , TInt )
void UnlockHeap ( TUint )
TPtrC8 Value ( TUint , TInt )
Public Member Enumerations
enum TMPXObjectType { EMedia  = 0x12343219, EMediaArray  = 0x987678ab, EPath  = 0x567982fe }

Member Functions Documentation

AddClientRef(TUint)

void AddClientRef ( TUint aClientHandle ) [static]

To increment the reference count for this client (thread); should be called for every media/media array object that is not contained within another.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

AddRef(TUint)

void AddRef ( TUint aClientHandle ) [pure virtual]

To increment the reference count on this data.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

Append(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &)

TInt Append ( TUint aClientHandle,
const TMPXAttribute & aAttr,
TMPXAttributeType aType,
const TDesC8 & aData
) [pure virtual]

Append a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
const TMPXAttribute & aAttr media attribute
TMPXAttributeType aType object type
const TDesC8 & aData raw data

Attribute(TUint, TInt)

const TMPXAttribute & Attribute ( TUint aClientHandle,
TInt aIndex
) [pure virtual]

Gets attribute by index.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TInt aIndex index of the data item

AttributeType(TUint, TInt)

TMPXAttributeType AttributeType ( TUint aClientHandle,
TInt aIndex
) [pure virtual]

Gets object type by index.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TInt aIndex index of the data item

ClientHandle()

TUint ClientHandle ( ) [static]

Handle which represents the current client (thread). This should be stored by the client and provided in all methods; zero indicates that it has failed.

Since
S60 3.2.3

Count(TUint)

TInt Count ( TUint aClientHandle ) [pure virtual]

Returns number of data items.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

Data(TUint, TUint)

MMPXData * Data ( TUint aClientHandle,
TUint aDataHandle
) [static]

Obtain the interface of an existing implementation from the handle. This is thread-relative.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TUint aDataHandle data handle to the MMPXData implementation.

Data(TUint, const TDesC8 &)

MMPXData * Data ( TUint aClientHandle,
const TDesC8 & aData
) [static]

Obtain the interface from a buffer, or NULL if the buffer does not contain an implementation of the interface.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
const TDesC8 & aData buffer which contains the object of MMPXData implementation

Data(TUint, TAny *, TInt)

MMPXData * Data ( TUint aClientHandle,
TAny * aData,
TInt aSize
) [static]

Obtains the interface from a buffer, or NULL if the buffer does not contain an implementation of the interface.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TAny * aData buffer which contains the object of MMPXData implementation
TInt aSize size of the data buffer

DataHandle(TUint)

TUint DataHandle ( TUint aClientHandle ) [pure virtual]

Handle to the object implementing this interface; can be used to reference the object.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

Delete(TUint, TInt)

void Delete ( TUint aClientHandle,
TInt aIndex
) [pure virtual]

Delete a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TInt aIndex index of the data item

HeapMemoryInfoL(TInt &, TInt &)

void HeapMemoryInfoL ( TInt & aTotal,
TInt & aUsed
) [static]

Gets the total size and the currently used size of the global heap.

Since
S60 3.2.3

Parameters

TInt & aTotal Total size of memory (out parameter)
TInt & aUsed Used size of memory (out parameter)

Index(TUint, const TMPXAttribute &)

TInt Index ( TUint aClientHandle,
const TMPXAttribute & aAttr
) [pure virtual]

Returns index of the data item with the media attribute.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
const TMPXAttribute & aAttr media attribute

Index(TUint, TInt)

TInt Index ( TUint aClientHandle,
TInt aUid
) [pure virtual]

Returns index of the data item with aUid.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TInt aUid uid of the data item

Insert(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &, TInt)

TInt Insert ( TUint aClientHandle,
const TMPXAttribute & aAttr,
TMPXAttributeType aType,
const TDesC8 & aData,
TInt aIndex
) [pure virtual]

Insert a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
const TMPXAttribute & aAttr media attribute
TMPXAttributeType aType object type
const TDesC8 & aData raw data
TInt aIndex index of the data item

LockHeap(TUint)

void LockHeap ( TUint aClientHandle ) [static]

Lock the heap.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

NewL(TUint)

MMPXData * NewL ( TUint aClientHandle ) [static]

Create a new implementation of the MMPXData interface. This is thread- relative.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

NewL(TUint, const MMPXData &)

MMPXData * NewL ( TUint aClientHandle,
const MMPXData & aData
) [static]

Create a new implementation from an existing MMPXData implementation. This is an duplicate copy of the original. This is thread-relative.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
const MMPXData & aData existing MMPXData implementation.

Release(TUint)

void Release ( TUint aClientHandle ) [pure virtual]

To decrement the reference count on this data; when zero, the data is deleted.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

ReleaseClient(TUint)

void ReleaseClient ( TUint aClientHandle ) [static]

To decrement the reference count on this this client (thread).

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

Reset(TUint)

void Reset ( TUint aClientHandle ) [pure virtual]

Remove all data items.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

Set(TUint, const TMPXAttribute &, TMPXAttributeType, const TDesC8 &, TInt)

void Set ( TUint aClientHandle,
const TMPXAttribute & aAttr,
TMPXAttributeType aType,
const TDesC8 & aData,
TInt aIndex
) [pure virtual]

Set a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
const TMPXAttribute & aAttr media attribute
TMPXAttributeType aType object type
const TDesC8 & aData raw data
TInt aIndex index of the data item

SetSupportedIds(TUint, const TArray< TInt > &)

TInt SetSupportedIds ( TUint aClientHandle,
const TArray < TInt > & aSupportedIds
) [pure virtual]

Sets supported content ids.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
const TArray < TInt > & aSupportedIds array of supported content ids

SupportedIds(TUint)

TArray < TInt > SupportedIds ( TUint aClientHandle ) [pure virtual]

Gets supported content ids.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

Uid(TUint, TInt)

TInt Uid ( TUint aClientHandle,
TInt aIndex
) [pure virtual]

Returns uid by index.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TInt aIndex index of the data item

UnlockHeap(TUint)

void UnlockHeap ( TUint aClientHandle ) [static]

Unlock the heap.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk

Value(TUint, TInt)

TPtrC8 Value ( TUint aClientHandle,
TInt aIndex
) [pure virtual]

Gets the data value by index.

Since
S60 3.2.3

Parameters

TUint aClientHandle client handle to the global chunk
TInt aIndex index of the data item

Member Enumerations Documentation

Enum TMPXObjectType

Defines 'markers' that identify objects from their streamed buffers, e.g. if the first 4 bytes of an externalized object constitute the value EMedia, then we assume the it is an externalized media object.

Enumerators

EMedia = 0x12343219
EMediaArray = 0x987678ab
EPath = 0x567982fe

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.