Collapse all Symbian^3 Application Developer Library

MSgImageCollectionAdapter Class Reference

class MSgImageCollectionAdapter : public MSgResourceAdapter

This interface must be implemented by all the user-side objects in the adaptation layer of the Graphics subsystem which are referenced by instances of RSgImageCollection . The interface between the user-side and the kernel-side parts of the adaptation layer is outside the scope of the specification of the Graphics Resource API.

RSgImageCollection

Inherits from

MSgImageCollectionAdapter
- MSgResourceAdapter

Public Member Functions
TInt	Count ()
TInt	GetInfo ( TSgImageInfo &)
TInt	OpenImage ( TInt , MSgDrawableAdapter *&)
const TSurfaceId &	SurfaceId ()

Member Functions Documentation

Count()

TInt

Count

(

)

const [pure virtual]

Retrieves the number of images in the image collection represented by this adapter object.

RSgImageCollection::Count()

GetInfo(TSgImageInfo &)

TInt

GetInfo

(

TSgImageInfo &

aInfo

)

const [pure virtual]

Retrieves the values of the attributes of the images in the image collection represented by this adapter object.

Pre-condition: If aInfo.iUserAttributes is not null then it points to an array of aInfo.iUserAttributeCount elements with globally unique identifiers corresponding to user-defined attributes attached to the image collection.

RSgImageCollection::GetInfo()

Parameters

TSgImageInfo & aInfo

On input, the globally unique identifiers of the user-defined attributes to be retrieved from the image collection, if any. On return, the values of the attributes of the images in the collection and the values of the selected user-defined attributes.

OpenImage(TInt, MSgDrawableAdapter *&)

TInt	OpenImage	(	TInt	aIndex,
			MSgDrawableAdapter *&	aResult
		)	[pure virtual]

Opens a new handle to one of the images in the image collection represented by this adapter object. If there are no handles to the image open in the calling process then this function creates a new adapter object that represents the image in the context of the calling process. Otherwise this function just increments the reference count of the existing adapter object that represents the image in the context of the calling process.

Pre-condition: aIndex is greater than or equal to zero and less than the number of images in the collection.; aResult is null.

Post-condition: aResult points to either a newly created or an existing adapter object that represents the specified image in the collection. If a new adapter object is created then its initial reference count is one and the reference count for the image collection is incremented by one. Otherwise only the reference count for the adapter object is incremented by one.

RSgImageCollection::OpenImage()

Parameters

TInt aIndex	The index of the image within the image collection.
MSgDrawableAdapter *& aResult	On return, a pointer to the adapter object that represents the specified image in the collection.

SurfaceId()

const TSurfaceId &

SurfaceId

(

)

const [pure virtual]

Retrieves the surface identifier of the image collection represented by this adapter object.

RSgImageCollection::SurfaceId()