PageSizesList Class Reference

Encapsulates all the page size information and functionality in one class. The class knows what size an A4 page is and what its textual name is. More...

#include <pagesize.h>

Inheritance diagram for PageSizesList:

List of all members.

Public Member Functions
	PageSizesList ()
	Constructor.
	~PageSizesList ()
	Destructor.
BOOL	InitPageSizes ()
	Scans all PageSize to find out which PageSize are available for use, and instantiates one of each, and holds them in a list.
BOOL	DeinitPageSizes ()
	Destroy all the PageSize objects.
PageSize *	GetFirstPageSize ()
	Iterating through the list of PageSize known to Camelot. This function returns the first PageSize.
PageSize *	GetNextPageSize (PageSize *)
	Iterating through the list of PageSize known to Camelot. This function returns the next PageSize.
BOOL	DeclarePageSize (PageId NewId, String_32 *Name, double Width, double Height, UnitType Units, PageSize **pPageSize)
	A function to declare a new page size to the system.
BOOL	DeclarePageSize (PageId NewId, ResourceID r, double Width, double Height, UnitType Units, PageSize **pPageSize)
String_32 *	GetTextualDescription (PageId ThisId)
	Return the name for the page size specified.
PageId	GetPageIdFromSize (INT32 Width, INT32 Height)
	Returns the name for the page size specified or CUSTOM if not found.
BOOL	GetSizeFromPageId (PageId ThisId, INT32 *Width, INT32 *Height)
	Returns the width and height the page size specified.
Private Member Functions
	CC_DECLARE_DYNAMIC (PageSizesList)
BOOL	ReadPageSizes ()
	Reads the page size definitions from somewhere (either file or bound-in resource file).
BOOL	ReadPageSizesFromDisk ()
	Reads the page size definitions from disk (i.e. writable media).
BOOL	ReadPageSizesFromRes ()
	Reads the hot key definitions from the bound in resource.
BOOL	ReadPageSizesFromFile (CCLexFile &file)
	Reads the page size definitions from the given file.
BOOL	ReadPageSizesList (CCLexFile &file)
	Read one page size definition from the given file.
BOOL	ReadPageSizeDef (CCLexFile &file, String_32 *pPageName, double *pWidth, double *pHeight, UnitType *pUnits)
	Generates a key press object and op token from the given file.
Private Attributes
INT32	MaxPageId
UINT32	ErrorId

---

Detailed Description

Encapsulates all the page size information and functionality in one class. The class knows what size an A4 page is and what its textual name is.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>

Date:

12/12/94

Definition at line 168 of file pagesize.h.

---

Constructor & Destructor Documentation

PageSizesList::PageSizesList (   )

