Collapse all Symbian^3 Application Developer Library

CMsgAttachmentInfo Class Reference

class CMsgAttachmentInfo : public CBase

Attachment information node.

Inherits from

CMsgAttachmentInfo
- CBase

Public Member Functions
	~CMsgAttachmentInfo ()
IMPORT_C TMsvAttachmentId	AttachmentId ()
void	ChangeSizeAndIconL ()
TInt	CharacterSet ()
IMPORT_C TInt	DRMDataType ()
IMPORT_C const TDataType &	DataType ()
IMPORT_C const TFileName &	FileName ()
IMPORT_C CGulIcon *	Icon ()
IMPORT_C TBool	IsAttachedThisSession ()
TBool	IsEmptyAttachment ()
IMPORT_C TBool	IsFetched ()
IMPORT_C TBool	IsSaved ()
IMPORT_C TBool	IsSeparator ()
IMPORT_C TBool	IsSupported ()
CMsgAttachmentInfo *	NewL ( CMsgAttachmentModel &, const TFileName &, TInt , TBool , TBool , TMsvAttachmentId , const TDataType &, TDRMDataType )
IMPORT_C void	SetAttachedThisSession ( TBool )
IMPORT_C void	SetAttachmentId ( TMsvAttachmentId )
void	SetCharacterSet ( TInt )
IMPORT_C void	SetDRMDataType ( TDRMDataType )
IMPORT_C void	SetDataType (const TDataType &)
void	SetEmptyAttachment ( TBool )
IMPORT_C void	SetFetched ( TBool )
IMPORT_C void	SetFileName (const TFileName &)
IMPORT_C void	SetSaved ( TBool )
IMPORT_C void	SetSeparator ( TBool )
IMPORT_C void	SetSupported ( TBool )
IMPORT_C TInt	Size ()
IMPORT_C TBuf < KMsgAttaSizeStringLength >	SizeString ()

Protected Member Functions
	CMsgAttachmentInfo ( CMsgAttachmentModel &, const TFileName &, TInt , TBool , TBool )
IMPORT_C void	ConstructL (const TDataType &, TDRMDataType )

Private Member Functions
void	DoUpdateIconL ()

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()

Public Member Enumerations
enum	TDRMDataType { ENoLimitations = 0, EForwardLockedOrCombinedDelivery , ESeparateDeliveryValidRights , ECombinedDeliveryInvalidRights , ESeparateDeliveryInvalidRights }

Private Member Enumerations
enum	TAttachmentInfoFlags { EAttachmentNoFlagsSet = 0x00000000, EAttachmentFetched = 0x00000001, EAttachedThisSession = 0x00000002, EAttachmentSupported = 0x00000004, ESeparatorBefore = 0x00000008, EAttachmentSaved = 0x00000010, EEmptyAttachment = 0x00000020 }

Private Attributes
TInt	iAttachmentFlags
TMsvAttachmentId	iAttachmentId
CMsgAttachmentModel &	iAttachmentModel
TInt	iCharset
TDRMDataType	iDRMDataType
TDataType	iDataType
TFileName	iFileName
CGulIcon *	iIcon
TInt	iSize
TBuf < KMsgAttaSizeStringLength >	iSizeString

Constructor & Destructor Documentation

CMsgAttachmentInfo(CMsgAttachmentModel &, const TFileName &, TInt, TBool, TBool)

IMPORT_C	CMsgAttachmentInfo	(	CMsgAttachmentModel &	aAttachmentModel,
			const TFileName &	aFileName,
			TInt	aSize,
			TBool	aFetched,
			TBool	aAttachedThisSession
		)	[protected]

Constructor.

Parameters

CMsgAttachmentModel & aAttachmentModel
const TFileName & aFileName
TInt aSize
TBool aFetched
TBool aAttachedThisSession

~CMsgAttachmentInfo()

IMPORT_C

~CMsgAttachmentInfo

(

)

Destructor.

Member Functions Documentation

AttachmentId()

IMPORT_C TMsvAttachmentId

AttachmentId

(

)

const

Returns the id of this attachment.

ChangeSizeAndIconL()

void

ChangeSizeAndIconL

(

)

Updates size and icon.

CharacterSet()

TInt

CharacterSet

(

)

const [inline]

Returns character set of text attachment.

ConstructL(const TDataType &, TDRMDataType)

IMPORT_C void	ConstructL	(	const TDataType &	aDataType,
			TDRMDataType	aDRMDataType
		)	[protected]

2nd phase constructor.

Parameters

const TDataType & aDataType
TDRMDataType aDRMDataType

DRMDataType()

IMPORT_C TInt

DRMDataType

(

)

const

Returns the DRM (digital rights management) status of this attachment.

DataType()

IMPORT_C const TDataType &

DataType

(

)

const

