layout/printing/nsPrintObject.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6 #ifndef nsPrintObject_h___
   7 #define nsPrintObject_h___
   8
   9 #include "mozilla/Attributes.h"
  10 #include "mozilla/UniquePtr.h"
  11
  12 // Interfaces
  13 #include "nsCOMPtr.h"
  14 #include "nsViewManager.h"
  15 #include "nsIDocShell.h"
  16 #include "nsIDocShellTreeOwner.h"
  17
  18 class nsIContent;
  19 class nsPresContext;
  20
  21 namespace mozilla {
  22 class PresShell;
  23 }  // namespace mozilla
  24
  25 //---------------------------------------------------
  26 //-- nsPrintObject Class
  27 //---------------------------------------------------
  28 class nsPrintObject final {
  29  public:
  30   /**
  31    * If aParent is nullptr (default), then this instance will be initialized as
  32    * a "root" nsPrintObject.  Otherwise, this will be a "nested" nsPrintObject.
  33    */
  34   nsPrintObject(nsIDocShell& aDocShell, mozilla::dom::Document& aDoc,
  35                 nsPrintObject* aParent = nullptr);
  36   ~nsPrintObject();
  37
  38   void DestroyPresentation();
  39
  40   /**
  41    * Recursively sets all the PO items to be printed
  42    * from the given item down into the tree
  43    */
  44   void EnablePrinting(bool aEnable);
  45
  46   /**
  47    * Recursively sets all the PO items to be printed if they have a selection.
  48    */
  49   void EnablePrintingSelectionOnly();
  50
  51   bool PrintingIsEnabled() const { return mPrintingIsEnabled; }
  52
  53   bool HasSelection() const;
  54
  55   // Data Members
  56   nsCOMPtr<nsIDocShell> mDocShell;
  57   nsCOMPtr<nsIDocShellTreeOwner> mTreeOwner;
  58   RefPtr<mozilla::dom::Document> mDocument;
  59
  60   RefPtr<nsPresContext> mPresContext;
  61   RefPtr<mozilla::PresShell> mPresShell;
  62   RefPtr<nsViewManager> mViewManager;
  63
  64   nsCOMPtr<nsIContent> mContent;
  65
  66   nsTArray<mozilla::UniquePtr<nsPrintObject>> mKids;
  67   const nsPrintObject* mParent;  // This is a non-owning pointer.
  68   bool mHasBeenPrinted = false;
  69   bool mInvisible = false;  // Indicates PO is set to not visible by CSS
  70
  71   // The scale factor that sheets should be scaled by. This is either the
  72   // explicit scale chosen by the user or else the shrink-to-fit scale factor
  73   // if the user selects shrink-to-fit. Only set on the top-level nsPrintObject
  74   // since this is only used by nsPageFrame (via nsPresContext::GetPageScale()).
  75   float mZoomRatio = 1.0;
  76
  77   // If the user selects the shrink-to-fit option, the shrink-to-fit scale
  78   // factor is calculated and stored here. Only set on the top-level
  79   // nsPrintObject.
  80   float mShrinkRatio = 1.0;
  81
  82  private:
  83   nsPrintObject& operator=(const nsPrintObject& aOther) = delete;
  84
  85   bool mPrintingIsEnabled = false;
  86 };
  87
  88 #endif /* nsPrintObject_h___ */