1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/graphicstools/bitmapfonttools/inc/PDRRECRD.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,475 @@
1.4 +/*
1.5 +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Header PDRRECRD.H
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +#ifndef __PDRRECRD_H__
1.24 +#define __PDRRECRD_H__
1.25 +
1.26 +#include "LEXICAL.H"
1.27 +#include "RECORD.H"
1.28 +#include "UID.H"
1.29 +
1.30 +/**
1.31 +Index of text styles used by printer description records.
1.32 +@publishedAll
1.33 +@released
1.34 +*/
1.35 +enum StyleIndex
1.36 + {
1.37 + /** Normal text. */
1.38 + Normal,
1.39 + /** Bold text. */
1.40 + Bold,
1.41 + /** Italic text. */
1.42 + Italic,
1.43 + /** Bold italic text. */
1.44 + BoldItalic
1.45 + };
1.46 +
1.47 +class PdrResource
1.48 +/**
1.49 +This class encapsulates a printer resource.
1.50 +@publishedAll
1.51 +@released
1.52 +*/
1.53 + {
1.54 +public:
1.55 + IMPORT_C static PdrResource* New();
1.56 + IMPORT_C void Delete();
1.57 + void Externalize(ostream& out);
1.58 +public:
1.59 + /** Resource identifier. */
1.60 + int32 iId;
1.61 + /** String containing the resource. */
1.62 + String iString;
1.63 + };
1.64 +
1.65 +class PdrResources : public Record
1.66 +/**
1.67 +This class holds printer resources.
1.68 +@publishedAll
1.69 +@released
1.70 +*/
1.71 + {
1.72 +public:
1.73 + IMPORT_C static PdrResources* New();
1.74 + IMPORT_C void Delete();
1.75 + void Externalize(ostream& out);
1.76 + IMPORT_C void AddResource(PdrResource* aResource);
1.77 +private:
1.78 + ~PdrResources();
1.79 +private:
1.80 + ObjectList<PdrResource*> iPdrResourceList;
1.81 + };
1.82 +
1.83 +class PdrTranslation
1.84 +/**
1.85 +This class holds a translation between printer descriptions.
1.86 +@publishedAll
1.87 +@released
1.88 +*/
1.89 + {
1.90 +public:
1.91 + IMPORT_C static PdrTranslation* New();
1.92 + IMPORT_C void Delete();
1.93 + void Externalize(ostream& out);
1.94 +public:
1.95 + /** Printer identifier to translate from. */
1.96 + uint16 iFrom;
1.97 + /** Printer identifier to translate to. */
1.98 + String iTo; // !! Think about Unicode version
1.99 + };
1.100 +
1.101 +class PdrTranslates : public Record
1.102 +/**
1.103 +This class encapsulates a list of printer description translations.
1.104 +@publishedAll
1.105 +@released
1.106 +*/
1.107 + {
1.108 +public:
1.109 + IMPORT_C static PdrTranslates* New();
1.110 + IMPORT_C void Delete();
1.111 + void Externalize(ostream& out);
1.112 + IMPORT_C void AddTranslation(PdrTranslation* aTranslation);
1.113 +private:
1.114 + ~PdrTranslates();
1.115 +private:
1.116 + ObjectList<PdrTranslation*> iPdrTranslationList;
1.117 + };
1.118 +
1.119 +class Width
1.120 +/**
1.121 +This class is used to hold font widths. It is used by printer descriptions.
1.122 +@publishedAll
1.123 +@released
1.124 +*/
1.125 + {
1.126 +public:
1.127 + IMPORT_C static Width* New();
1.128 + IMPORT_C void Delete();
1.129 + void Externalize(ostream& out);
1.130 +public:
1.131 + /** Font width in pixels. */
1.132 + uint16 iWidthInPixels;
1.133 + };
1.134 +
1.135 +class WidthsCodeSection
1.136 +/**
1.137 +This class encapsulates a list of font widths used by printer descriptions.
1.138 +@publishedAll
1.139 +@released
1.140 +*/
1.141 + {
1.142 +private:
1.143 + WidthsCodeSection();
1.144 +public:
1.145 + IMPORT_C static WidthsCodeSection* New();
1.146 + IMPORT_C void Delete();
1.147 + void Externalize(ostream& out);
1.148 + IMPORT_C void AddWidth(Width* aWidth);
1.149 + IMPORT_C Width* WidthList(int i);
1.150 + IMPORT_C int NumWidths();
1.151 + ~WidthsCodeSection();
1.152 +public:
1.153 + /** Start of list. */
1.154 + uint16 iStart;
1.155 + /** End of list. */
1.156 + uint16 iEnd;
1.157 +private:
1.158 + ObjectList<Width*> iWidthList;
1.159 + };
1.160 +
1.161 +class FontInfo : public Record
1.162 +/**
1.163 +This class contains information about fonts. It is used by a printer description.
1.164 +@publishedAll
1.165 +@released
1.166 +*/
1.167 + {
1.168 +public:
1.169 + IMPORT_C static FontInfo* New();
1.170 + IMPORT_C void Delete();
1.171 + void Externalize(ostream& out);
1.172 + IMPORT_C void AddCodeSection(WidthsCodeSection* aCodeSection);
1.173 + IMPORT_C WidthsCodeSection* CodeSectionList(int i);
1.174 + IMPORT_C int NumCodeSections();
1.175 +private:
1.176 + ~FontInfo();
1.177 +public:
1.178 + /** Font ascent in pixels. */
1.179 + uint16 iAscentInPixels;
1.180 + /** Maximum font character width in pixels. */
1.181 + uint16 iMaxCharWidthInPixels;
1.182 + /** Normal font character width in pixels. */
1.183 + uint16 iMaxNormalCharWidthInPixels;
1.184 +private:
1.185 + ObjectList<WidthsCodeSection*> iCodeSectionList;
1.186 + };
1.187 +
1.188 +class PdrStyle
1.189 +/**
1.190 +This class contains information about a font style used in a printer descriptions.
1.191 +@publishedAll
1.192 +@released
1.193 +*/
1.194 + {
1.195 +public:
1.196 + IMPORT_C static PdrStyle* New();
1.197 + IMPORT_C void Delete();
1.198 + void Externalize(ostream& out);
1.199 + PdrStyle();
1.200 +public:
1.201 + /** Determines whether the font is available for use. */
1.202 + boolean iIsAvailable;
1.203 + /** Reference to a record containing information about the font. */
1.204 + Record *iFontInfo;
1.205 + };
1.206 +
1.207 +class PdrFontHeight
1.208 +/**
1.209 +This class stores information for use in printer descriptions about font heights
1.210 +and relative scaling.
1.211 +@publishedAll
1.212 +@released
1.213 +*/
1.214 + {
1.215 +public:
1.216 + IMPORT_C static PdrFontHeight* New();
1.217 + IMPORT_C void Delete();
1.218 + void Externalize(ostream& out);
1.219 + PdrFontHeight();
1.220 +public:
1.221 + /** Command string associated with font height. */
1.222 + String iCommandString;
1.223 + /** Font height in twips. */
1.224 + int32 iHeightInTwips;
1.225 + /** Width scaling. */
1.226 + int32 iWidthScale;
1.227 + /** Array containing space for four styles. */
1.228 + PdrStyle iStyle[BoldItalic + 1]; // Array for four styles
1.229 + };
1.230 +
1.231 +class PdrScalableFontHeight
1.232 +/**
1.233 +This class contains information on scalable fonts used by printer descriptions.
1.234 +@publishedAll
1.235 +@released
1.236 +*/
1.237 + {
1.238 +public:
1.239 + PdrScalableFontHeight();
1.240 + void Externalize(ostream& out);
1.241 +public:
1.242 + /** Contains a printer command string associated with this font. */
1.243 + String iCommandString;
1.244 + /** Minimum height in twips. */
1.245 + int32 iHeightMinInTwips;
1.246 + /** Maximum height in twips. */
1.247 + int32 iHeightMaxInTwips;
1.248 + /** Scale delta in twips. */
1.249 + int32 iHeightDeltaInTwips;
1.250 + /** Array for four styles. */
1.251 + PdrStyle iStyle[BoldItalic + 1]; // Array for four styles
1.252 + };
1.253 +
1.254 +class TypefaceFonts : public Record
1.255 +/**
1.256 +This class encapsulates a list of font heights for printer descriptions.
1.257 +@publishedAll
1.258 +@released
1.259 +*/
1.260 + {
1.261 +public:
1.262 + IMPORT_C static TypefaceFonts* New();
1.263 + IMPORT_C void Delete();
1.264 + void Externalize(ostream& out);
1.265 + IMPORT_C void AddFontHeight(PdrFontHeight* aFontHeight);
1.266 + IMPORT_C int NumFontHeights();
1.267 + PdrFontHeight* FontHeightList(int i);
1.268 +private:
1.269 + TypefaceFonts();
1.270 + ~TypefaceFonts();
1.271 +public:
1.272 + Typeface iTypeface;
1.273 + /** Determines whether the font height is scalable. */
1.274 + boolean iIsScalable;
1.275 +private:
1.276 + ObjectList<PdrFontHeight*> iFontHeightList;
1.277 +public:
1.278 + /** Describes a scalable font height. */
1.279 + PdrScalableFontHeight iScalableFontHeight;
1.280 + Record *iTranslates;
1.281 + };
1.282 +
1.283 +class TypefaceFontsEntry
1.284 +/**
1.285 +This class encapsulates information about a printer font.
1.286 +@publishedAll
1.287 +@released
1.288 +*/
1.289 + {
1.290 +public:
1.291 + IMPORT_C static TypefaceFontsEntry* New(Record* aTypefaceFonts);
1.292 + IMPORT_C void Delete();
1.293 + void Externalize(ostream& out);
1.294 +private:
1.295 + TypefaceFontsEntry(Record* aTypefaceFonts);
1.296 +public:
1.297 + ~TypefaceFontsEntry();
1.298 +public:
1.299 + /** Contains the font record. */
1.300 + Record* iTypefaceFonts;
1.301 + /** Determines whether the font can be used in portrait view. */
1.302 + boolean iNotInPortrait;
1.303 + /** Determines whether the font can be used in landscape view. */
1.304 + boolean iNotInLandscape;
1.305 + };
1.306 +
1.307 +class Margins
1.308 +/**
1.309 +This class contains the margins used by a printer description.
1.310 +@publishedAll
1.311 +@released
1.312 +*/
1.313 + {
1.314 +public:
1.315 + void Externalize(ostream& out);
1.316 +public:
1.317 + /** Left margin. */
1.318 + int32 iLeft;
1.319 + /** Right margin. */
1.320 + int32 iRight;
1.321 + /** Top margin. */
1.322 + int32 iTop;
1.323 + /** Bottom margin. */
1.324 + int32 iBottom;
1.325 + };
1.326 +/*
1.327 +class PdrExtraInfo : public Record
1.328 + {
1.329 +public:
1.330 + ~PdrExtraInfo();
1.331 + void Externalize(ostream& out);
1.332 +public:
1.333 + ObjectList<String*> iInfo;
1.334 + };
1.335 +*/
1.336 +class PdrModelInfo
1.337 +/**
1.338 +This class contains information about a printer model used by a printer description.
1.339 +@publishedAll
1.340 +@released
1.341 +*/
1.342 + {
1.343 +public:
1.344 + void Externalize(ostream& out);
1.345 + IMPORT_C void AddTypefaceFontsEntry(TypefaceFontsEntry* aTypefaceFontsEntry);
1.346 + int NumTypefaceFontsEntries();
1.347 + TypefaceFontsEntry* TypefaceFontsEntryList(int i);
1.348 + PdrModelInfo();
1.349 + ~PdrModelInfo();
1.350 +public:
1.351 + streampos iStreamId;
1.352 + /** Flags associated with model. */
1.353 + int32 iFlags;
1.354 + /** Pixel width in twips. */
1.355 + int32 iKPixelWidthInTwips;
1.356 + /** Pixel height in twips. */
1.357 + int32 iKPixelHeightInTwips;
1.358 + /** Portrait printng offset in twips. */
1.359 + Point iPortraitOffsetInPixels;
1.360 + /** Landscape printing offset in twips. */
1.361 + Point iLandscapeOffsetInPixels;
1.362 + /** Minimum margin in pixels. */
1.363 + Margins iMinMarginsInPixels;
1.364 + /** Display mode. */
1.365 + int32 iDisplayMode;
1.366 +private:
1.367 + ObjectList<TypefaceFontsEntry*> iTypefaceFontsEntryList;
1.368 +public:
1.369 + Record *iResources;
1.370 + Record *iSpareRecord;
1.371 + };
1.372 +
1.373 +class PrinterModelEntry
1.374 +/**
1.375 +This class contains information on a printer model.
1.376 +@publishedAll
1.377 +@released
1.378 +*/
1.379 + {
1.380 +public:
1.381 + PrinterModelEntry();
1.382 + void Externalize(ostream& out);
1.383 +public:
1.384 + /** Printer name. */
1.385 + String iName;
1.386 + /** Whether a printer port is required. */
1.387 + boolean iRequiresPrinterPort;
1.388 + uid iUid;
1.389 + };
1.390 +
1.391 +class PrinterModelHeader : public Record
1.392 +/**
1.393 +This class encapsulates information about a printer model.
1.394 +@publishedAll
1.395 +@released
1.396 +*/
1.397 + {
1.398 +public:
1.399 + IMPORT_C static PrinterModelHeader* New();
1.400 + IMPORT_C void Delete();
1.401 + void Externalize(ostream& out);
1.402 + void ExternalizeData(ostream& out);
1.403 + boolean IsPdrModel();
1.404 +public:
1.405 + /** Printer model entry. */
1.406 + PrinterModelEntry iEntry;
1.407 + /** Printer model information. */
1.408 + PdrModelInfo iInfo;
1.409 + };
1.410 +
1.411 +class PdrStoreFile : public Record
1.412 +/**
1.413 +This class stores printer description files.
1.414 +@publishedAll
1.415 +@released
1.416 +*/
1.417 + {
1.418 +public:
1.419 + IMPORT_C static PdrStoreFile* New();
1.420 + IMPORT_C void Delete();
1.421 + IMPORT_C void AddModel(PrinterModelHeader *aModel);
1.422 + void Externalize(ostream& out);
1.423 +private:
1.424 + PdrStoreFile();
1.425 +private:
1.426 + void AddTypefaceFonts(TypefaceFonts* aTypefaceFonts);
1.427 + void ExternalizeHeader(ostream& out);
1.428 + void ExternalizeComponents(ostream& out);
1.429 +public:
1.430 + /** Printer descriptor. */
1.431 + String iPDLName;
1.432 + uid iPDLUid;
1.433 +private:
1.434 + RecordList iModelList;
1.435 + RecordList iTypefaceFontsList;
1.436 + RecordList iFontInfoList;
1.437 + RecordList iResourcesList;
1.438 + RecordList iTranslatesList;
1.439 +// RecordList iExtraInfoList;
1.440 + };
1.441 +
1.442 +class PdrModelStore
1.443 +/**
1.444 +This class is used to store information about printer models, and externalize
1.445 +it to external files.
1.446 +@publishedAll
1.447 +@released
1.448 +*/
1.449 + {
1.450 +public:
1.451 + IMPORT_C boolean Store(const String& aFilename);
1.452 + IMPORT_C void AddPdrStoreFile(PdrStoreFile* aPdrStoreFile);
1.453 + IMPORT_C void AddModel(PrinterModelHeader *aModel);
1.454 + IMPORT_C Record* FindModel(String& aLabel);
1.455 + IMPORT_C void AddTypefaceFonts(TypefaceFonts *aTypefaceFonts);
1.456 + IMPORT_C Record* FindTypefaceFonts(String& aLabel);
1.457 + IMPORT_C void AddFontInfo(FontInfo *aFontInfo);
1.458 + IMPORT_C Record* FindFontInfo(String& aLabel);
1.459 + IMPORT_C void AddResources(PdrResources *aResources);
1.460 + IMPORT_C Record* FindResources(String& aLabel);
1.461 + IMPORT_C void AddTranslates(PdrTranslates *aTranslates);
1.462 + IMPORT_C Record* FindTranslates(String& aLabel);
1.463 +// void AddExtraInfo(PdrExtraInfo *aInfo);
1.464 +// Record* FindExtraInfo(String& aLabel);
1.465 + PdrModelStore();
1.466 + ~PdrModelStore();
1.467 +private:
1.468 + /** This attribute is internal, and is not intended for use. */
1.469 + PdrStoreFile* iPdrStoreFile;
1.470 + RecordList iModelList;
1.471 + RecordList iTypefaceFontsList;
1.472 + RecordList iFontInfoList;
1.473 + RecordList iResourcesList;
1.474 + RecordList iTranslatesList;
1.475 +// RecordList iExtraInfoList;
1.476 + };
1.477 +
1.478 +#endif