layout/mathml/base/src/nsMathMLmfencedFrame.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 MathML Project.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * The University Of Queensland.
  19  * Portions created by the Initial Developer are Copyright (C) 1999
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Roger B. Sidje <rbs@maths.uq.edu.au>
  24  *   David J. Fiddes <D.J.Fiddes@hw.ac.uk>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsMathMLmfencedFrame_h___
  41 #define nsMathMLmfencedFrame_h___
  42
  43 #include "nsCOMPtr.h"
  44 #include "nsMathMLContainerFrame.h"
  45
  46 //
  47 // <mfenced> -- surround content with a pair of fences
  48 //
  49
  50 class nsMathMLmfencedFrame : public nsMathMLContainerFrame {
  51 public:
  52   friend nsIFrame* NS_NewMathMLmfencedFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
  53
  54   virtual void
  55   SetAdditionalStyleContext(PRInt32          aIndex,
  56                             nsStyleContext*  aStyleContext);
  57   virtual nsStyleContext*
  58   GetAdditionalStyleContext(PRInt32 aIndex) const;
  59
  60   NS_IMETHOD
  61   InheritAutomaticData(nsIFrame* aParent);
  62
  63   NS_IMETHOD
  64   SetInitialChildList(nsIAtom*        aListName,
  65                       nsIFrame*       aChildList);
  66
  67   NS_IMETHOD
  68   Reflow(nsPresContext*          aPresContext,
  69          nsHTMLReflowMetrics&     aDesiredSize,
  70          const nsHTMLReflowState& aReflowState,
  71          nsReflowStatus&          aStatus);
  72
  73   NS_IMETHOD BuildDisplayList(nsDisplayListBuilder*   aBuilder,
  74                               const nsRect&           aDirtyRect,
  75                               const nsDisplayListSet& aLists);
  76
  77   virtual nscoord
  78   GetIntrinsicWidth(nsIRenderingContext* aRenderingContext);
  79
  80   NS_IMETHOD
  81   AttributeChanged(PRInt32         aNameSpaceID,
  82                    nsIAtom*        aAttribute,
  83                    PRInt32         aModType);
  84
  85   // override the base method because we must keep separators in sync
  86   virtual nsresult
  87   ChildListChanged(PRInt32 aModType);
  88
  89   // override the base method so that we can deal with fences and separators
  90   virtual nscoord
  91   FixInterFrameSpacing(nsHTMLReflowMetrics& aDesiredSize);
  92
  93   // exported routines that both mfenced and mfrac share.
  94   // mfrac uses these when its bevelled attribute is set.
  95   static nsresult
  96   doReflow(nsPresContext*          aPresContext,
  97            const nsHTMLReflowState& aReflowState,
  98            nsHTMLReflowMetrics&     aDesiredSize,
  99            nsReflowStatus&          aStatus,
 100            nsMathMLContainerFrame*  aForFrame,
 101            nsMathMLChar*            aOpenChar,
 102            nsMathMLChar*            aCloseChar,
 103            nsMathMLChar*            aSeparatorsChar,
 104            PRInt32                  aSeparatorsCount);
 105
 106   static nscoord
 107   doGetIntrinsicWidth(nsIRenderingContext*    aRenderingContext,
 108                       nsMathMLContainerFrame* aForFrame,
 109                       nsMathMLChar*           aOpenChar,
 110                       nsMathMLChar*           aCloseChar,
 111                       nsMathMLChar*           aSeparatorsChar,
 112                       PRInt32                 aSeparatorsCount);
 113
 114   // helper routines to format the MathMLChars involved here
 115   static nsresult
 116   ReflowChar(nsPresContext*      aPresContext,
 117              nsIRenderingContext& aRenderingContext,
 118              nsMathMLChar*        aMathMLChar,
 119              nsOperatorFlags      aForm,
 120              PRInt32              aScriptLevel,
 121              nscoord              axisHeight,
 122              nscoord              leading,
 123              nscoord              em,
 124              nsBoundingMetrics&   aContainerSize,
 125              nscoord&             aAscent,
 126              nscoord&             aDescent);
 127
 128   static void
 129   PlaceChar(nsMathMLChar*      aMathMLChar,
 130             nscoord            aDesiredSize,
 131             nsBoundingMetrics& bm,
 132             nscoord&           dx);
 133
 134 protected:
 135   nsMathMLmfencedFrame(nsStyleContext* aContext) : nsMathMLContainerFrame(aContext) {}
 136   virtual ~nsMathMLmfencedFrame();
 137
 138   virtual PRIntn GetSkipSides() const { return 0; }
 139
 140   nsMathMLChar* mOpenChar;
 141   nsMathMLChar* mCloseChar;
 142   nsMathMLChar* mSeparatorsChar;
 143   PRInt32       mSeparatorsCount;
 144
 145   // clean up
 146   void
 147   RemoveFencesAndSeparators();
 148
 149   // add fences and separators when all child frames are known
 150   nsresult
 151   CreateFencesAndSeparators(nsPresContext* aPresContext);
 152 };
 153
 154 #endif /* nsMathMLmfencedFrame_h___ */