Returns the datatype (MIME type) of this attachment.

DoUpdateIconL()

void

DoUpdateIconL

(

)

[private]

Performs icon updating.

FileName()

IMPORT_C const TFileName &

FileName

(

)

const

Returns reference to the filename this attachment represents.

Icon()

IMPORT_C CGulIcon *

Icon

(

)

const

Get icon of this attachment.

IsAttachedThisSession()

IMPORT_C TBool

IsAttachedThisSession

(

)

const

Returns ETrue if this attachment was attached in this session.

IsEmptyAttachment()

TBool

IsEmptyAttachment

(

)

[inline]

Returns whether attachment is empty.

IsFetched()

IMPORT_C TBool

IsFetched

(

)

const

Returns ETrue if this attachment is fetched.

IsSaved()

IMPORT_C TBool

IsSaved

(

)

const

Returns status information whether this attachment has been saved into file system

IsSeparator()

IMPORT_C TBool

IsSeparator

(

)

const

Return separator flag.

IsSupported()

IMPORT_C TBool

IsSupported

(

)

const

Returns supported flag.

NewL(CMsgAttachmentModel &, const TFileName &, TInt, TBool, TBool, TMsvAttachmentId, const TDataType &, TDRMDataType)

CMsgAttachmentInfo *	NewL	(	CMsgAttachmentModel &	aAttachmentModel,
			const TFileName &	aFileName,
			TInt	aSize,
			TBool	Fetched,
			TBool	aAttachedThisSession,
			TMsvAttachmentId	aAttachmentId,
			const TDataType &	aDataType,
			TDRMDataType	aDRMDataType
		)	[static]

Factory method that creates this object.

Parameters

CMsgAttachmentModel & aAttachmentModel
const TFileName & aFileName
TInt aSize
TBool Fetched
TBool aAttachedThisSession
TMsvAttachmentId aAttachmentId
const TDataType & aDataType
TDRMDataType aDRMDataType

SetAttachedThisSession(TBool)

IMPORT_C void

SetAttachedThisSession

(

TBool

aFlag

)

Sets flag which tells if this attachment is attached in this session.

Parameters

TBool aFlag

SetAttachmentId(TMsvAttachmentId)

IMPORT_C void

SetAttachmentId

(

TMsvAttachmentId

aId

)

Sets the id of this attachment.

Parameters

TMsvAttachmentId aId

SetCharacterSet(TInt)

void

SetCharacterSet

(

TInt

aCharConvCharSet

)

[inline]

Sets character set for text attachment.

Parameters

TInt aCharConvCharSet

SetDRMDataType(TDRMDataType)

IMPORT_C void

SetDRMDataType

(

TDRMDataType

aDRMDataType

)

Sets the DRM (digital rights management) status of this attachment.

Parameters

TDRMDataType aDRMDataType

SetDataType(const TDataType &)

IMPORT_C void

SetDataType

(

const TDataType &

aDataType

)

Sets the datatype (MIME type) of this attachment.

Parameters

const TDataType & aDataType

SetEmptyAttachment(TBool)

void

SetEmptyAttachment

(

TBool

aValue

)

[inline]

Sets attachment empty ( i.e. no content is connected to the attachment ).

Parameters

TBool aValue

SetFetched(TBool)

IMPORT_C void

SetFetched

(

TBool

aFetched

)

Sets the fetched attribute of this attachment.

Parameters

TBool aFetched

SetFileName(const TFileName &)

IMPORT_C void

SetFileName

(

const TFileName &

aFileName

)

Set the filename of this attachment.

Parameters

const TFileName & aFileName

SetSaved(TBool)

IMPORT_C void

SetSaved

(

TBool

aSaved

)

Saves status whether this attachment has been saved into file system

Parameters

TBool aSaved

ETrue attachment has been saved EFalse attachment has not been saved

SetSeparator(TBool)

IMPORT_C void

SetSeparator

(

TBool

aFlag

)

Sets flag if separator line must be drawn before this attachment in attachment view.

Parameters

TBool aFlag

SetSupported(TBool)

IMPORT_C void

SetSupported

(

TBool

aFlag

)

Sets supported flag.

Parameters

TBool aFlag

Size()

IMPORT_C TInt

Size

(

)

const

Returns the size of this attachment.

SizeString()

IMPORT_C TBuf < KMsgAttaSizeStringLength >

SizeString

(

)

const

Returns the size of this attachment as a string.

Member Enumerations Documentation

Enum TAttachmentInfoFlags

Enumerators

EAttachmentNoFlagsSet = 0x00000000
EAttachmentFetched = 0x00000001
EAttachedThisSession = 0x00000002
EAttachmentSupported = 0x00000004
ESeparatorBefore = 0x00000008
EAttachmentSaved = 0x00000010
EEmptyAttachment = 0x00000020