2002-08-21 16:01:05 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
2004-04-18 01:52:36 +04:00
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
2002-08-21 16:01:05 +04:00
|
|
|
*
|
2004-04-18 01:52:36 +04:00
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
2002-08-21 16:01:05 +04:00
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
2004-04-18 01:52:36 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
2002-08-21 16:01:05 +04:00
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
2004-04-18 01:52:36 +04:00
|
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
2002-08-21 16:01:05 +04:00
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
2004-04-18 01:52:36 +04:00
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
2002-08-21 16:01:05 +04:00
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
2004-04-18 01:52:36 +04:00
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
2002-08-21 16:01:05 +04:00
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#ifndef nsPrintEngine_h___
|
|
|
|
#define nsPrintEngine_h___
|
|
|
|
|
2011-12-16 23:42:07 +04:00
|
|
|
#include "mozilla/Attributes.h"
|
|
|
|
|
2004-01-28 14:17:14 +03:00
|
|
|
#include "nsCOMPtr.h"
|
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
#include "nsPrintObject.h"
|
|
|
|
#include "nsPrintData.h"
|
2011-08-25 00:54:29 +04:00
|
|
|
#include "nsFrameList.h"
|
2002-08-21 16:01:05 +04:00
|
|
|
|
|
|
|
// Interfaces
|
|
|
|
#include "nsIDocument.h"
|
|
|
|
#include "nsIDOMWindow.h"
|
|
|
|
#include "nsIObserver.h"
|
|
|
|
|
|
|
|
// Classes
|
|
|
|
class nsPagePrintTimer;
|
2006-12-10 11:05:05 +03:00
|
|
|
class nsIDocShellTreeNode;
|
2011-04-17 05:22:44 +04:00
|
|
|
class nsDeviceContext;
|
2006-12-10 11:05:05 +03:00
|
|
|
class nsIDocumentViewerPrint;
|
|
|
|
class nsPrintObject;
|
|
|
|
class nsIDocShell;
|
|
|
|
class nsIPageSequenceFrame;
|
2011-05-10 16:55:26 +04:00
|
|
|
class nsIWeakReference;
|
2002-08-21 16:01:05 +04:00
|
|
|
|
|
|
|
//------------------------------------------------------------------------
|
|
|
|
// nsPrintEngine Class
|
|
|
|
//
|
|
|
|
//------------------------------------------------------------------------
|
2006-03-30 04:27:42 +04:00
|
|
|
class nsPrintEngine : public nsIObserver
|
2004-01-28 14:17:14 +03:00
|
|
|
{
|
2002-08-21 16:01:05 +04:00
|
|
|
public:
|
|
|
|
// nsISupports interface...
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
|
|
|
|
// nsIObserver
|
|
|
|
NS_DECL_NSIOBSERVER
|
|
|
|
|
2006-03-30 04:27:42 +04:00
|
|
|
// Old nsIWebBrowserPrint methods; not cleaned up yet
|
|
|
|
NS_IMETHOD Print(nsIPrintSettings* aPrintSettings,
|
|
|
|
nsIWebProgressListener* aWebProgressListener);
|
|
|
|
NS_IMETHOD PrintPreview(nsIPrintSettings* aPrintSettings,
|
|
|
|
nsIDOMWindow *aChildDOMWin,
|
|
|
|
nsIWebProgressListener* aWebProgressListener);
|
2011-09-29 10:19:26 +04:00
|
|
|
NS_IMETHOD GetIsFramesetDocument(bool *aIsFramesetDocument);
|
|
|
|
NS_IMETHOD GetIsIFrameSelected(bool *aIsIFrameSelected);
|
|
|
|
NS_IMETHOD GetIsRangeSelection(bool *aIsRangeSelection);
|
|
|
|
NS_IMETHOD GetIsFramesetFrameSelected(bool *aIsFramesetFrameSelected);
|
2006-03-30 04:27:42 +04:00
|
|
|
NS_IMETHOD GetPrintPreviewNumPages(PRInt32 *aPrintPreviewNumPages);
|
|
|
|
NS_IMETHOD EnumerateDocumentNames(PRUint32* aCount, PRUnichar*** aResult);
|
|
|
|
static nsresult GetGlobalPrintSettings(nsIPrintSettings** aPrintSettings);
|
2011-09-29 10:19:26 +04:00
|
|
|
NS_IMETHOD GetDoingPrint(bool *aDoingPrint);
|
|
|
|
NS_IMETHOD GetDoingPrintPreview(bool *aDoingPrintPreview);
|
2006-03-30 04:27:42 +04:00
|
|
|
NS_IMETHOD GetCurrentPrintSettings(nsIPrintSettings **aCurrentPrintSettings);
|
|
|
|
|
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
// This enum tells indicates what the default should be for the title
|
|
|
|
// if the title from the document is null
|
|
|
|
enum eDocTitleDefault {
|
|
|
|
eDocTitleDefNone,
|
|
|
|
eDocTitleDefBlank,
|
|
|
|
eDocTitleDefURLDoc
|
|
|
|
};
|
|
|
|
|
|
|
|
nsPrintEngine();
|
2006-12-10 11:05:05 +03:00
|
|
|
~nsPrintEngine();
|
2002-08-21 16:01:05 +04:00
|
|
|
|
|
|
|
void Destroy();
|
2002-09-10 05:57:09 +04:00
|
|
|
void DestroyPrintingData();
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2006-12-10 11:05:05 +03:00
|
|
|
nsresult Initialize(nsIDocumentViewerPrint* aDocViewerPrint,
|
2011-05-10 16:55:26 +04:00
|
|
|
nsIWeakReference* aContainer,
|
2002-08-21 16:01:05 +04:00
|
|
|
nsIDocument* aDocument,
|
2009-08-24 13:55:28 +04:00
|
|
|
float aScreenDPI,
|
2002-08-21 16:01:05 +04:00
|
|
|
FILE* aDebugFile);
|
|
|
|
|
|
|
|
nsresult GetSeqFrameAndCountPages(nsIFrame*& aSeqFrame, PRInt32& aCount);
|
2006-12-10 11:05:05 +03:00
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
//
|
|
|
|
// The following three methods are used for printing...
|
|
|
|
//
|
|
|
|
nsresult DocumentReadyForPrinting();
|
|
|
|
nsresult GetSelectionDocument(nsIDeviceContextSpec * aDevSpec,
|
|
|
|
nsIDocument ** aNewDoc);
|
|
|
|
|
2006-12-10 11:05:05 +03:00
|
|
|
nsresult SetupToPrintContent();
|
2002-08-21 16:01:05 +04:00
|
|
|
nsresult EnablePOsForPrinting();
|
2002-09-20 01:45:07 +04:00
|
|
|
nsPrintObject* FindSmallestSTF();
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
bool PrintDocContent(nsPrintObject* aPO, nsresult& aStatus);
|
2006-04-11 05:48:48 +04:00
|
|
|
nsresult DoPrint(nsPrintObject * aPO);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
void SetPrintPO(nsPrintObject* aPO, bool aPrint);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
void TurnScriptingOn(bool aDoTurnOn);
|
|
|
|
bool CheckDocumentForPPCaching();
|
2002-08-21 16:01:05 +04:00
|
|
|
void InstallPrintPreviewListener();
|
|
|
|
|
|
|
|
// nsIDocumentViewerPrint Printing Methods
|
2011-09-29 10:19:26 +04:00
|
|
|
bool PrintPage(nsPrintObject* aPOect, bool& aInRange);
|
|
|
|
bool DonePrintingPages(nsPrintObject* aPO, nsresult aResult);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
|
|
|
//---------------------------------------------------------------------
|
2009-02-03 17:42:18 +03:00
|
|
|
void BuildDocTree(nsIDocShellTreeNode * aParentNode,
|
|
|
|
nsTArray<nsPrintObject*> * aDocList,
|
|
|
|
nsPrintObject * aPO);
|
2011-09-29 10:19:26 +04:00
|
|
|
nsresult ReflowDocList(nsPrintObject * aPO, bool aSetPixelScale);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2006-04-11 05:48:48 +04:00
|
|
|
nsresult ReflowPrintObject(nsPrintObject * aPO);
|
2006-03-30 04:27:42 +04:00
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
void CheckForChildFrameSets(nsPrintObject* aPO);
|
|
|
|
|
2006-12-10 11:05:05 +03:00
|
|
|
void CalcNumPrintablePages(PRInt32& aNumPages);
|
2011-09-29 10:19:26 +04:00
|
|
|
void ShowPrintProgress(bool aIsForPrinting, bool& aDoNotify);
|
|
|
|
nsresult CleanupOnFailure(nsresult aResult, bool aIsPrinting);
|
2007-11-10 01:38:46 +03:00
|
|
|
// If FinishPrintPreview() fails, caller may need to reset the state of the
|
|
|
|
// object, for example by calling CleanupOnFailure().
|
2002-08-21 16:01:05 +04:00
|
|
|
nsresult FinishPrintPreview();
|
|
|
|
static void CloseProgressDialog(nsIWebProgressListener* aWebProgressListener);
|
|
|
|
void SetDocAndURLIntoProgress(nsPrintObject* aPO,
|
|
|
|
nsIPrintProgressParams* aParams);
|
2011-09-29 10:19:26 +04:00
|
|
|
void ElipseLongString(PRUnichar *& aStr, const PRUint32 aLen, bool aDoFront);
|
2007-05-06 15:29:41 +04:00
|
|
|
nsresult CheckForPrinters(nsIPrintSettings* aPrintSettings);
|
2002-08-21 16:01:05 +04:00
|
|
|
void CleanupDocTitleArray(PRUnichar**& aArray, PRInt32& aCount);
|
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
bool IsThereARangeSelection(nsIDOMWindow * aDOMWin);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
|
|
|
//---------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
// Timer Methods
|
2006-12-10 11:05:05 +03:00
|
|
|
nsresult StartPagePrintTimer(nsPrintObject* aPO);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
bool IsWindowsInOurSubTree(nsPIDOMWindow * aDOMWindow);
|
|
|
|
static bool IsParentAFrameSet(nsIDocShell * aParent);
|
|
|
|
bool IsThereAnIFrameSelected(nsIDocShell* aDocShell,
|
2004-01-28 14:17:14 +03:00
|
|
|
nsIDOMWindow* aDOMWin,
|
2011-09-29 10:19:26 +04:00
|
|
|
bool& aIsParentFrameSet);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2006-12-10 11:05:05 +03:00
|
|
|
static nsPrintObject* FindPrintObjectByDOMWin(nsPrintObject* aParentObject,
|
|
|
|
nsIDOMWindow* aDOMWin);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
|
|
|
// get the currently infocus frame for the document viewer
|
2004-01-28 14:17:14 +03:00
|
|
|
already_AddRefed<nsIDOMWindow> FindFocusedDOMWindow();
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2004-02-01 15:10:57 +03:00
|
|
|
//---------------------------------------------------------------------
|
|
|
|
// Static Methods
|
|
|
|
//---------------------------------------------------------------------
|
|
|
|
static void GetDocumentTitleAndURL(nsIDocument* aDoc,
|
|
|
|
PRUnichar** aTitle,
|
|
|
|
PRUnichar** aURLStr);
|
2006-12-10 11:05:05 +03:00
|
|
|
void GetDisplayTitleAndURL(nsPrintObject* aPO,
|
|
|
|
PRUnichar** aTitle,
|
|
|
|
PRUnichar** aURLStr,
|
|
|
|
eDocTitleDefault aDefType);
|
2002-08-21 16:01:05 +04:00
|
|
|
static void ShowPrintErrorDialog(nsresult printerror,
|
2011-09-29 10:19:26 +04:00
|
|
|
bool aIsPrinting = true);
|
2004-02-01 15:10:57 +03:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
static bool HasFramesetChild(nsIContent* aContent);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
bool CheckBeforeDestroy();
|
2002-08-21 16:01:05 +04:00
|
|
|
nsresult Cancelled();
|
|
|
|
|
2009-09-03 08:26:00 +04:00
|
|
|
nsIPresShell* GetPrintPreviewPresShell() {return mPrtPreview->mPrintObject->mPresShell;}
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2008-01-29 23:14:51 +03:00
|
|
|
float GetPrintPreviewScale() { return mPrtPreview->mPrintObject->
|
|
|
|
mPresContext->GetPrintPreviewScale(); }
|
|
|
|
|
2002-09-20 01:45:07 +04:00
|
|
|
static nsIPresShell* GetPresShellFor(nsIDocShell* aDocShell);
|
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
// These calls also update the DocViewer
|
2011-09-29 10:19:26 +04:00
|
|
|
void SetIsPrinting(bool aIsPrinting);
|
|
|
|
bool GetIsPrinting()
|
2004-01-28 14:17:14 +03:00
|
|
|
{
|
|
|
|
return mIsDoingPrinting;
|
|
|
|
}
|
2011-09-29 10:19:26 +04:00
|
|
|
void SetIsPrintPreview(bool aIsPrintPreview);
|
|
|
|
bool GetIsPrintPreview()
|
2004-01-28 14:17:14 +03:00
|
|
|
{
|
|
|
|
return mIsDoingPrintPreview;
|
|
|
|
}
|
2011-09-29 10:19:26 +04:00
|
|
|
void SetIsCreatingPrintPreview(bool aIsCreatingPrintPreview)
|
2004-01-28 14:17:14 +03:00
|
|
|
{
|
|
|
|
mIsCreatingPrintPreview = aIsCreatingPrintPreview;
|
|
|
|
}
|
2011-09-29 10:19:26 +04:00
|
|
|
bool GetIsCreatingPrintPreview()
|
2004-01-28 14:17:14 +03:00
|
|
|
{
|
|
|
|
return mIsCreatingPrintPreview;
|
|
|
|
}
|
2002-08-21 16:01:05 +04:00
|
|
|
|
|
|
|
protected:
|
2007-02-23 06:58:36 +03:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
nsresult CommonPrint(bool aIsPrintPreview, nsIPrintSettings* aPrintSettings,
|
2009-12-11 07:02:13 +03:00
|
|
|
nsIWebProgressListener* aWebProgressListener,
|
|
|
|
nsIDOMDocument* aDoc);
|
2007-02-23 06:58:36 +03:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
nsresult DoCommonPrint(bool aIsPrintPreview, nsIPrintSettings* aPrintSettings,
|
2009-12-11 07:02:13 +03:00
|
|
|
nsIWebProgressListener* aWebProgressListener,
|
|
|
|
nsIDOMDocument* aDoc);
|
2007-02-23 06:58:36 +03:00
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
void FirePrintCompletionEvent();
|
2006-12-10 11:05:05 +03:00
|
|
|
static nsresult GetSeqFrameAndCountPagesInternal(nsPrintObject* aPO,
|
|
|
|
nsIFrame*& aSeqFrame,
|
|
|
|
PRInt32& aCount);
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2004-08-01 03:15:21 +04:00
|
|
|
static nsresult FindSelectionBoundsWithList(nsPresContext* aPresContext,
|
2011-04-08 05:04:40 +04:00
|
|
|
nsRenderingContext& aRC,
|
2011-08-25 00:54:29 +04:00
|
|
|
nsFrameList::Enumerator& aChildFrames,
|
2002-11-22 16:02:05 +03:00
|
|
|
nsIFrame * aParentFrame,
|
|
|
|
nsRect& aRect,
|
|
|
|
nsIFrame *& aStartFrame,
|
|
|
|
nsRect& aStartRect,
|
|
|
|
nsIFrame *& aEndFrame,
|
|
|
|
nsRect& aEndRect);
|
|
|
|
|
2004-08-01 03:15:21 +04:00
|
|
|
static nsresult FindSelectionBounds(nsPresContext* aPresContext,
|
2011-04-08 05:04:40 +04:00
|
|
|
nsRenderingContext& aRC,
|
2002-11-22 16:02:05 +03:00
|
|
|
nsIFrame * aParentFrame,
|
|
|
|
nsRect& aRect,
|
|
|
|
nsIFrame *& aStartFrame,
|
|
|
|
nsRect& aStartRect,
|
|
|
|
nsIFrame *& aEndFrame,
|
|
|
|
nsRect& aEndRect);
|
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
static nsresult GetPageRangeForSelection(nsIPresShell * aPresShell,
|
2011-08-25 00:54:29 +04:00
|
|
|
nsPresContext* aPresContext,
|
|
|
|
nsRenderingContext& aRC,
|
2002-08-21 16:01:05 +04:00
|
|
|
nsISelection* aSelection,
|
|
|
|
nsIPageSequenceFrame* aPageSeqFrame,
|
|
|
|
nsIFrame** aStartFrame,
|
|
|
|
PRInt32& aStartPageNum,
|
|
|
|
nsRect& aStartRect,
|
|
|
|
nsIFrame** aEndFrame,
|
|
|
|
PRInt32& aEndPageNum,
|
|
|
|
nsRect& aEndRect);
|
|
|
|
|
2006-03-30 04:27:42 +04:00
|
|
|
static void MapContentForPO(nsPrintObject* aPO, nsIContent* aContent);
|
|
|
|
|
|
|
|
static void MapContentToWebShells(nsPrintObject* aRootPO, nsPrintObject* aPO);
|
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
static void SetPrintAsIs(nsPrintObject* aPO, bool aAsIs = true);
|
2006-03-30 04:27:42 +04:00
|
|
|
|
2005-11-21 01:05:24 +03:00
|
|
|
// Static member variables
|
2011-09-29 10:19:26 +04:00
|
|
|
bool mIsCreatingPrintPreview;
|
|
|
|
bool mIsDoingPrinting;
|
|
|
|
bool mIsDoingPrintPreview; // per DocumentViewer
|
|
|
|
bool mProgressDialogIsShown;
|
2002-08-21 16:01:05 +04:00
|
|
|
|
2008-09-26 13:51:42 +04:00
|
|
|
nsCOMPtr<nsIDocumentViewerPrint> mDocViewerPrint;
|
2011-05-10 16:55:26 +04:00
|
|
|
nsWeakPtr mContainer;
|
2009-08-24 13:55:28 +04:00
|
|
|
float mScreenDPI;
|
2002-09-20 01:45:07 +04:00
|
|
|
|
2002-08-21 16:01:05 +04:00
|
|
|
nsPrintData* mPrt;
|
|
|
|
nsPagePrintTimer* mPagePrintTimer;
|
|
|
|
nsIPageSequenceFrame* mPageSeqFrame;
|
|
|
|
|
|
|
|
// Print Preview
|
|
|
|
nsPrintData* mPrtPreview;
|
|
|
|
nsPrintData* mOldPrtPreview;
|
|
|
|
|
|
|
|
nsCOMPtr<nsIDocument> mDocument;
|
|
|
|
|
|
|
|
FILE* mDebugFile;
|
|
|
|
|
|
|
|
private:
|
2011-12-16 23:42:07 +04:00
|
|
|
nsPrintEngine& operator=(const nsPrintEngine& aOther) MOZ_DELETE;
|
2002-08-21 16:01:05 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* nsPrintEngine_h___ */
|