1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/textformatting/inc/FRMPAGE.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,185 @@
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 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef __FRMPAGE_H__
1.23 +#define __FRMPAGE_H__
1.24 +
1.25 +#include <e32std.h>
1.26 +#include <e32base.h>
1.27 +#include <gdi.h>
1.28 +
1.29 +class MLayDoc;
1.30 +class CTextLayout;
1.31 +class CParaFormat;
1.32 +
1.33 +//
1.34 +// The following two classes are for internal use only
1.35 +//
1.36 +
1.37 +/**
1.38 +@internalComponent
1.39 +*/
1.40 +struct TPageLine
1.41 + {
1.42 + TInt iDocPos;
1.43 + TInt iLineHeight;
1.44 + TBool iKeepWithNext;
1.45 + TBool iStartNewPage;
1.46 + };
1.47 +
1.48 +/**
1.49 +@internalComponent
1.50 +*/
1.51 +class TLinePaginator
1.52 + {
1.53 +public:
1.54 + TLinePaginator();
1.55 + TBool AppendLineL(TPageLine aLine);
1.56 + void FlushL(TInt aEndDocPos);
1.57 + void SetPageHeight(TInt aPageHeight);
1.58 + void SetArray(CArrayFix<TInt>* aCharsPerPage);
1.59 + void Reset();
1.60 +private:
1.61 + void ResetArray();
1.62 + void InsertPageBreakL();
1.63 + void SetPotentialBreakPoint(TInt aDocPos);
1.64 + void CheckTallLineL(TPageLine& aLine);
1.65 +private:
1.66 + CArrayFix<TInt>* iPageList; // This is created and destroyed by the application running the paginator.
1.67 + TInt iDocPos;
1.68 + TBool iKeepWithPrev;
1.69 + TInt iPageHeight;
1.70 + TInt iHeightRem;
1.71 + TBool iBreakOnPage;
1.72 + TInt iPrevPageBreak;
1.73 + TInt iHeightLines;
1.74 + TBool iFirstLine; // Used to prevent page break being inserted at top of document.
1.75 + };
1.76 +
1.77 +/**
1.78 +An abstract class which must be mixed with application calling the active object.
1.79 +It specifies the protocol for a pagination observer. A
1.80 +pagination observer may be used when paginating a document in the background
1.81 +(using CTextPaginator::PaginateCompleteDocumentL()). It notifies the client
1.82 +on page completion, document completion, and on errors.
1.83 +
1.84 +The observer is set up using the function CTextPaginator::SetObserver().
1.85 +@publishedAll
1.86 +@released
1.87 +*/
1.88 +class MPaginateObserver
1.89 + {
1.90 +public:
1.91 +
1.92 + /** Notifies the client on completion of document pagination. */
1.93 + virtual void NotifyCompletion()=0;
1.94 +
1.95 + /** Notifies the client when a leave is trapped or when the pagination is cancelled.
1.96 + Implements error handling.
1.97 + @param anErrorCode Error code - indicates the type of error. */
1.98 + virtual void NotifyError(TInt anErrorCode)=0;
1.99 +
1.100 + /** Called by the paginator when each page has been completed.
1.101 + @param aCurrentPageNum The number of the page. */
1.102 + virtual void NotifyPageCompletion(TInt aCurrentPageNum)=0;
1.103 + };
1.104 +
1.105 +
1.106 +
1.107 +/**
1.108 +Paginates a document.
1.109 +
1.110 +Sets the page dimensions, the printer device and the source document to paginate.
1.111 +Uses a page list, which is an array of characters-per-page values.
1.112 +
1.113 +There are two ways of paginating a document; either in the background using
1.114 +an active object or by incrementally adding text to the document and repeatedly
1.115 +notifying the CTextPaginator object to paginate the added text. If an active
1.116 +object is used, the client may be notified on completion of pages, on trapped
1.117 +leaves and on completion of the pagination by an optional pagination observer.
1.118 +@publishedAll
1.119 +@released
1.120 +*/
1.121 +class CTextPaginator : public CActive
1.122 + {
1.123 +public:
1.124 +// 2 phase ctor: automatically adds self to active scheduler
1.125 + IMPORT_C static CTextPaginator* NewL(CPrinterDevice* aPrinterDevice,CArrayFix<TInt>* aCharsPerPage,TInt aPriority);
1.126 + IMPORT_C ~CTextPaginator();
1.127 + IMPORT_C void SetDocumentL(MLayDoc* aLayDoc); // Must call before anything else
1.128 + IMPORT_C void SetPrinterDevice(CPrinterDevice* aPrinterDevice);
1.129 + IMPORT_C void SetPageSpecInTwips(const TPageSpec& aPageSpec); // Physical size of page.
1.130 + IMPORT_C void SetPageMarginsInTwips(const TMargins& aPageMargins); // Default are all zero.
1.131 + IMPORT_C void SetTextMarginWidthsInTwips(TInt aLabelMarginWidth,TInt aGutterMarginWidth); // label margins (if any)
1.132 +// Called to initiate paginating a document using active object
1.133 + IMPORT_C void SetObserver(MPaginateObserver* aObserver);
1.134 + IMPORT_C void PaginateCompleteDocumentL();
1.135 +// Called to paginate incrementally, without active object
1.136 + IMPORT_C TInt AppendTextL(TInt& aCumulativeDocPos); // returns number of page breaks so far
1.137 + IMPORT_C TInt PaginationCompletedL(); // called at end of incremental pagination - returns total number of page breaks
1.138 +private:
1.139 + enum TPaginateMode
1.140 + {
1.141 + EFPaginateCompleteDocument,
1.142 + EFPaginateIncrementally
1.143 + };
1.144 + enum
1.145 + {
1.146 + EPageLineArrayGranularity=10,
1.147 + EPageListArrayGranularity=5
1.148 + };
1.149 + enum
1.150 + {
1.151 + EFMaximumNumberLinesInBlock=20
1.152 + };
1.153 +private:
1.154 + CTextPaginator(TInt aPriority);
1.155 + void RunL(); // Active scheduler is friend - can access
1.156 + void DoCancel(); // Called by CActive::Cancel()
1.157 + void ConstructL(CPrinterDevice* aPrinterDevice,CArrayFix<TInt>* aCharsPerPage);
1.158 + void SetLayoutDimensions();
1.159 + void SetOrReplaceDocumentL(MLayDoc* aLayDoc);
1.160 + TRect TextRectInTwips() const;
1.161 + TSize TextSizeInPixels() const;
1.162 + void TrapPaginateParagraphL();
1.163 + void PaginateParagraphL();
1.164 + void PageCompleted();
1.165 + void Reque();
1.166 + void ResetPaginator();
1.167 + void CopyTempPageListL(); // Copies temporary page list to real one.
1.168 + void LeaveL(TInt aErr);
1.169 +private:
1.170 + MLayDoc* iLayDoc;
1.171 + MPaginateObserver* iObserver;
1.172 + CPrinterDevice* iPrinterDevice;
1.173 + TLinePaginator iPaginator;
1.174 + CTextLayout* iLayout;
1.175 + CArrayFix<TInt>* iPageList;
1.176 + CArrayFixFlat<TInt>* iTempPageList;
1.177 + CArrayFixFlat<TPageLine>* iPageLineArray;
1.178 + TSize iPageSizeInTwips;
1.179 + TMargins iPageMarginsInTwips;
1.180 + TInt iGutterMarginWidthInTwips; // Gap between labels and text proper - in twips
1.181 + TInt iLabelMarginWidthInTwips;
1.182 + TInt iDocPos; // Within the laydoc
1.183 + TBool iPageBreakChar;
1.184 + TPaginateMode iMode;
1.185 + };
1.186 +
1.187 +#endif
1.188 +