Constructor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Returns: Errors: See also: AppPrefsDlg; Definition at line 321 of file pagesize.cpp. { // Set up useful defaults // This is the next page id which will be used when the next page is added MaxPageId = (INT32)LASTPAGE; }

PageSizesList::~PageSizesList (   )

Destructor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Returns: Errors: See also: AppPrefsDlg; Definition at line 342 of file pagesize.cpp. { // Remove all page sizes from the list ListItem* pItem; while ((pItem = this->RemoveHead()) != NULL) delete pItem; }

---

Member Function Documentation

PageSizesList::CC_DECLARE_DYNAMIC (  PageSizesList   )  [private]

BOOL PageSizesList::DeclarePageSize (  PageId  NewId, ResourceID  r, double  Width, double  Height, UnitType  Units, PageSize **  pPageSize )  [inline]

Definition at line 186 of file pagesize.h. { String_32 Name(r); return DeclarePageSize(NewId, &Name, Width, Height, Units, pPageSize); }

BOOL PageSizesList::DeclarePageSize (  PageId  NewId, String_32 *  Name, double  Width, double  Height, UnitType  Units, PageSize **  ppPageSize )

A function to declare a new page size to the system. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: NewId  unique pageid. [INPUTS] Name textual desciption of page size Width width of page in mm. Height height of page in mm. ppPageSize pointer to a page size pointer to be updated Returns: True if page size declared, False if something went wrong. See also: PageSize Definition at line 454 of file pagesize.cpp. { // First check to see if somebody has actually declared the pointer to be non null. PageSize *pPageSize = new PageSize; if (pPageSize == NULL) return FALSE; if (!pPageSize->Init(NewId, Name, Width, Height, Units)) { /* Error occured - report it and stop trying to initialise the options tab. */ delete pPageSize; // remove the declared page size pPageSize = NULL; // remove the item from the system InformError(); // tell the user about the problem return TRUE; } // Add this new item at the end of the list this->AddTail(pPageSize); *ppPageSize = pPageSize; // update the new end pointer // All ok return TRUE; }

BOOL PageSizesList::DeinitPageSizes (   )

Destroy all the PageSize objects. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 See also: PageSize Definition at line 427 of file pagesize.cpp. { // Get rid of our PageSize list this->DeleteAll(); // All ok return TRUE; }

PageSize * PageSizesList::GetFirstPageSize (   )

Iterating through the list of PageSize known to Camelot. This function returns the first PageSize. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Returns: Pointer to the first page size NULL if none. See also: PageSizesList::GetNext() Scope: Static Definition at line 493 of file pagesize.cpp. { return (PageSize *) this->GetHead(); }

PageSize * PageSizesList::GetNextPageSize (  PageSize *  pPageSize  )

Iterating through the list of PageSize known to Camelot. This function returns the next PageSize. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: pPageSize  - pointer to the PageSize to be used to get the following [INPUTS] PageSize. Returns: Pointer to the next PageSize, or NULL if none. See also: PageSizesList::GetFirst Definition at line 513 of file pagesize.cpp. { return (PageSize *) this->GetNext(pPageSize); }

PageId PageSizesList::GetPageIdFromSize (  INT32  Width, INT32  Height )

Returns the name for the page size specified or CUSTOM if not found. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: Height  height of page in millipoints. [INPUTS] Width width of page in millipoints. Returns: PageId the Id for the specified page. See also: PageSize::GetSizeFromPageId() Definition at line 562 of file pagesize.cpp. { PageSize* pPageSize = (PageSize*) this->GetHead(); while (pPageSize != NULL) { // Must give a little leeway either side as otherwise rounding errors may // raise their ugly heads and mean that 841891 != 841892 and hence miss the page size INT32 bodge = (INT32)(0.5 * MM_MP_VAL); // extra leeway on comparison required INT32 FoundWidth = pPageSize->GetPageWidth(); INT32 FoundHeight = pPageSize->GetPageHeight(); if ( (FoundWidth >= (Width - bodge)) && (FoundWidth <= (Width + bodge)) && (FoundHeight >= (Height - bodge)) && (FoundHeight <= (Height + bodge)) ) return pPageSize->GetPageId(); pPageSize = (PageSize*) this->GetNext(pPageSize); } return CUSTOM; }

BOOL PageSizesList::GetSizeFromPageId (  PageId  ThisId, INT32 *  Width, INT32 *  Height )

Returns the width and height the page size specified. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: PageId  - id of the page that we are searching for [INPUTS] Returns: Width the width for the specified page in millipoints. Height the height for the specified page in millipoints. See also: PageSize::GetPageIdFromSize() Definition at line 597 of file pagesize.cpp. { // Set up default values in case of early exit *Width = 0; *Height = 0; PageSize* pPageSize = (PageSize*) this->GetHead(); while (pPageSize != NULL) { if (pPageSize->GetPageId() == ThisId) { *Width = pPageSize->GetPageWidth(); // return found page width *Height = pPageSize->GetPageHeight(); // return found page height return TRUE; } pPageSize = (PageSize*) this->GetNext(pPageSize); } // Did not find the specified page return FALSE; }

String_32 * PageSizesList::GetTextualDescription (  PageId  ThisId  )

Return the name for the page size specified. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: PageId  - id of the page that we are searching for [INPUTS] Returns: Textual name for the specified page. See also: PageSize::GetFirst Definition at line 531 of file pagesize.cpp. { PageSize* pPageSize = (PageSize*) this->GetHead(); while (pPageSize != NULL) { if (pPageSize->GetPageId() == ThisId) return pPageSize->GetPageName(); pPageSize = (PageSize*) this->GetNext(pPageSize); } ERROR3("PageSizesList::GetTextualDescription Specified page id not found"); return NULL; }

BOOL PageSizesList::InitPageSizes (   )

Scans all PageSize to find out which PageSize are available for use, and instantiates one of each, and holds them in a list. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Returns: TRUE if initialised ok, FALSE if not. Errors: Out of memory (if a PageSize fails to initialise for other reasons then an error is reported, but Camelot will still start up ok, i.e. TRUE is returned). See also: PageSize Definition at line 367 of file pagesize.cpp. { // Reset our store for error message identifiers to the 'no error' state. ErrorId = 0; // First, try and read hot keys from resource file BOOL Ok = ReadPageSizes(); // Failed to read in the pages from the resource, tell the user this and what we think // the problem is, then use the bound in pages. if (!Ok) { // For now if we fail, error 3 to tell the user and then use the bound in version. if (ErrorId == 0) ErrorId = _R(IDW_PAGES_UNKNOWNERROR); String_256 ErrorReason; ErrorReason.MakeMsg(ErrorId); // Combine the above error with the main error message String_256 ErrorMsg; ErrorMsg.MakeMsg(_R(IDW_PAGES_FAILEDREADING), (TCHAR*) ErrorReason); Error::SetError(_R(IDW_PAGES_FAILEDREADING), (TCHAR *) ErrorMsg, 0); InformError(); \ TRACEUSER( "Neville", _T("PageSizesList::InitPageSizes failed to read in list from resource, using bound in one")); // Vape any that may have been created this->DeleteAll(); // Create, initialise and install the built in PageSize list PageSize *pPageSize; // First size is implied to be custom i.e. if unknown size. DeclarePageSize(A0, _R(IDS_K_PAGESIZE_A0), 840.0, 1188.0, MILLIMETRES, &pPageSize); DeclarePageSize(A1, _R(IDS_K_PAGESIZE_A1), 594.0, 840.0, MILLIMETRES, &pPageSize); DeclarePageSize(A2, _R(IDS_K_PAGESIZE_A2), 420.0, 594.0, MILLIMETRES, &pPageSize); DeclarePageSize(A3, _R(IDS_K_PAGESIZE_A3), 297.0, 420.0, MILLIMETRES, &pPageSize); DeclarePageSize(A4, _R(IDS_K_PAGESIZE_A4), 210.0, 297.0, MILLIMETRES, &pPageSize); DeclarePageSize(A5, _R(IDS_K_PAGESIZE_A5), 148.5, 210.0, MILLIMETRES, &pPageSize); DeclarePageSize(A6, _R(IDS_K_PAGESIZE_A6), 105.0, 148.5, MILLIMETRES, &pPageSize); DeclarePageSize(USLEGAL, _R(IDS_K_PAGESIZE_USLEGAL), 8.5, 14, INCHES, &pPageSize); DeclarePageSize(USLETTER,_R(IDS_K_PAGESIZE_USLETTER), 8.5, 11, INCHES, &pPageSize); DeclarePageSize(FANFOLD, _R(IDS_K_PAGESIZE_FANFOLD), 8.25, 12, INCHES, &pPageSize); } // All ok return TRUE; }

BOOL PageSizesList::ReadPageSizeDef (  CCLexFile &  file, String_32 *  pPageName, double *  pWidth, double *  pHeight, UnitType *  pUnits )  [private]

Generates a key press object and op token from the given file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/95 Parameters: file  = file that contains the key definitions [INPUTS] ppKeyPress = Place to put the ptr to a key press object pOpToken = ptr to string to place the op token string ppTextDesc = ptr to a ptr to a String_32 object that describes the key def (e.g. "Ctrl+X") pCheckUnicode = Flag to determine how the hot key is compared with key press objects *ppKeyPress  = a ptr to a key press object OR NULL [OUTPUTS] pOpToken = op token of op associated with the key press object OR empty string ppTextDesc = ptr to a String_32 describing the key combination. If this is NULL, then the key combo has no text description pCheckUnicode = TRUE if Unicode checking should be done, FALSE otherwise Returns: TRUE if OK FALSE otherwise (syntax error, not enough memory, etc) See also: HotKey::ReadKeyDef Definition at line 850 of file pagesize.cpp. { // Check the parameters ERROR2IF(pPageName == NULL, FALSE,"PageSizesList::ReadPageSizeDef pPageName is NULL"); ERROR2IF(pWidth == NULL, FALSE,"PageSizesList::ReadPageSizeDef pWidth is NULL"); ERROR2IF(pHeight == NULL, FALSE,"PageSizesList::ReadPageSizeDef pHeight is NULL"); ERROR2IF(pUnits == NULL, FALSE,"PageSizesList::ReadPageSizeDef pUnits is NULL"); // Fill in some useful default values *pPageName = _T(""); *pWidth = 0.0; *pHeight = 0.0; *pUnits = MILLIMETRES; // default to reading in measurements in millimetres PsTokenIndex Token; const TCHAR* TokenBuf = file.GetTokenBuf(); // This set of parameters will combine to form a key press object that represents // the hot key combination // String_32* pTextDesc = NULL; // This is FALSE until we have read the text that describes the page size BOOL TextDescRead = FALSE; // This is FALSE until we have read the first number in, which should be the width BOOL ReadWidth = FALSE; // We haven't finsihed, but we're OK at the mo BOOL finished = FALSE; BOOL ok = TRUE; while (ok && !finished) { // Get the next token ok = file.GetSimpleToken(); if (ok) { // Find out the type of the token LexTokenType TokenType = file.GetTokenType(); switch (TokenType) { case TOKEN_STRING: { // Read that text into the name of the page as this is the only // string that is expected // Make sure the desccription is not too long and there is one INT32 length = camStrlen(TokenBuf); ok = ((length <= pPageName->MaxLength()) && (length > 0) ); if (ok) { // Only take as much as we can take //TokenBuf.Left(pPageName, pPageName->MaxLength()); *pPageName = TokenBuf; // We have read the text desc string TextDescRead = TRUE; } else { TRACEUSER( "Neville", _T("PageSizesList::ReadPageSizeDef blank or too long a page size name!")); ErrorId = _R(IDW_PAGES_BADPAGENAME); } } break; case TOKEN_NORMAL: { Token = FindToken(TokenBuf); switch (Token) { // if we find either of the units then this is the last item // so this page size is all read in case TOKEN_MILLIMETRES: *pUnits = MILLIMETRES; finished = TRUE; break; case TOKEN_INCHES: *pUnits = INCHES; finished = TRUE; break; case PsTOKEN_NONE: { double Number; // Could use this but the routine requires a valid doc! //String_256 Value; //Value = TokenBuf; //ok = Convert::StringToDouble( &Value, &Number); // Could use this but is not unicode compliant! //Number = atof((char *)TokenBuf); ok = (camSscanf(TokenBuf,_T("%lg"),&Number) == 1); if (ok) { if (!ReadWidth) { ReadWidth = TRUE; *pWidth = Number; } else { //ok = (camSscanf(TokenBuf,"%lg",pHeight) == 1); *pHeight = Number; } } else { ErrorId = _R(IDW_PAGES_BADPAGESIZE); TRACEUSER( "Neville", _T("PageSize: Expected a size (width/height) but got : '%s'\n"),TokenBuf); } } break; default: // Flag a bad token so that we stop parsing this line ok = FALSE; TRACEUSER( "Neville", _T("PageSize: Didn't expect to get this token ('%s') in the middle of a hot key def\n"),TokenBuf); ErrorId = _R(IDW_PAGES_BADTOKEN); break; } } break; default: // bad token so stop parsing this line TRACEUSER( "Neville", _T("PageSize: Unexpected token - %s\n"),TokenBuf); ok = FALSE; ErrorId = _R(IDW_PAGES_UNEXPECTEDTOKEN); break; } } } return (ok); }

BOOL PageSizesList::ReadPageSizes (   )  [private]

Reads the page size definitions from somewhere (either file or bound-in resource file). Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if OK, FALSE otherwise See also: HotKey::ReadHotKeys; Definition at line 643 of file pagesize.cpp. { BOOL ok = PageSizesList::ReadPageSizesFromDisk(); if (!ok) ok = PageSizesList::ReadPageSizesFromRes(); return (ok); }

BOOL PageSizesList::ReadPageSizesFromDisk (   )  [private]

Reads the page size definitions from disk (i.e. writable media). Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if OK, FALSE otherwise See also: HotKey::ReadHotKeysFromDisk; Definition at line 666 of file pagesize.cpp. { // Not yet implemented return FALSE; }

BOOL PageSizesList::ReadPageSizesFromFile (  CCLexFile &  file  )  [private]

Reads the page size definitions from the given file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/95 Parameters: file  = file that contains the page size definitions [INPUTS] -  [OUTPUTS] Returns: TRUE if OK, FALSE otherwise See also: HotKey::ReadHotKeysFromFile; Definition at line 718 of file pagesize.cpp. { BOOL finished = FALSE; BOOL ok;; // Initialise lexing routines, and aspects of the lexer ok = file.InitLexer(); file.SetDelimiters("\r\n"); // Set token delimiting characters file.SetCommentMarker(';'); // Set comment marker char file.SetWhitespace(" \t"); // Set whitespace chars file.SetStringDelimiters("\"\""); // Set string delimiters PsTokenIndex Token; const TCHAR* TokenBuf = file.GetTokenBuf(); // Token buffer remains constant until lexer deinitialisation while (ok && !finished) { // Grab a token ok = file.GetSimpleToken(); if (ok) { // Look the token up in our table Token = FindToken(TokenBuf); switch (Token) { case TOKEN_PAGESIZE: // Correst line start found so read in the page size info from that line ok = PageSizesList::ReadPageSizesList(file); break; case TOKEN_PAGESIZEEND: // End of table marker found so our job is over finished = TRUE; break; default: TRACEUSER("Neville", _T("PageSizesList: Unexpected token - %s\n"),TokenBuf); ErrorId = _R(IDW_PAGES_UNEXPECTEDMAINTOKEN); ok = FALSE; break; } } else ErrorId = _R(IDW_PAGES_FAILEDTOGETTOKEN); } if (!ok) { TRACEUSER( "Neville", _T("\nPageSizesList: Offending line - %s\n"),file.GetLineBuf()); //ERROR3("Error reading page sizes. See TRACE output for details"); } // We are now finished with the lexer file.DeinitLexer(); return (ok); }

BOOL PageSizesList::ReadPageSizesFromRes (   )  [private]

Reads the hot key definitions from the bound in resource. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if OK, FALSE otherwise See also: HotKey::ReadHotKeysFromRes; Definition at line 687 of file pagesize.cpp. { // Resource File CCResTextFile file; // Open resource BOOL ok = file.open(_R(IDH_DEFAULT_PAGESIZES), _R(IDT_CAM_PAGESIZES_RES)); if (ok) { ok = PageSizesList::ReadPageSizesFromFile(file); file.close(); } return (ok); }

BOOL PageSizesList::ReadPageSizesList (  CCLexFile &  file  )  [private]

Read one page size definition from the given file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/11/95 Parameters: file  = file that contains the page size definitions [INPUTS] -  [OUTPUTS] Returns: TRUE if OK, FALSE otherwise See also: - Definition at line 792 of file pagesize.cpp. { PageSize* pPageSize = NULL; String_32 PageName; double Width = 0.0; double Height = 0.0; UnitType Units = NOTYPE; BOOL ok = PageSizesList::ReadPageSizeDef(file, &PageName, &Width, &Height, &Units); if (ok) { // First size is implied to be custom i.e. if unknown size. DeclarePageSize((PageId)MaxPageId, &PageName, Width, Height, Units, &pPageSize); // Now increment are next new page id MaxPageId++; if (!ok) { ErrorId = _R(IDW_PAGES_FAILEDTOADDPAGE); TRACEUSER( "Neville", _T("PageSizesList: Unable to add page size to the system\n")); } } return (ok); }

---

Member Data Documentation

UINT32 PageSizesList::ErrorId [private]

Definition at line 215 of file pagesize.h.

INT32 PageSizesList::MaxPageId [private]

Definition at line 212 of file pagesize.h.

---

The documentation for this class was generated from the following files:

• Kernel/pagesize.h (r1785/r1282)
• Kernel/pagesize.cpp (r1785/r1668)

---