Symbian^3 Product Developer Library >

CBCardEngine Class Reference

class CBCardEngine : public CBase

The business card engine is able to import and export vCards and Compact Business Cards to and from Phonebook.

Inherits from

Public Member Functions
~CBCardEngine()
IMPORT_C voidExportBusinessCardL(RWriteStream &, CPbkContactItem &)
IMPORT_C voidImportBusinessCardL(CPbkContactItem &, RReadStream &)
IMPORT_C TBoolImportCompactBusinessCardL(CPbkContactItem &, RReadStream &)
IMPORT_C CBCardEngine *NewL(CPbkContactEngine *)
IMPORT_C TBoolSupportsFieldType(TPbkFieldId)
Private Member Functions
CBCardEngine()
voidConstructL(CPbkContactEngine *)
TInt GetByteFromStream(TUint8 &, RReadStream &)
TInt GetLineFromStreamL(TDes &, RReadStream &)
voidProcessExportPropertyL(CParserVCard &, CPbkContactItem &, const CBCardExportProperty &)
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()
Private Attributes
CPbkContactEngine *iEngine
RPointerArray< CBCardExportProperty >iExportProperties
CBCardFieldAction *iFieldAction
CBCardFieldUidMapping *iNameUidMap
HBufC *iPictureFileName
HBufC *iThumbnailFileName

Constructor & Destructor Documentation

CBCardEngine()

CBCardEngine()[private, inline]

~CBCardEngine()

IMPORT_C~CBCardEngine()

Destructor

Member Functions Documentation

ConstructL(CPbkContactEngine *)

voidConstructL(CPbkContactEngine *aEngine)[private]

Parameters

CPbkContactEngine * aEngine

ExportBusinessCardL(RWriteStream &, CPbkContactItem &)

IMPORT_C voidExportBusinessCardL(RWriteStream &aDestStream,
CPbkContactItem &aSourceItem
)

Writes a vCard record with information from a Phonebook contact item. The main Export function.

Parameters

RWriteStream & aDestStreamA stream where the vCard data is written to. The data written to the stream is not Committed by this method.
CPbkContactItem & aSourceItemPhonebook contact item where the information should be read from

GetByteFromStream(TUint8 &, RReadStream &)

TInt GetByteFromStream(TUint8 &aByte,
RReadStream &aSourceStream
)[private]

Parameters

TUint8 & aByte
RReadStream & aSourceStream

GetLineFromStreamL(TDes &, RReadStream &)

TInt GetLineFromStreamL(TDes &aBuf,
RReadStream &aSourceStream
)[private]

Parameters

TDes & aBuf
RReadStream & aSourceStream

ImportBusinessCardL(CPbkContactItem &, RReadStream &)

IMPORT_C voidImportBusinessCardL(CPbkContactItem &aDestItem,
RReadStream &aSourceStream
)

Reads a vCard record from a stream into a Phonebook contact item.

Parameters

CPbkContactItem & aDestItemPhonebook contact item where the information should be written to. The item should be writable. The caller should commit the changes.
RReadStream & aSourceStreamA stream where the vCard data is read from

ImportCompactBusinessCardL(CPbkContactItem &, RReadStream &)

IMPORT_C TBoolImportCompactBusinessCardL(CPbkContactItem &aDestItem,
RReadStream &aSourceStream
)

Reads a Compact Business Card record from a stream into a Phonebook contact item.

Parameters

CPbkContactItem & aDestItemPhonebook contact item where the information must be written to. The item must be writable. The caller should commit the changes.
RReadStream & aSourceStreamA stream where the Compact Business Card is read from

NewL(CPbkContactEngine *)

IMPORT_C CBCardEngine *NewL(CPbkContactEngine *aEngine)[static]

Creates a new instance of this class.

Parameters

CPbkContactEngine * aEngineAn open Phonebook Engine object which CBCardEngine uses to import and export vCard data.

ProcessExportPropertyL(CParserVCard &, CPbkContactItem &, const CBCardExportProperty &)

voidProcessExportPropertyL(CParserVCard &aParser,
CPbkContactItem &aSourceItem,
const CBCardExportProperty &aExportProperty
)[private]

Parameters

CParserVCard & aParser
CPbkContactItem & aSourceItem
const CBCardExportProperty & aExportProperty

SupportsFieldType(TPbkFieldId)

IMPORT_C TBoolSupportsFieldType(TPbkFieldIdaFieldId)

Checks if given field is supported by the vCard format

Parameters

TPbkFieldId aFieldIdField id type

Member Data Documentation

CPbkContactEngine * iEngine

CPbkContactEngine *iEngine[private]

RPointerArray< CBCardExportProperty > iExportProperties

RPointerArray< CBCardExportProperty >iExportProperties[private]

CBCardFieldAction * iFieldAction

CBCardFieldAction *iFieldAction[private]

CBCardFieldUidMapping * iNameUidMap

CBCardFieldUidMapping *iNameUidMap[private]

HBufC * iPictureFileName

HBufC *iPictureFileName[private]

HBufC * iThumbnailFileName

HBufC *iThumbnailFileName[private]

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.