EPOC   SDK Home Glossary Indexes Previous Next Up

CFaxHeaderLines class


Contents


CFaxHeaderLines class — Read/write fax header line data

Section Contents


Overview

Derivation

CBase

Abstract: CBase behaviour.

Defined in

faxstore.h

Link against

faxst2.lib

Description

This class allows applications to read and write information from the fax header line data file: including the header line template, a font bitmap, and character offset information. This data can be used to generate a fax header line — which contains send-time information — in real time. The process is discussed in detail in Fax header line API.

Writing derived classes

This class is not intended for user derivation.


Construction and destruction


NewL() — Create new CFaxHeaderLines object

static CFaxHeaderLines* NewL();

Description

This function constructs a CFaxHeaderLines object, which is used to read and write the fax header line data file.

Return value

CFaxHeaderLines*

A pointer to the newly created object.

Note

NewLC() — Create new header line object

static CFaxHeaderLines* NewLC();

Description

This function constructs a CFaxHeaderLines object, which is used to read and write the fax header line data file.

As is usual in EPOC, the only difference between this function and NewL() is that this variant pushes the object to the cleanup stack.

Return value

CFaxHeaderLines*

Pointer to the newly created object.

Note

~CFaxHeaderLines() — Destructor

~CFaxHeaderLines();

Description

This function closes the open header line data file and shuts down the file server session.


Writing fax header data file

A new fax header data file — C:\System\faxhead.dat — should be created every time the user identity or phone number changes. The WriteFaxHeaderInfoL() must be invoked first, as it creates/opens the file and adds the font and character offset information to it. WriteRawFontLineL() should then be invoked to add the header line template scan lines, and WriteRawHeaderLineL() should be called to add the font bitmap scan lines.


WriteFaxHeaderInfoL() — Write font and offset information to data file

void WriteFaxHeaderInfoL(TFaxHeaderInfo &aFaxHeaderInfo);

Description

This function creates and opens the fax header data file, and then writes font and character offset information to it.

The font and character offset information is used by the fax server to determine at which position the font bitmap characters should be inserted in the header line template — to create the send-time header line for a page.

Arguments

TFaxHeaderInfo &aFaxHeaderInfo

The fax header line information to be written to the file.

Note

WriteRawFontLineL() — Write raw font line

void WriteRawFontLineL(const TInt alineNumber,TRawScanLine& aUncompressedDataLine);

Description

This function is used to write header line font bitmap scan lines to the header line data file. It should be called to add every scan line in the font bitmap.

Arguments

const TInt alineNumber

The line number of the current scan line.

TRawScanLine& aUncompressedDataLine

A reference to a raw font bitmap scan line to be added to the header line data file.


WriteRawHeaderLineL() — Write raw header line

void WriteRawHeaderLineL(const TInt alineNumber,TRawScanLine& aUncompressedDataLine);

Description

This function is used to write the header line template’s scan lines to the header line data file. It should be called to add every scan line in the template.

Arguments

const TInt alineNumber

The line number of the current scan line.

TRawScanLine& aUncompressedDataLine

A reference to a raw header line template scan line to be added to the header line data file.


Reading fax header data file

The fax header data file — C:\System\faxhead.dat — is read by the fax server, and used to create a new fax header line every time a page is sent.

The ReadFaxHeaderInfoL() is invoked first, as it opens the file and reads the font and character offset information. ReadRawFontLineL() and ReadRawHeaderLineL() are then be called to get the header line template and the font bitmap.


ReadFaxHeaderInfoL() — Read font and offset information from data file

void ReadFaxHeaderInfoL(TFaxHeaderInfo &aFaxHeaderInfo);

Description

This function opens the fax header data file, and then reads font and character offset information from it.

The font and character offset information is used by the fax server to determine at which position the font bitmap characters should be inserted in the header line template — to create the send time header line for a page.

Arguments

TFaxHeaderInfo &aFaxHeaderInfo

On return, contains header line information from the header data file.

Note

ReadRawFontLineL() — Read raw font line

void ReadRawFontLineL(const TInt alineNumber,TRawScanLine &aUncompressedDataLine);

Description

This function is used to read the font bitmap’s scan lines from the header line data file. It should be called to read every scan line in the bitmap.

In normal operation the function is called by the fax server prior to sending a page.

Arguments

const TInt alineNumber

The line number to be read.

TRawScanLine &aUncompressedDataLine

On return, contains a reference to the raw scan line.


ReadRawHeaderLineL() — Read raw header line

void ReadRawHeaderLineL(const TInt alineNumber,TRawScanLine &aUncompressedDataLine);

Description

This function is used to read the header line template’s scan lines from the header line data file. It should be called to read every scan line in the template.

In normal operation the function is called by the fax server prior to sending a page.

Arguments

const TInt alineNumber

The line number of the scan line to be read.

TRawScanLine &aUncompressedDataLine

On return, contains the scan line.


Data members

TFaxHeaderInfoPckg iOurFaxHeaderInfoPckg

The fax header information package.

EPOC       SDK Home Glossary Indexes Previous Next Up