Symbian^3 Application Developer Library >

MsgAttachmentUtils Class Reference

class MsgAttachmentUtils

Attachment utilities.

Public Member Functions
IMPORT_C CFbsBitmap * CombineIconsL (const CFbsBitmap *, const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C TBool FetchAnyFileL ( TFileName &, CCoeEnv &, MAknFileSelectionObserver *, MAknFileFilter *)
IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType , TFileName &, TBool )
IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType , TFileName &, const TUid &, TBool )
IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType , TFileName &, CDesCArray &, TBool , TBool , MMGFetchVerifier *)
IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType , CDesCArray &, CAiwGenericParamList *, TBool , TBool , MMGFetchVerifier *)
IMPORT_C void FileSizeToStringL ( TDes &, TInt , TBool )
IMPORT_C void GetFileNameFromBuffer ( TFileName &, const TDesC &, TInt , const TDesC *)
IMPORT_C void GetMsgEditorTempPath ( TFileName &, const TDesC *)
Private Member Functions
TBool FetchExistingL ( TMediaFileType , CDesCArray &, TBool , MMGFetchVerifier *)
TBool FetchNewL ( TNewServiceFileType , CDesCArray &, CAiwGenericParamList *, TBool )
TBool FetchNoteL ( CDesCArray &)
CFbsBitmap * InvertBitmapL (const CFbsBitmap *)
Public Member Enumerations
enum TMsgAttachmentFetchType {
EUnknown  = 0, EImage , EAudio , EVideo , ENote , ENewImage , ENewAudio , ENewVideo , ESVG
}

Member Functions Documentation

CombineIconsL(const CFbsBitmap *, const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C CFbsBitmap * CombineIconsL ( const CFbsBitmap * aFirstBmp,
const CFbsBitmap * aSecondBmp,
const CFbsBitmap * aSecondBmpMask = NULL
) [static]

Creates a new bitmap by drawing first and second on top of each other.

The given bitmaps must be valid, i.e. in case they are SVG-bitmaps SetSize must be called before the icons can be combined.

Parameters

const CFbsBitmap * aFirstBmp first bitmap to be drawn.
const CFbsBitmap * aSecondBmp second bitmap to be drawn on top of first.
const CFbsBitmap * aSecondBmpMask = NULL second bitmap mask.

FetchAnyFileL(TFileName &, CCoeEnv &, MAknFileSelectionObserver *, MAknFileFilter *)

IMPORT_C TBool FetchAnyFileL ( TFileName & aFileName,
CCoeEnv & aCoeEnv,
MAknFileSelectionObserver * aVerifier = NULL,
MAknFileFilter * aFilter = NULL
) [static]

Fetches an any attachment file from external application.

Parameters

TFileName & aFileName OUT: filename of the fetched file.
CCoeEnv & aCoeEnv Control environment
MAknFileSelectionObserver * aVerifier = NULL To verify selection.
MAknFileFilter * aFilter = NULL To filter shown files.

FetchExistingL(TMediaFileType, CDesCArray &, TBool, MMGFetchVerifier *)

TBool FetchExistingL ( TMediaFileType aFileType,
CDesCArray & aSelectedFiles,
TBool aMultiSelect,
MMGFetchVerifier * aVerifier
) [private, static]

Parameters

TMediaFileType aFileType
CDesCArray & aSelectedFiles
TBool aMultiSelect
MMGFetchVerifier * aVerifier

FetchFileL(TMsgAttachmentFetchType, TFileName &, TBool)

IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType aType,
TFileName & aFileName,
TBool aCheckDiskSpace = EFalse
) [static]

Fetches an attachment of given type from external application.

Parameters

TMsgAttachmentFetchType aType Fetch type.
TFileName & aFileName OUT: filename of the fetched file.
TBool aCheckDiskSpace = EFalse Deprecated! No disk space check done ever.

FetchFileL(TMsgAttachmentFetchType, TFileName &, const TUid &, TBool)

IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType aType,
TFileName & aFileName,
const TUid & aAppUid,
TBool aCheckDiskSpace = EFalse
) [static]

Fetches an attachment of given type from external application.

Parameters

TMsgAttachmentFetchType aType Fetch type.
TFileName & aFileName OUT: filename of the fetched file.
const TUid & aAppUid app uid used for filtering sound files in audio fetch.
TBool aCheckDiskSpace = EFalse Deprecated! No disk space check done ever.

