Collapse all Symbian^3 Product Developer Library

CReadFaxPages Class Reference

class CReadFaxPages : public CBase

Reads individual pages from a fax file.

The class provides functions to get the number of fax pages in a fax store, the number of scan lines per page, information about the scan line compression and resolution, and the sender Id. It is then possible to iterate through the store by page and by scan line to obtain the fax page.

In pre-v5.1 releases of Symbian OS, the import library was faxst2.lib.

Inherits from

CReadFaxPages
- CBase

Public Member Functions
	~CReadFaxPages()
IMPORT_C TFaxPageInfo	CurrentPageInfo()
IMPORT_C void	GetEncodedScanLineL(TDes8 &)
IMPORT_C TInt	GetScanLineL(TDes8 &)
IMPORT_C CReadFaxPages *	NewL(CStreamStore &, TStreamId)
IMPORT_C TInt	NumPages()
IMPORT_C void	SeekScanLineL(TInt)
IMPORT_C void	SetPageL(TInt)

Protected Member Functions
	CReadFaxPages(CStreamStore &)
void	ConstructL(TStreamId)
void	SetBandL(TInt)

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
TInt	iBandIndex
CFaxPageInfo *	iCurrentPage
TBuf8< KFaxT4MaxDesLength >	iEncodedScanLine
CFaxPages *	iFaxPages
CFaxT4 *	iFaxT4
RStoreReadStream	iReadStream
TInt	iScanLineOffset
CStreamStore *	iStore

Constructor & Destructor Documentation

CReadFaxPages(CStreamStore &)

CReadFaxPages

(

CStreamStore &

aStore

)

[protected]

Parameters

CStreamStore & aStore

~CReadFaxPages()

IMPORT_C

~CReadFaxPages

(

)

Destructor.

Closes the stream, and frees all resources owned by the object, prior to its destruction.

Member Functions Documentation

ConstructL(TStreamId)

void

ConstructL

(

TStreamId

aStreamId

)

[protected]

Parameters

TStreamId aStreamId

CurrentPageInfo()

IMPORT_C TFaxPageInfo

CurrentPageInfo

(

)

const

Gets the information for the current fax page, where the current page was set in a previous call to the SetPageL() function.

capability: None

GetEncodedScanLineL(TDes8 &)

IMPORT_C void

GetEncodedScanLineL

(

TDes8 &

anEncodedScanLine

)

Gets the encoded scan line specified in a previous call to the SeekScanLineL() function.

capability: None

Parameters

TDes8 & anEncodedScanLine

On return, contains the encoded scan line.

GetScanLineL(TDes8 &)

IMPORT_C TInt

GetScanLineL

(

TDes8 &

aScanLine

)

Gets the raw scan line specified in a previous call to the SeekScanLineL() function.

The scan line is stored in compressed form, but is retrieved by this function in raw form for viewing.

capability: None

Parameters

TDes8 & aScanLine

On return, contains the scan line.

NewL(CStreamStore &, TStreamId)

IMPORT_C CReadFaxPages *	NewL	(	CStreamStore &	aStore,
			TStreamId	aStreamId
		)	[static]

Creates a CReadFaxPages object, which offers the public API for reading fax pages from a stream store.

This function is called by CReadFaxFile when opening a fax file.

leave: KErrNoMemory There is insufficient memory to perform the operation.

capability: None

Parameters

CStreamStore & aStore	The store from which fax pages are to be read.
TStreamId aStreamId	The root ID of the stream store.

NumPages()

IMPORT_C TInt

NumPages

(

)

const

Gets the number of pages in the store.

capability: None

SeekScanLineL(TInt)

IMPORT_C void

SeekScanLineL

(

TInt

anIndex

)

Sets the specified scan line as the current scan line.

capability: None

Parameters

TInt anIndex

The index of the scan line.

SetBandL(TInt)

void

SetBandL

(

TInt

anIndex

)

[protected]

Parameters

TInt anIndex

SetPageL(TInt)

IMPORT_C void

SetPageL

(

TInt

aNum

)

Sets a selected page to be the current page, and resets the current scan line to the first scan line in the page.

capability: None

Parameters

TInt aNum

The number of the new page.

Member Data Documentation

TInt iBandIndex

TInt

iBandIndex

[private]

CFaxPageInfo * iCurrentPage

CFaxPageInfo *

iCurrentPage

[private]

TBuf8< KFaxT4MaxDesLength > iEncodedScanLine

TBuf8< KFaxT4MaxDesLength >

iEncodedScanLine

[private]

CFaxPages * iFaxPages

CFaxPages *

iFaxPages

[private]

CFaxT4 * iFaxT4

CFaxT4 *

iFaxT4

[private]

RStoreReadStream iReadStream

RStoreReadStream

iReadStream

[private]

TInt iScanLineOffset

TInt

iScanLineOffset

[private]

CStreamStore * iStore

CStreamStore *

iStore

[private]