layout/generic/nsPageContentFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37 #ifndef nsPageContentFrame_h___
  38 #define nsPageContentFrame_h___
  39
  40 #include "nsViewportFrame.h"
  41 class nsPageFrame;
  42 class nsSharedPageData;
  43
  44 // Page frame class used by the simple page sequence frame
  45 class nsPageContentFrame : public ViewportFrame {
  46
  47 public:
  48   NS_DECL_FRAMEARENA_HELPERS
  49
  50   friend nsIFrame* NS_NewPageContentFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
  51   friend class nsPageFrame;
  52
  53   // nsIFrame
  54   NS_IMETHOD  Reflow(nsPresContext*      aPresContext,
  55                      nsHTMLReflowMetrics& aDesiredSize,
  56                      const nsHTMLReflowState& aMaxSize,
  57                      nsReflowStatus&      aStatus);
  58
  59   virtual PRBool IsContainingBlock() const;
  60   virtual PRBool IsFrameOfType(PRUint32 aFlags) const
  61   {
  62     return ViewportFrame::IsFrameOfType(aFlags &
  63              ~(nsIFrame::eCanContainOverflowContainers));
  64   }
  65
  66   virtual void SetSharedPageData(nsSharedPageData* aPD) { mPD = aPD; }
  67
  68   /**
  69    *  Computes page size based on shared page data; SetSharedPageData must be
  70    *  given valid data first.
  71    */
  72   virtual nsSize ComputeSize(nsIRenderingContext *aRenderingContext,
  73                              nsSize aCBSize, nscoord aAvailableWidth,
  74                              nsSize aMargin, nsSize aBorder, nsSize aPadding,
  75                              PRBool aShrinkWrap);
  76
  77   /**
  78    * Get the "type" of the frame
  79    *
  80    * @see nsGkAtoms::pageContentFrame
  81    */
  82   virtual nsIAtom* GetType() const;
  83
  84 #ifdef NS_DEBUG
  85   // Debugging
  86   NS_IMETHOD  GetFrameName(nsAString& aResult) const;
  87 #endif
  88
  89 protected:
  90   nsPageContentFrame(nsStyleContext* aContext) : ViewportFrame(aContext) {}
  91
  92   nsSharedPageData*         mPD;
  93 };
  94
  95 #endif /* nsPageContentFrame_h___ */
  96