MMPXData Class Reference

class MMPXData

Base class for managing data in global heap.

mpxcommon.lib

Member Functions Documentation

AddClientRef(TUint)

voidAddClientRef(TUintaClientHandle)[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 aClientHandleclient handle to the global chunk

AddRef(TUint)

voidAddRef(TUintaClientHandle)[pure virtual]

To increment the reference count on this data.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

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

TInt Append(TUintaClientHandle,
const TMPXAttribute &aAttr,
TMPXAttributeTypeaType,
const TDesC8 &aData
)[pure virtual]

Append a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
const TMPXAttribute & aAttrmedia attribute
TMPXAttributeType aTypeobject type
const TDesC8 & aDataraw data

Attribute(TUint, TInt)

const TMPXAttribute &Attribute(TUintaClientHandle,
TIntaIndex
)[pure virtual]

Gets attribute by index.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
TInt aIndexindex of the data item

AttributeType(TUint, TInt)

TMPXAttributeType AttributeType(TUintaClientHandle,
TIntaIndex
)[pure virtual]

Gets object type by index.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
TInt aIndexindex 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(TUintaClientHandle)[pure virtual]

Returns number of data items.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

Data(TUint, TUint)

MMPXData *Data(TUintaClientHandle,
TUintaDataHandle
)[static]

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

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
TUint aDataHandledata handle to the MMPXData implementation.

Data(TUint, const TDesC8 &)

MMPXData *Data(TUintaClientHandle,
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 aClientHandleclient handle to the global chunk
const TDesC8 & aDatabuffer which contains the object of MMPXData implementation

Data(TUint, TAny *, TInt)

MMPXData *Data(TUintaClientHandle,
TAny *aData,
TIntaSize
)[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 aClientHandleclient handle to the global chunk
TAny * aDatabuffer which contains the object of MMPXData implementation
TInt aSizesize of the data buffer

DataHandle(TUint)

TUint DataHandle(TUintaClientHandle)[pure virtual]

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

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

Delete(TUint, TInt)

voidDelete(TUintaClientHandle,
TIntaIndex
)[pure virtual]

Delete a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
TInt aIndexindex of the data item

HeapMemoryInfoL(TInt &, TInt &)

voidHeapMemoryInfoL(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 & aTotalTotal size of memory (out parameter)
TInt & aUsedUsed size of memory (out parameter)

Index(TUint, const TMPXAttribute &)

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

Returns index of the data item with the media attribute.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
const TMPXAttribute & aAttrmedia attribute

Index(TUint, TInt)

TInt Index(TUintaClientHandle,
TIntaUid
)[pure virtual]

Returns index of the data item with aUid.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
TInt aUiduid of the data item

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

TInt Insert(TUintaClientHandle,
const TMPXAttribute &aAttr,
TMPXAttributeTypeaType,
const TDesC8 &aData,
TIntaIndex
)[pure virtual]

Insert a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
const TMPXAttribute & aAttrmedia attribute
TMPXAttributeType aTypeobject type
const TDesC8 & aDataraw data
TInt aIndexindex of the data item

LockHeap(TUint)

voidLockHeap(TUintaClientHandle)[static]

Lock the heap.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

NewL(TUint)

MMPXData *NewL(TUintaClientHandle)[static]

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

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

NewL(TUint, const MMPXData &)

MMPXData *NewL(TUintaClientHandle,
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 aClientHandleclient handle to the global chunk
const MMPXData & aDataexisting MMPXData implementation.

Release(TUint)

voidRelease(TUintaClientHandle)[pure virtual]

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

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

ReleaseClient(TUint)

voidReleaseClient(TUintaClientHandle)[static]

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

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

Reset(TUint)

voidReset(TUintaClientHandle)[pure virtual]

Remove all data items.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

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

voidSet(TUintaClientHandle,
const TMPXAttribute &aAttr,
TMPXAttributeTypeaType,
const TDesC8 &aData,
TIntaIndex
)[pure virtual]

Set a data item.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
const TMPXAttribute & aAttrmedia attribute
TMPXAttributeType aTypeobject type
const TDesC8 & aDataraw data
TInt aIndexindex of the data item

SetSupportedIds(TUint, const TArray< TInt > &)

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

Sets supported content ids.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
const TArray< TInt > & aSupportedIdsarray of supported content ids

SupportedIds(TUint)

TArray< TInt >SupportedIds(TUintaClientHandle)[pure virtual]

Gets supported content ids.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

Uid(TUint, TInt)

TInt Uid(TUintaClientHandle,
TIntaIndex
)[pure virtual]

Returns uid by index.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
TInt aIndexindex of the data item

UnlockHeap(TUint)

voidUnlockHeap(TUintaClientHandle)[static]

Unlock the heap.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk

Value(TUint, TInt)

TPtrC8 Value(TUintaClientHandle,
TIntaIndex
)[pure virtual]

Gets the data value by index.

Since
S60 3.2.3

Parameters

TUint aClientHandleclient handle to the global chunk
TInt aIndexindex 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