layout/mathml/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  *   Frederic Wang <fred.wang@free.fr>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either of the GNU General Public License Version 2 or later (the "GPL"),
  29  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #ifndef nsMathMLmfencedFrame_h___
  42 #define nsMathMLmfencedFrame_h___
  43
  44 #include "nsCOMPtr.h"
  45 #include "nsMathMLContainerFrame.h"
  46
  47 //
  48 // <mfenced> -- surround content with a pair of fences
  49 //
  50
  51 class nsMathMLmfencedFrame : public nsMathMLContainerFrame {
  52 public:
  53   NS_DECL_FRAMEARENA_HELPERS
  54
  55   friend nsIFrame* NS_NewMathMLmfencedFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
  56
  57   virtual void
  58   SetAdditionalStyleContext(PRInt32          aIndex,
  59                             nsStyleContext*  aStyleContext);
  60   virtual nsStyleContext*
  61   GetAdditionalStyleContext(PRInt32 aIndex) const;
  62
  63   NS_IMETHOD
  64   InheritAutomaticData(nsIFrame* aParent);
  65
  66   NS_IMETHOD
  67   SetInitialChildList(nsIAtom*        aListName,
  68                       nsFrameList&    aChildList);
  69
  70   NS_IMETHOD
  71   Reflow(nsPresContext*          aPresContext,
  72          nsHTMLReflowMetrics&     aDesiredSize,
  73          const nsHTMLReflowState& aReflowState,
  74          nsReflowStatus&          aStatus);
  75
  76   NS_IMETHOD BuildDisplayList(nsDisplayListBuilder*   aBuilder,
  77                               const nsRect&           aDirtyRect,
  78                               const nsDisplayListSet& aLists);
  79
  80   virtual nscoord
  81   GetIntrinsicWidth(nsIRenderingContext* aRenderingContext);
  82
  83   NS_IMETHOD
  84   AttributeChanged(PRInt32         aNameSpaceID,
  85                    nsIAtom*        aAttribute,
  86                    PRInt32         aModType);
  87
  88   // override the base method because we must keep separators in sync
  89   virtual nsresult
  90   ChildListChanged(PRInt32 aModType);
  91
  92   // override the base method so that we can deal with fences and separators
  93   virtual nscoord
  94   FixInterFrameSpacing(nsHTMLReflowMetrics& aDesiredSize);
  95
  96   // helper routines to format the MathMLChars involved here
  97   static nsresult
  98   ReflowChar(nsPresContext*      aPresContext,
  99              nsIRenderingContext& aRenderingContext,
 100              nsMathMLChar*        aMathMLChar,
 101              nsOperatorFlags      aForm,
 102              PRInt32              aScriptLevel,
 103              nscoord              axisHeight,
 104              nscoord              leading,
 105              nscoord              em,
 106              nsBoundingMetrics&   aContainerSize,
 107              nscoord&             aAscent,
 108              nscoord&             aDescent);
 109
 110   static void
 111   PlaceChar(nsMathMLChar*      aMathMLChar,
 112             nscoord            aDesiredSize,
 113             nsBoundingMetrics& bm,
 114             nscoord&           dx);
 115
 116 protected:
 117   nsMathMLmfencedFrame(nsStyleContext* aContext) : nsMathMLContainerFrame(aContext) {}
 118   virtual ~nsMathMLmfencedFrame();
 119
 120   virtual PRIntn GetSkipSides() const { return 0; }
 121
 122   nsMathMLChar* mOpenChar;
 123   nsMathMLChar* mCloseChar;
 124   nsMathMLChar* mSeparatorsChar;
 125   PRInt32       mSeparatorsCount;
 126
 127   // clean up
 128   void
 129   RemoveFencesAndSeparators();
 130
 131   // add fences and separators when all child frames are known
 132   nsresult
 133   CreateFencesAndSeparators(nsPresContext* aPresContext);
 134 };
 135
 136 #endif /* nsMathMLmfencedFrame_h___ */