layout/generic/nsFirstLetterFrame.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 Communicator client 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
  38 #ifndef nsFirstLetterFrame_h__
  39 #define nsFirstLetterFrame_h__
  40
  41 /* rendering object for CSS :first-letter pseudo-element */
  42
  43 #include "nsHTMLContainerFrame.h"
  44
  45 #define nsFirstLetterFrameSuper nsHTMLContainerFrame
  46
  47 class nsFirstLetterFrame : public nsFirstLetterFrameSuper {
  48 public:
  49   NS_DECL_FRAMEARENA_HELPERS
  50
  51   nsFirstLetterFrame(nsStyleContext* aContext) : nsHTMLContainerFrame(aContext) {}
  52
  53   NS_IMETHOD Init(nsIContent*      aContent,
  54                   nsIFrame*        aParent,
  55                   nsIFrame*        aPrevInFlow);
  56   NS_IMETHOD SetInitialChildList(nsIAtom*        aListName,
  57                                  nsFrameList&    aChildList);
  58 #ifdef NS_DEBUG
  59   NS_IMETHOD GetFrameName(nsAString& aResult) const;
  60 #endif
  61   virtual nsIAtom* GetType() const;
  62
  63   virtual PRBool IsFrameOfType(PRUint32 aFlags) const
  64   {
  65     if (!GetStyleDisplay()->IsFloating())
  66       aFlags = aFlags & ~(nsIFrame::eLineParticipant);
  67     return nsFirstLetterFrameSuper::IsFrameOfType(aFlags &
  68       ~(nsIFrame::eBidiInlineContainer));
  69   }
  70
  71   virtual nscoord GetMinWidth(nsIRenderingContext *aRenderingContext);
  72   virtual nscoord GetPrefWidth(nsIRenderingContext *aRenderingContext);
  73   virtual void AddInlineMinWidth(nsIRenderingContext *aRenderingContext,
  74                                  InlineMinWidthData *aData);
  75   virtual void AddInlinePrefWidth(nsIRenderingContext *aRenderingContext,
  76                                   InlinePrefWidthData *aData);
  77   virtual nsSize ComputeSize(nsIRenderingContext *aRenderingContext,
  78                              nsSize aCBSize, nscoord aAvailableWidth,
  79                              nsSize aMargin, nsSize aBorder, nsSize aPadding,
  80                              PRBool aShrinkWrap);
  81   NS_IMETHOD Reflow(nsPresContext*          aPresContext,
  82                     nsHTMLReflowMetrics&     aDesiredSize,
  83                     const nsHTMLReflowState& aReflowState,
  84                     nsReflowStatus&          aStatus);
  85
  86   virtual PRBool CanContinueTextRun() const;
  87   virtual nscoord GetBaseline() const;
  88
  89 //override of nsFrame method
  90   NS_IMETHOD GetChildFrameContainingOffset(PRInt32 inContentOffset,
  91                                            PRBool inHint,
  92                                            PRInt32* outFrameContentOffset,
  93                                            nsIFrame **outChildFrame);
  94
  95   nscoord GetFirstLetterBaseline() const { return mBaseline; }
  96
  97   // For floating first letter frames, create a continuation for aChild and
  98   // place it in the correct place. aContinuation is an outparam for the
  99   // continuation that is created. aIsFluid determines if the continuation is
 100   // fluid or not.
 101   nsresult CreateContinuationForFloatingParent(nsPresContext* aPresContext,
 102                                                nsIFrame* aChild,
 103                                                nsIFrame** aContinuation,
 104                                                PRBool aIsFluid);
 105
 106 protected:
 107   nscoord mBaseline;
 108
 109   virtual PRIntn GetSkipSides() const;
 110
 111   void DrainOverflowFrames(nsPresContext* aPresContext);
 112 };
 113
 114 #endif /* nsFirstLetterFrame_h__ */