sl@0: /*
sl@0: * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description: 
sl@0: * Header PDRRECRD.H
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef __PDRRECRD_H__
sl@0: #define __PDRRECRD_H__
sl@0: 
sl@0: #include "LEXICAL.H"
sl@0: #include "RECORD.H"
sl@0: #include "UID.H"
sl@0: 
sl@0: /** 
sl@0: Index of text styles used by printer description records. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: enum StyleIndex
sl@0: 	{
sl@0: 	/** Normal text. */
sl@0: 	Normal,
sl@0: 	/** Bold text. */
sl@0: 	Bold,
sl@0: 	/** Italic text. */
sl@0: 	Italic,
sl@0: 	/** Bold italic text. */
sl@0: 	BoldItalic
sl@0: 	};
sl@0: 
sl@0: class PdrResource
sl@0: /** 
sl@0: This class encapsulates a printer resource. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PdrResource* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: public:
sl@0: 	/** Resource identifier. */
sl@0: 	int32 iId;
sl@0: 	/** String containing the resource. */
sl@0: 	String iString;
sl@0: 	};
sl@0: 
sl@0: class PdrResources : public Record
sl@0: /** 
sl@0: This class holds printer resources. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PdrResources* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	IMPORT_C void AddResource(PdrResource* aResource);
sl@0: private:
sl@0: 	~PdrResources();
sl@0: private:
sl@0: 	ObjectList<PdrResource*> iPdrResourceList;
sl@0: 	};
sl@0: 
sl@0: class PdrTranslation
sl@0: /** 
sl@0: This class holds a translation between printer descriptions. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PdrTranslation* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: public:
sl@0: 	/** Printer identifier to translate from. */
sl@0: 	uint16 iFrom;
sl@0: 	/** Printer identifier to translate to. */
sl@0: 	String iTo;	//  !! Think about Unicode version
sl@0: 	};
sl@0: 
sl@0: class PdrTranslates : public Record
sl@0: /** 
sl@0: This class encapsulates a list of printer description translations. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PdrTranslates* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	IMPORT_C void AddTranslation(PdrTranslation* aTranslation);
sl@0: private:
sl@0: 	~PdrTranslates();
sl@0: private:
sl@0: 	ObjectList<PdrTranslation*> iPdrTranslationList;
sl@0: 	};
sl@0: 
sl@0: class Width
sl@0: /** 
sl@0: This class is used to hold font widths. It is used by printer descriptions. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static Width* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: public:
sl@0: 	/** Font width in pixels. */
sl@0: 	uint16 iWidthInPixels;
sl@0: 	};
sl@0: 
sl@0: class WidthsCodeSection
sl@0: /** 
sl@0: This class encapsulates a list of font widths used by printer descriptions. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: private:
sl@0: 	WidthsCodeSection();
sl@0: public:
sl@0: 	IMPORT_C static WidthsCodeSection* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	IMPORT_C void AddWidth(Width* aWidth);
sl@0: 	IMPORT_C Width* WidthList(int i);
sl@0: 	IMPORT_C int NumWidths();
sl@0: 	~WidthsCodeSection();
sl@0: public:
sl@0: 	/** Start of list. */
sl@0: 	uint16 iStart;
sl@0: 	/** End of list. */
sl@0: 	uint16 iEnd;
sl@0: private:
sl@0: 	ObjectList<Width*> iWidthList;
sl@0: 	};	
sl@0: 
sl@0: class FontInfo : public Record
sl@0: /** 
sl@0: This class contains information about fonts. It is used by a printer description. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static FontInfo* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	IMPORT_C void AddCodeSection(WidthsCodeSection* aCodeSection);
sl@0: 	IMPORT_C WidthsCodeSection* CodeSectionList(int i);
sl@0: 	IMPORT_C int NumCodeSections();
sl@0: private:
sl@0: 	~FontInfo();
sl@0: public:
sl@0: 	/** Font ascent in pixels. */
sl@0: 	uint16 iAscentInPixels;
sl@0: 	/** Maximum font character width in pixels. */
sl@0: 	uint16 iMaxCharWidthInPixels;
sl@0: 	/** Normal font character width in pixels. */
sl@0: 	uint16 iMaxNormalCharWidthInPixels;
sl@0: private:
sl@0: 	ObjectList<WidthsCodeSection*> iCodeSectionList;
sl@0: 	};
sl@0:  
sl@0: class PdrStyle
sl@0: /** 
sl@0: This class contains information about a font style used in a printer descriptions. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PdrStyle* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	PdrStyle();
sl@0: public:
sl@0: 	/** Determines whether the font is available for use. */
sl@0: 	boolean iIsAvailable;
sl@0: 	/** Reference to a record containing information about the font. */
sl@0: 	Record *iFontInfo;
sl@0: 	};
sl@0: 
sl@0: class PdrFontHeight
sl@0: /** 
sl@0: This class stores information for use in printer descriptions about font heights 
sl@0: and relative scaling. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PdrFontHeight* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	PdrFontHeight();
sl@0: public:
sl@0: 	/** Command string associated with font height. */
sl@0: 	String iCommandString;
sl@0: 	/** Font height in twips. */
sl@0: 	int32 iHeightInTwips;
sl@0: 	/** Width scaling. */
sl@0: 	int32 iWidthScale;
sl@0: 	/** Array containing space for four styles. */
sl@0: 	PdrStyle iStyle[BoldItalic + 1];	// Array for four styles
sl@0: 	};
sl@0: 
sl@0: class PdrScalableFontHeight
sl@0: /** 
sl@0: This class contains information on scalable fonts used by printer descriptions. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	PdrScalableFontHeight();
sl@0: 	void Externalize(ostream& out);
sl@0: public:
sl@0: 	/** Contains a printer command string associated with this font. */
sl@0: 	String iCommandString;
sl@0: 	/** Minimum height in twips. */
sl@0: 	int32 iHeightMinInTwips;
sl@0: 	/** Maximum height in twips. */
sl@0: 	int32 iHeightMaxInTwips;
sl@0: 	/** Scale delta in twips. */
sl@0: 	int32 iHeightDeltaInTwips;
sl@0: 	/** Array for four styles. */
sl@0: 	PdrStyle iStyle[BoldItalic + 1];	// Array for four styles
sl@0: 	};
sl@0: 
sl@0: class TypefaceFonts : public Record
sl@0: /** 
sl@0: This class encapsulates a list of font heights for printer descriptions. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static TypefaceFonts* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	IMPORT_C void AddFontHeight(PdrFontHeight* aFontHeight);
sl@0: 	IMPORT_C int NumFontHeights();
sl@0: 	PdrFontHeight* FontHeightList(int i);
sl@0: private:
sl@0: 	TypefaceFonts();
sl@0: 	~TypefaceFonts();
sl@0: public:
sl@0: 	Typeface iTypeface;
sl@0: 	/** Determines whether the font height is scalable. */
sl@0: 	boolean iIsScalable;
sl@0: private:
sl@0: 	ObjectList<PdrFontHeight*> iFontHeightList;
sl@0: public:
sl@0: 	/** Describes a scalable font height. */
sl@0: 	PdrScalableFontHeight iScalableFontHeight;
sl@0: 	Record *iTranslates;
sl@0: 	};
sl@0: 
sl@0: class TypefaceFontsEntry
sl@0: /** 
sl@0: This class encapsulates information about a printer font. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static TypefaceFontsEntry* New(Record* aTypefaceFonts);
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: private:
sl@0: 	TypefaceFontsEntry(Record* aTypefaceFonts);
sl@0: public:
sl@0: 	~TypefaceFontsEntry();
sl@0: public:
sl@0: 	/** Contains the font record. */
sl@0: 	Record* iTypefaceFonts;
sl@0: 	/** Determines whether the font can be used in portrait view. */
sl@0: 	boolean iNotInPortrait;
sl@0: 	/** Determines whether the font can be used in landscape view. */
sl@0: 	boolean iNotInLandscape;
sl@0: 	};
sl@0: 
sl@0: class Margins
sl@0: /** 
sl@0: This class contains the margins used by a printer description. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	void Externalize(ostream& out);
sl@0: public:
sl@0: 	/** Left margin. */
sl@0: 	int32 iLeft;
sl@0: 	/** Right margin. */
sl@0: 	int32 iRight;
sl@0: 	/** Top margin. */
sl@0: 	int32 iTop;
sl@0: 	/** Bottom margin. */
sl@0: 	int32 iBottom;
sl@0: 	};
sl@0: /*
sl@0: class PdrExtraInfo : public Record
sl@0: 	{
sl@0: public:
sl@0: 	~PdrExtraInfo();
sl@0: 	void Externalize(ostream& out);
sl@0: public:
sl@0: 	ObjectList<String*> iInfo;
sl@0: 	};
sl@0: */
sl@0: class PdrModelInfo
sl@0: /** 
sl@0: This class contains information about a printer model used by a printer description. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	void Externalize(ostream& out);
sl@0: 	IMPORT_C void AddTypefaceFontsEntry(TypefaceFontsEntry* aTypefaceFontsEntry);
sl@0: 	int NumTypefaceFontsEntries();
sl@0: 	TypefaceFontsEntry* TypefaceFontsEntryList(int i);
sl@0: 	PdrModelInfo();
sl@0: 	~PdrModelInfo();
sl@0: public:
sl@0: 	streampos iStreamId;
sl@0: 	/** Flags associated with model. */
sl@0: 	int32 iFlags;
sl@0: 	/** Pixel width in twips. */
sl@0: 	int32 iKPixelWidthInTwips;
sl@0: 	/** Pixel height in twips. */
sl@0: 	int32 iKPixelHeightInTwips;
sl@0: 	/** Portrait printng offset in twips. */
sl@0: 	Point iPortraitOffsetInPixels;
sl@0: 	/** Landscape printing offset in twips. */
sl@0: 	Point iLandscapeOffsetInPixels;
sl@0: 	/** Minimum margin in pixels. */
sl@0: 	Margins iMinMarginsInPixels;
sl@0: 	/** Display mode. */
sl@0: 	int32 iDisplayMode;
sl@0: private:
sl@0: 	ObjectList<TypefaceFontsEntry*> iTypefaceFontsEntryList;
sl@0: public:
sl@0: 	Record *iResources;
sl@0: 	Record *iSpareRecord;
sl@0: 	};
sl@0:  
sl@0: class PrinterModelEntry
sl@0: /** 
sl@0: This class contains information on a printer model. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	PrinterModelEntry();
sl@0: 	void Externalize(ostream& out);
sl@0: public:
sl@0: 	/** Printer name. */
sl@0: 	String iName;
sl@0: 	/** Whether a printer port is required. */
sl@0: 	boolean iRequiresPrinterPort;
sl@0: 	uid iUid;
sl@0: 	};
sl@0: 
sl@0: class PrinterModelHeader : public Record
sl@0: /** 
sl@0: This class encapsulates information about a printer model. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PrinterModelHeader* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	void Externalize(ostream& out);
sl@0: 	void ExternalizeData(ostream& out);
sl@0: 	boolean IsPdrModel();
sl@0: public:
sl@0: 	/** Printer model entry. */
sl@0: 	PrinterModelEntry iEntry;
sl@0: 	/** Printer model information. */
sl@0: 	PdrModelInfo iInfo;
sl@0: 	};
sl@0: 
sl@0: class PdrStoreFile : public Record
sl@0: /** 
sl@0: This class stores printer description files. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static PdrStoreFile* New();
sl@0: 	IMPORT_C void Delete();
sl@0: 	IMPORT_C void AddModel(PrinterModelHeader *aModel);
sl@0: 	void Externalize(ostream& out);
sl@0: private:
sl@0: 	PdrStoreFile();
sl@0: private:
sl@0: 	void AddTypefaceFonts(TypefaceFonts* aTypefaceFonts);
sl@0: 	void ExternalizeHeader(ostream& out);
sl@0: 	void ExternalizeComponents(ostream& out);
sl@0: public:
sl@0: 	/** Printer descriptor. */
sl@0: 	String iPDLName;
sl@0: 	uid iPDLUid;
sl@0: private:
sl@0: 	RecordList iModelList;
sl@0: 	RecordList iTypefaceFontsList;
sl@0: 	RecordList iFontInfoList;
sl@0: 	RecordList iResourcesList; 
sl@0: 	RecordList iTranslatesList;
sl@0: //	RecordList iExtraInfoList;
sl@0: 	};
sl@0: 
sl@0: class PdrModelStore
sl@0: /** 
sl@0: This class is used to store information about printer models, and externalize 
sl@0: it to external files. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C boolean Store(const String& aFilename);
sl@0: 	IMPORT_C void AddPdrStoreFile(PdrStoreFile* aPdrStoreFile);
sl@0: 	IMPORT_C void AddModel(PrinterModelHeader *aModel);
sl@0: 	IMPORT_C Record* FindModel(String& aLabel);
sl@0: 	IMPORT_C void AddTypefaceFonts(TypefaceFonts *aTypefaceFonts);
sl@0: 	IMPORT_C Record* FindTypefaceFonts(String& aLabel);
sl@0: 	IMPORT_C void AddFontInfo(FontInfo *aFontInfo);
sl@0: 	IMPORT_C Record* FindFontInfo(String& aLabel);
sl@0: 	IMPORT_C void AddResources(PdrResources *aResources);
sl@0: 	IMPORT_C Record* FindResources(String& aLabel);
sl@0: 	IMPORT_C void AddTranslates(PdrTranslates *aTranslates);
sl@0: 	IMPORT_C Record* FindTranslates(String& aLabel);
sl@0: //	void AddExtraInfo(PdrExtraInfo *aInfo);
sl@0: //	Record* FindExtraInfo(String& aLabel);
sl@0: 	PdrModelStore();
sl@0: 	~PdrModelStore();
sl@0: private:
sl@0: 	/** This attribute is internal, and is not intended for use. */
sl@0: 	PdrStoreFile* iPdrStoreFile;
sl@0: 	RecordList iModelList;
sl@0: 	RecordList iTypefaceFontsList;
sl@0: 	RecordList iFontInfoList;
sl@0: 	RecordList iResourcesList;
sl@0: 	RecordList iTranslatesList;
sl@0: //	RecordList iExtraInfoList;
sl@0: 	};
sl@0: 
sl@0: #endif