FetchFileL(TMsgAttachmentFetchType, TFileName &, CDesCArray &, TBool, TBool, MMGFetchVerifier *)

IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType aType,
TFileName & aFileName,
CDesCArray & aSelectedFiles,
TBool aCheckDiskSpace = EFalse,
TBool aMultiSelect = EFalse,
MMGFetchVerifier * aVerifier = NULL
) [static]

Fetches an attachment of given type from external application.

Parameters

TMsgAttachmentFetchType aType Fetch type.
TFileName & aFileName OUT: filename of the fetched file.
CDesCArray & aSelectedFiles OUT: array of selected files.
TBool aCheckDiskSpace = EFalse Deprecated! No disk space check done ever.
TBool aMultiSelect = EFalse if ETrue Media Gallery allows multiselect in file list.
MMGFetchVerifier * aVerifier = NULL To verify selection.

FetchFileL(TMsgAttachmentFetchType, CDesCArray &, CAiwGenericParamList *, TBool, TBool, MMGFetchVerifier *)

IMPORT_C TBool FetchFileL ( TMsgAttachmentFetchType aType,
CDesCArray & aSelectedFiles,
CAiwGenericParamList * aParams,
TBool aCheckDiskSpace = EFalse,
TBool aMultiSelect = EFalse,
MMGFetchVerifier * aVerifier = NULL
) [static]

Fetches an attachment of given type from external application.

Parameters

TMsgAttachmentFetchType aType Fetch type.
CDesCArray & aSelectedFiles OUT: array of selected files.
CAiwGenericParamList * aParams Generic AIW parameters
TBool aCheckDiskSpace = EFalse Deprecated! No disk space check done ever.
TBool aMultiSelect = EFalse if ETrue Media Gallery allows multiselect in file list.
MMGFetchVerifier * aVerifier = NULL To verify selection.

FetchNewL(TNewServiceFileType, CDesCArray &, CAiwGenericParamList *, TBool)

TBool FetchNewL ( TNewServiceFileType aType,
CDesCArray & aSelectedFiles,
CAiwGenericParamList * aParams,
TBool aMultiSelect
) [private, static]

Parameters

TNewServiceFileType aType
CDesCArray & aSelectedFiles
CAiwGenericParamList * aParams
TBool aMultiSelect

FetchNoteL(CDesCArray &)

TBool FetchNoteL ( CDesCArray & aSelectedFiles ) [private, static]

Parameters

CDesCArray & aSelectedFiles

FileSizeToStringL(TDes &, TInt, TBool)

IMPORT_C void FileSizeToStringL ( TDes & aTarget,
TInt aFileSize,
TBool aKilobytesMinimum = EFalse
) [static]

Creates a properly formatted string from size.

Parameters

TDes & aTarget OUT: size string.
TInt aFileSize file size
TBool aKilobytesMinimum = EFalse if ETrue sizes smaller than 1024 bytes are returned as 1 kB.

GetFileNameFromBuffer(TFileName &, const TDesC &, TInt, const TDesC *)

IMPORT_C void GetFileNameFromBuffer ( TFileName & aFileName,
const TDesC & aBuffer,
TInt aMaxLength,
const TDesC * aExt = NULL
) [static]

Generates a legal filename from given text buffer.

Parameters

TFileName & aFileName OUT: generated filename.
const TDesC & aBuffer text buffer.
TInt aMaxLength maximum length for filename.
const TDesC * aExt = NULL optional file extension.

GetMsgEditorTempPath(TFileName &, const TDesC *)

IMPORT_C void GetMsgEditorTempPath ( TFileName & aTempPath,
const TDesC * aFileName = NULL
) [static]

Returns temp path used by msg editors and optionally appends file name to it.

Parameters

TFileName & aTempPath OUT: generated temp path and filename.
const TDesC * aFileName = NULL optionally appended file name.

InvertBitmapL(const CFbsBitmap *)

CFbsBitmap * InvertBitmapL ( const CFbsBitmap * aFirstBmp ) [private, static]

Parameters

const CFbsBitmap * aFirstBmp

Member Enumerations Documentation

Enum TMsgAttachmentFetchType

Enumerators

EUnknown = 0
EImage
EAudio
EVideo
ENote
ENewImage
ENewAudio
ENewVideo
ESVG

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.