Collapse all Symbian^3 Product Developer Library

CBioInfoFileReader Class Reference

class CBioInfoFileReader : public CBioInfoFile

BIO information file (BIF) reader.

Allows reading (all but the icons) from an existing BIF file.

Inherits from

CBioInfoFileReader
- CBioInfoFile
  - CBase

Public Member Functions
	~CBioInfoFileReader()
IMPORT_C const CBifEntry &	BifEntry()
IMPORT_C const TPtrC	Description()
IMPORT_C const TPtrC	FileExtension()
IMPORT_C TInt16	GeneralData1()
IMPORT_C TInt16	GeneralData2()
IMPORT_C TInt16	GeneralData3()
IMPORT_C const TPtrC	IconsFilename()
IMPORT_C const CArrayFixFlat< TBioMsgId > *	IdsLC()
IMPORT_C const TPtrC	MessageAppCtrlName()
IMPORT_C TUid	MessageAppCtrlUid()
IMPORT_C TUid	MessageAppUid()
IMPORT_C const TPtrC	MessageParserName()
IMPORT_C TUid	MessageTypeUid()
IMPORT_C CBioInfoFileReader *	NewL(RFs &, const TDesC &, TUid)
IMPORT_C CBioInfoFileReader *	NewLC(RFs &, const TDesC &, TUid)
IMPORT_C TInt	ZoomLevelsCount()
IMPORT_C const CArrayFixFlat< TInt16 > *	ZoomLevelsLC()

Private Member Functions
	CBioInfoFileReader(RFs &)
void	ConstructL(const TDesC &, TUid)
void	InternalizeL(RReadStream &)
TBool	IsDatFile(const TUidType &)
TBool	IsResFileL()
void	LoadDataL(TUid)
void	LoadResourceL(TUid)

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()
	CBioInfoFile::CBioInfoFile(RFs &)
	CBioInfoFile::ConstructL()
	CBioInfoFile::~CBioInfoFile()

Private Attributes
CBifEntry *	iEntry
HBufC *	iFileName

Inherited Attributes
	CBioInfoFile::iDescription
	CBioInfoFile::iFileExtension
	CBioInfoFile::iFs
	CBioInfoFile::iGeneralData1
	CBioInfoFile::iGeneralData2
	CBioInfoFile::iGeneralData3
	CBioInfoFile::iIconZoomLevelArray
	CBioInfoFile::iIconsFilename
	CBioInfoFile::iIdHeaderArray
	CBioInfoFile::iMessageAppCtrlName
	CBioInfoFile::iMessageAppUid
	CBioInfoFile::iMessageParserName
	CBioInfoFile::iMessageTypeUid

Constructor & Destructor Documentation

CBioInfoFileReader(RFs &)

CBioInfoFileReader

(

RFs &

aFs

)

[private]

Parameters

RFs & aFs

~CBioInfoFileReader()

IMPORT_C

~CBioInfoFileReader

(

)

[virtual]

Destructor.

Member Functions Documentation

BifEntry()

IMPORT_C const CBifEntry &

BifEntry

(

)

const

BIF entry.

ConstructL(const TDesC &, TUid)

void	ConstructL	(	const TDesC &	aFileName,
			TUid	aMsgTypeUid
		)	[private]

Parameters

const TDesC & aFileName
TUid aMsgTypeUid

Description()

IMPORT_C const TPtrC

Description

(

)

const

Gets the BIF's description setting.

FileExtension()

IMPORT_C const TPtrC

FileExtension

(

)

const

Gets the BIF's file extension setting.

GeneralData1()

IMPORT_C TInt16

GeneralData1

(

)

const

Gets the BIF's general data 1 setting.

GeneralData2()

IMPORT_C TInt16

GeneralData2

(

)

const

Gets the BIF's general data 2 setting.

GeneralData3()

IMPORT_C TInt16

GeneralData3

(

)

const

Gets the BIF's general data 3 setting.

IconsFilename()

IMPORT_C const TPtrC

IconsFilename

(

)

const

Gets the BIF's icons filename setting.

IdsLC()

IMPORT_C const CArrayFixFlat< TBioMsgId > *

IdsLC

(

)

const

Gets the BIF's ID array.

The of IDs is left of the cleanup stack and ownership is returned to the caller.

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aStream

)

[private]

Parameters

RReadStream & aStream

IsDatFile(const TUidType &)

TBool

IsDatFile

(

const TUidType &

aUidType

)

const [private]

Parameters

const TUidType & aUidType

IsResFileL()

TBool

IsResFileL

(

)

const [private]

LoadDataL(TUid)

void

LoadDataL

(

TUid

aMsgTypeUid

)

[private]

Parameters

TUid aMsgTypeUid

LoadResourceL(TUid)

void

LoadResourceL

(

TUid

aMsgTypeUid

)

[private]

Parameters

TUid aMsgTypeUid

MessageAppCtrlName()

IMPORT_C const TPtrC

MessageAppCtrlName

(

)

const

Gets the BIF's control name.

MessageAppCtrlUid()

IMPORT_C TUid

MessageAppCtrlUid

(

)

const

Deprecated method.

Use CBioInfoFileReader::MessageAppCtrlName

CBioInfoFileReader::MessageAppCtrlName

MessageAppUid()

IMPORT_C TUid

MessageAppUid

(

)

const

Gets the BIF's application UID setting.

MessageParserName()

IMPORT_C const TPtrC

MessageParserName

(

)

const

Gets the BIF's message parser name.

MessageTypeUid()

IMPORT_C TUid

MessageTypeUid

(

)

const

Gets the BIF's message type UID setting.

NewL(RFs &, const TDesC &, TUid)

IMPORT_C CBioInfoFileReader *	NewL	(	RFs &	aFs,
			const TDesC &	aFileName,
			TUid	aMsgTypeUid = KNullUid
		)	[static]

Allocates and constructs a new BIF reader object.

It loads the specified BIF file.

Parameters

RFs & aFs	Connected file handle
const TDesC & aFileName	BIF file name
TUid aMsgTypeUid = KNullUid	Optional message type UID. If this is specified, and the file does not does not describe this type, then it leaves with KErrCorrupt.

NewLC(RFs &, const TDesC &, TUid)

IMPORT_C CBioInfoFileReader *	NewLC	(	RFs &	aFs,
			const TDesC &	aFileName,
			TUid	aMsgTypeUid = KNullUid
		)	[static]

Allocates and constructs a new BIF reader object, leaving the object on the cleanup stack.

It loads the specified BIF file.

Parameters

RFs & aFs	Connected file handle
const TDesC & aFileName	BIF file name
TUid aMsgTypeUid = KNullUid	Optional message type UID. If this is specified, and the file does not does not describe this type, then it leaves with KErrCorrupt.

ZoomLevelsCount()

IMPORT_C TInt

ZoomLevelsCount

(

)

const

Gets the BIF's number of icon zoom levels.

ZoomLevelsLC()

IMPORT_C const CArrayFixFlat< TInt16 > *

ZoomLevelsLC

(

)

const

Gets the BIF's icon zoom levels setting.

The array of icon zoom level settings is left of the cleanup stack and ownership is returned to the caller.

Member Data Documentation

CBifEntry * iEntry

CBifEntry *

iEntry

[private]

HBufC * iFileName

HBufC *

iFileName

[private]