ContentAccess::CEmbeddedObject Class Reference

#include <caf/embeddedobject.h>

Link against: cafutils.lib

class ContentAccess::CEmbeddedObject : public CBase

Inherits from

ContentAccess::CEmbeddedObject

Public Member Functions
virtual	~CEmbeddedObject()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C const TDesC8 &	MimeType()
IMPORT_C const TDesC &	Name()
IMPORT_C CEmbeddedObject *	NewL(const TDesC &, const TDesC &, const TDesC8 &, TEmbeddedType)
IMPORT_C CEmbeddedObject *	NewL(const TDesC &, const TDesC8 &, TEmbeddedType)
IMPORT_C CEmbeddedObject *	NewL(RReadStream &)
IMPORT_C TEmbeddedType	Type()
IMPORT_C const TDesC &	UniqueId()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Represents a content object embedded within a file The agent defined uniqueId field describes the location of the object within the file.

Constructor & Destructor Documentation

~CEmbeddedObject ( )

~CEmbeddedObject

(

)

[virtual]

destructor

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Allow the class write itself out to a stream

Parameter	Description
aStream	The stream to write to

MimeType ( )

IMPORT_C const TDesC8 &

MimeType

(

)

const

Mime type of the object

Returns: The mime type of the object or KNullDesC8() if this is a container object

Name ( )

IMPORT_C const TDesC &

Name

(

)

const

User friendly name of the object

Returns: The name of the object

NewL ( const TDesC &, const TDesC &, const TDesC8 &, TEmbeddedType )

IMPORT_C CEmbeddedObject *	NewL	(	const TDesC &	aUniqueId,
			const TDesC &	aName,
			const TDesC8 &	aMimeType,
			TEmbeddedType	aType
		)	[static]

Create a new CEmbeddedObject with a different name and uniqueId

Parameter	Description
aUniqueId	The UniqueId of the embedded object
aName	A user friendly name for the object
aMimeType	The mime type of the object (if it not a container object)
aType	The type of object (Content, container, agentspecific etc)

Returns: a CEmbeddedObject

NewL ( const TDesC &, const TDesC8 &, TEmbeddedType )

IMPORT_C CEmbeddedObject *	NewL	(	const TDesC &	aUniqueId,
			const TDesC8 &	aMimeType,
			TEmbeddedType	aType
		)	[static]

Create a new CEmbeddedObject where the Name field is the same as the uniqueId

Parameter	Description
aUniqueId	The UniqueId of the embedded object
aMimeType	The mime type of the object (if it not a container object)
aType	The type of object (Content, container, agentspecific etc)

Returns: a CEmbeddedObject

NewL ( RReadStream & )

IMPORT_C CEmbeddedObject *

NewL

(

RReadStream &

aStream

)

[static]

Create a new CEmbeddedObject from a stream

Parameter	Description
aStream	The stream to read the CEmbeddedObject from

Returns: a CEmbeddedObject

Type ( )

IMPORT_C TEmbeddedType

Type

(

)

const

The type of object

Returns: The type

UniqueId ( )

IMPORT_C const TDesC &

UniqueId

(

)

const

The agent defined UniqueId

Returns: The uniqueId