layout/tables/nsTableOuterFrame.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 nsTableOuterFrame_h__
  38 #define nsTableOuterFrame_h__
  39
  40 #include "nscore.h"
  41 #include "nsHTMLContainerFrame.h"
  42 #include "nsBlockFrame.h"
  43 #include "nsITableLayout.h"
  44
  45 struct nsStyleTable;
  46 class nsTableFrame;
  47
  48 class nsTableCaptionFrame : public nsBlockFrame
  49 {
  50 public:
  51   NS_DECL_FRAMEARENA_HELPERS
  52
  53   // nsISupports
  54   virtual nsIAtom* GetType() const;
  55   friend nsIFrame* NS_NewTableCaptionFrame(nsIPresShell* aPresShell, nsStyleContext*  aContext);
  56
  57   virtual nsSize ComputeAutoSize(nsIRenderingContext *aRenderingContext,
  58                                  nsSize aCBSize, nscoord aAvailableWidth,
  59                                  nsSize aMargin, nsSize aBorder,
  60                                  nsSize aPadding, PRBool aShrinkWrap);
  61
  62   NS_IMETHOD GetParentStyleContextFrame(nsPresContext* aPresContext,
  63                                         nsIFrame**      aProviderFrame,
  64                                         PRBool*         aIsChild);
  65 #ifdef ACCESSIBILITY
  66   virtual already_AddRefed<nsAccessible> CreateAccessible();
  67 #endif
  68
  69 #ifdef NS_DEBUG
  70   NS_IMETHOD GetFrameName(nsAString& aResult) const;
  71 #endif
  72
  73 protected:
  74   nsTableCaptionFrame(nsStyleContext*  aContext);
  75   virtual ~nsTableCaptionFrame();
  76 };
  77
  78
  79 /* TODO
  80 1. decide if we'll allow subclassing.  If so, decide which methods really need to be virtual.
  81 */
  82
  83 /**
  84  * main frame for an nsTable content object,
  85  * the nsTableOuterFrame contains 0 or one caption frame, and a nsTableFrame
  86  * pseudo-frame (referred to as the "inner frame').
  87  */
  88 class nsTableOuterFrame : public nsHTMLContainerFrame, public nsITableLayout
  89 {
  90 public:
  91   NS_DECL_QUERYFRAME
  92   NS_DECL_FRAMEARENA_HELPERS
  93
  94   /** instantiate a new instance of nsTableRowFrame.
  95     * @param aPresShell the pres shell for this frame
  96     *
  97     * @return           the frame that was created
  98     */
  99   friend nsIFrame* NS_NewTableOuterFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
 100
 101   // nsIFrame overrides - see there for a description
 102
 103   virtual void DestroyFrom(nsIFrame* aDestructRoot);
 104
 105   virtual PRBool IsContainingBlock() const;
 106
 107   NS_IMETHOD SetInitialChildList(nsIAtom*        aListName,
 108                                  nsFrameList&    aChildList);
 109
 110   virtual nsFrameList GetChildList(nsIAtom* aListName) const;
 111
 112   virtual nsIAtom* GetAdditionalChildListName(PRInt32 aIndex) const;
 113
 114   NS_IMETHOD AppendFrames(nsIAtom*        aListName,
 115                           nsFrameList&    aFrameList);
 116
 117   NS_IMETHOD InsertFrames(nsIAtom*        aListName,
 118                           nsIFrame*       aPrevFrame,
 119                           nsFrameList&    aFrameList);
 120
 121   NS_IMETHOD RemoveFrame(nsIAtom*        aListName,
 122                          nsIFrame*       aOldFrame);
 123
 124   virtual nsIFrame* GetContentInsertionFrame() {
 125     return GetFirstChild(nsnull)->GetContentInsertionFrame();
 126   }
 127
 128 #ifdef ACCESSIBILITY
 129   virtual already_AddRefed<nsAccessible> CreateAccessible();
 130 #endif
 131
 132   NS_IMETHOD BuildDisplayList(nsDisplayListBuilder*   aBuilder,
 133                               const nsRect&           aDirtyRect,
 134                               const nsDisplayListSet& aLists);
 135
 136   nsresult BuildDisplayListForInnerTable(nsDisplayListBuilder*   aBuilder,
 137                                          const nsRect&           aDirtyRect,
 138                                          const nsDisplayListSet& aLists);
 139
 140   virtual nscoord GetBaseline() const;
 141
 142   virtual nscoord GetMinWidth(nsIRenderingContext *aRenderingContext);
 143   virtual nscoord GetPrefWidth(nsIRenderingContext *aRenderingContext);
 144   virtual nsSize ComputeAutoSize(nsIRenderingContext *aRenderingContext,
 145                                  nsSize aCBSize, nscoord aAvailableWidth,
 146                                  nsSize aMargin, nsSize aBorder,
 147                                  nsSize aPadding, PRBool aShrinkWrap);
 148
 149   /** process a reflow command for the table.
 150     * This involves reflowing the caption and the inner table.
 151     * @see nsIFrame::Reflow */
 152   NS_IMETHOD Reflow(nsPresContext*          aPresContext,
 153                     nsHTMLReflowMetrics&     aDesiredSize,
 154                     const nsHTMLReflowState& aReflowState,
 155                     nsReflowStatus&          aStatus);
 156
 157   /**
 158    * Get the "type" of the frame
 159    *
 160    * @see nsGkAtoms::tableOuterFrame
 161    */
 162   virtual nsIAtom* GetType() const;
 163
 164 #ifdef DEBUG
 165   NS_IMETHOD GetFrameName(nsAString& aResult) const;
 166 #endif
 167
 168   /** SetSelected needs to be overridden to talk to inner tableframe
 169    */
 170   void SetSelected(PRBool aSelected,
 171                    SelectionType aType);
 172
 173   NS_IMETHOD GetParentStyleContextFrame(nsPresContext* aPresContext,
 174                                         nsIFrame**      aProviderFrame,
 175                                         PRBool*         aIsChild);
 176
 177   /*---------------- nsITableLayout methods ------------------------*/
 178
 179   /** @see nsITableFrame::GetCellDataAt */
 180   NS_IMETHOD GetCellDataAt(PRInt32 aRowIndex, PRInt32 aColIndex,
 181                            nsIDOMElement* &aCell,   //out params
 182                            PRInt32& aStartRowIndex, PRInt32& aStartColIndex,
 183                            PRInt32& aRowSpan, PRInt32& aColSpan,
 184                            PRInt32& aActualRowSpan, PRInt32& aActualColSpan,
 185                            PRBool& aIsSelected);
 186
 187   /** @see nsITableFrame::GetTableSize */
 188   NS_IMETHOD GetTableSize(PRInt32& aRowCount, PRInt32& aColCount);
 189
 190   NS_IMETHOD GetIndexByRowAndColumn(PRInt32 aRow, PRInt32 aColumn, PRInt32 *aIndex);
 191   NS_IMETHOD GetRowAndColumnByIndex(PRInt32 aIndex, PRInt32 *aRow, PRInt32 *aColumn);
 192
 193 protected:
 194
 195
 196   nsTableOuterFrame(nsStyleContext* aContext);
 197   virtual ~nsTableOuterFrame();
 198
 199   void InitChildReflowState(nsPresContext&    aPresContext,
 200                             nsHTMLReflowState& aReflowState);
 201
 202   /** Always returns 0, since the outer table frame has no border of its own
 203     * The inner table frame can answer this question in a meaningful way.
 204     * @see nsHTMLContainerFrame::GetSkipSides */
 205   virtual PRIntn GetSkipSides() const;
 206
 207   PRUint8 GetCaptionSide(); // NS_STYLE_CAPTION_SIDE_* or NO_SIDE
 208
 209   PRBool HasSideCaption() {
 210     PRUint8 captionSide = GetCaptionSide();
 211     return captionSide == NS_STYLE_CAPTION_SIDE_LEFT ||
 212            captionSide == NS_STYLE_CAPTION_SIDE_RIGHT;
 213   }
 214
 215   PRUint8 GetCaptionVerticalAlign();
 216
 217   void SetDesiredSize(PRUint8         aCaptionSide,
 218                       const nsMargin& aInnerMargin,
 219                       const nsMargin& aCaptionMargin,
 220                       nscoord&        aWidth,
 221                       nscoord&        aHeight);
 222
 223   nsresult   GetCaptionOrigin(PRUint32         aCaptionSide,
 224                               const nsSize&    aContainBlockSize,
 225                               const nsSize&    aInnerSize,
 226                               const nsMargin&  aInnerMargin,
 227                               const nsSize&    aCaptionSize,
 228                               nsMargin&        aCaptionMargin,
 229                               nsPoint&         aOrigin);
 230
 231   nsresult   GetInnerOrigin(PRUint32         aCaptionSide,
 232                             const nsSize&    aContainBlockSize,
 233                             const nsSize&    aCaptionSize,
 234                             const nsMargin&  aCaptionMargin,
 235                             const nsSize&    aInnerSize,
 236                             nsMargin&        aInnerMargin,
 237                             nsPoint&         aOrigin);
 238
 239   // reflow the child (caption or innertable frame)
 240   void OuterBeginReflowChild(nsPresContext*           aPresContext,
 241                              nsIFrame*                aChildFrame,
 242                              const nsHTMLReflowState& aOuterRS,
 243                              void*                    aChildRSSpace,
 244                              nscoord                  aAvailWidth);
 245
 246   nsresult OuterDoReflowChild(nsPresContext*           aPresContext,
 247                               nsIFrame*                aChildFrame,
 248                               const nsHTMLReflowState& aChildRS,
 249                               nsHTMLReflowMetrics&     aMetrics,
 250                               nsReflowStatus&          aStatus);
 251
 252   // Set the reflow metrics
 253   void UpdateReflowMetrics(PRUint8              aCaptionSide,
 254                            nsHTMLReflowMetrics& aMet,
 255                            const nsMargin&      aInnerMargin,
 256                            const nsMargin&      aCaptionMargin);
 257
 258   // Get the margin.  aMarginNoAuto is aMargin, but with auto
 259   // margins set to 0
 260   void GetChildMargin(nsPresContext*           aPresContext,
 261                       const nsHTMLReflowState& aOuterRS,
 262                       nsIFrame*                aChildFrame,
 263                       nscoord                  aAvailableWidth,
 264                       nsMargin&                aMargin);
 265
 266 private:
 267   // used to keep track of this frame's children. They are redundant with mFrames, but more convient
 268   nsTableFrame* mInnerTableFrame;
 269   nsFrameList   mCaptionFrames;
 270   nsIFrame*     mCaptionFrame;
 271 };
 272
 273 inline PRIntn nsTableOuterFrame::GetSkipSides() const
 274 { return 0; }
 275
 276 #endif
 277
 278
 279