gecko-dev/layout/tables/nsTableRowGroupFrame.h

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */
#ifndef nsTableRowGroupFrame_h__
#define nsTableRowGroupFrame_h__

#include "nscore.h"
#include "nsContainerFrame.h"
#include "nsIAtom.h"

struct RowGroupReflowState;

/**
 * nsTableRowGroupFrame is the frame that maps row groups 
 * (HTML tags THEAD, TFOOT, and TBODY). This class cannot be reused
 * outside of an nsTableFrame.  It assumes that its parent is an nsTableFrame, and 
 * its children are nsTableRowFrames.
 * 
 * @see nsTableFrame
 * @see nsTableRowFrame
 *
 * @author  sclark
 */
class nsTableRowGroupFrame : public nsContainerFrame
{
public:

  /** instantiate a new instance of nsTableRowGroupFrame.
    * @param aInstancePtrResult  the new object is returned in this out-param
    * @param aContent            the table object to map
    * @param aParent             the parent of the new frame
    *
    * @return  NS_OK if the frame was properly allocated, otherwise an error code
    */
  static nsresult NewFrame(nsIFrame** aInstancePtrResult,
                           nsIContent* aContent,
                           nsIFrame*   aParent);

  /** @see nsIFrame::Paint */
  NS_IMETHOD Paint(nsIPresContext& aPresContext,
                   nsIRenderingContext& aRenderingContext,
                   const nsRect& aDirtyRect);

  /** ask all children to paint themselves, without clipping (for cells with rowspan>1)
    * @see nsIFrame::Paint 
    */
  virtual void PaintChildren(nsIPresContext&      aPresContext,
                             nsIRenderingContext& aRenderingContext,
                             const nsRect&        aDirtyRect);

  /** calls Reflow for all of its child rows.
    * Rows are all set to the same width and stacked vertically.
    * <P> rows are not split unless absolutely necessary.
    *
    * @param aDesiredSize width set to width of rows, height set to 
    *                     sum of height of rows that fit in aMaxSize.height.
    *
    * @see nsIFrame::Reflow
    */
  NS_IMETHOD Reflow(nsIPresContext& aPresContext,
                    nsReflowMetrics& aDesiredSize,
                    const nsReflowState& aReflowState,
                    nsReflowStatus& aStatus);

  /** @see nsContainerFrame::CreateContinuingFrame */
  NS_IMETHOD CreateContinuingFrame(nsIPresContext&  aPresContext,
                                   nsIFrame*        aParent,
                                   nsIStyleContext* aStyleContext,
                                   nsIFrame*&       aContinuingFrame);

  /** returns the type of the mapped row group content in aType.
    * caller MUST call release on the returned object if it is not null.
    *
    * @param  aType out param filled with the type of the mapped content, or null if none.
    *
    * @return NS_OK
    */ 
  NS_IMETHOD GetRowGroupType(nsIAtom *& aType);

  /** return the number of contained rows */
  PRInt32 GetRowCount ();

  NS_IMETHOD  List(FILE* out = stdout, PRInt32 aIndent = 0, nsIListFilter *aFilter = nsnull) const;


protected:

  /** protected constructor.
    * @see NewFrame
    */
  nsTableRowGroupFrame(nsIContent* aContent, nsIFrame* aParentFrame);

  /** protected destructor */
  ~nsTableRowGroupFrame();

  nscoord GetTopMarginFor(nsIPresContext*      aCX,
                          RowGroupReflowState& aState,
                          const nsMargin&      aKidMargin);

  void          PlaceChild( nsIPresContext*      aPresContext,
                            RowGroupReflowState& aState,
                            nsIFrame*            aKidFrame,
                            const nsRect&        aKidRect,
                            nsSize*              aMaxElementSize,
                            nsSize&              aKidMaxElementSize);

  void ShrinkWrapChildren(nsIPresContext* aPresContext, 
                          nsReflowMetrics& aDesiredSize);

  nsresult AdjustSiblingsAfterReflow(nsIPresContext*      aPresContext,
                                     RowGroupReflowState& aState,
                                     nsIFrame*            aKidFrame,
                                     nscoord              aDeltaY);

  /**
   * Reflow the frames we've already created
   *
   * @param   aPresContext presentation context to use
   * @param   aState current inline state
   * @return  true if we successfully reflowed all the mapped children and false
   *            otherwise, e.g. we pushed children to the next in flow
   */
  PRBool        ReflowMappedChildren(nsIPresContext*      aPresContext,
                                     RowGroupReflowState& aState,
                                     nsSize*              aMaxElementSize);

  /**
   * Try and pull-up frames from our next-in-flow
   *
   * @param   aPresContext presentation context to use
   * @param   aState current inline state
   * @return  true if we successfully pulled-up all the children and false
   *            otherwise, e.g. child didn't fit
   */
  PRBool        PullUpChildren(nsIPresContext*      aPresContext,
                               RowGroupReflowState& aState,
                               nsSize*              aMaxElementSize);

  /**
   * Create new frames for content we haven't yet mapped
   *
   * @param   aPresContext presentation context to use
   * @param   aState current inline state
   * @return  frComplete if all content has been mapped and frNotComplete
   *            if we should be continued
   */
  nsReflowStatus  ReflowUnmappedChildren(nsIPresContext*      aPresContext,
                                         RowGroupReflowState& aState,
                                         nsSize*              aMaxElementSize);

private:
  nsIAtom *mType;

};

//XXX: change this if row groups can contain non-row types
// in this case, iterate through kids and add 1 if the kid's display type is "row"
inline PRInt32 nsTableRowGroupFrame::GetRowCount ()
{
  PRInt32 result = 0;
  ChildCount(result);
  return result;
}

#endif