/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsFieldSetFrame_h___

#define nsFieldSetFrame_h___

#include "mozilla/Attributes.h"

#include "ImgDrawResult.h"

#include "nsContainerFrame.h"

class nsFieldSetFrame final : public nsContainerFrame

{

  typedef mozilla::image::ImgDrawResult ImgDrawResult;

public:

  NS_DECL_FRAMEARENA_HELPERS(nsFieldSetFrame)

  explicit nsFieldSetFrame(ComputedStyle* aStyle);

  nscoord

    GetIntrinsicISize(gfxContext* aRenderingContext,

                      nsLayoutUtils::IntrinsicISizeType);

  virtual nscoord GetMinISize(gfxContext* aRenderingContext) override;

  virtual nscoord GetPrefISize(gfxContext* aRenderingContext) override;

  /**

   * The area to paint box-shadows around.  It's the border rect except

   * when there's a <legend> we offset the y-position to the center of it.

   */

  virtual nsRect VisualBorderRectRelativeToSelf() const override;

  virtual void Reflow(nsPresContext* aPresContext,

                      ReflowOutput& aDesiredSize,

                      const ReflowInput& aReflowInput,

                      nsReflowStatus& aStatus) override;

  nscoord GetLogicalBaseline(mozilla::WritingMode aWM) const override;

  bool GetVerticalAlignBaseline(mozilla::WritingMode aWM,

                                nscoord* aBaseline) const override;

  bool GetNaturalBaselineBOffset(mozilla::WritingMode aWM,

                                 BaselineSharingGroup aBaselineGroup,

                                 nscoord* aBaseline) const override;

  virtual void BuildDisplayList(nsDisplayListBuilder*   aBuilder,

                                const nsDisplayListSet& aLists) override;

  ImgDrawResult PaintBorder(nsDisplayListBuilder* aBuilder,

                         gfxContext& aRenderingContext,

                         nsPoint aPt, const nsRect& aDirtyRect);

#ifdef DEBUG

  virtual void SetInitialChildList(ChildListID    aListID,

                                   nsFrameList&   aChildList) override;

  virtual void AppendFrames(ChildListID    aListID,

                            nsFrameList&   aFrameList) override;

  virtual void InsertFrames(ChildListID    aListID,

                            nsIFrame*      aPrevFrame,

                            nsFrameList&   aFrameList) override;

  virtual void RemoveFrame(ChildListID    aListID,

                           nsIFrame*      aOldFrame) override;

#endif

  virtual bool IsFrameOfType(uint32_t aFlags) const override

  {

    return nsContainerFrame::IsFrameOfType(aFlags &

             ~nsIFrame::eCanContainOverflowContainers);

  }

  virtual nsIScrollableFrame* GetScrollTargetFrame() override

  {

    return do_QueryFrame(GetInner());

  }

  // Return the block wrapper around our kids.

  void AppendDirectlyOwnedAnonBoxes(nsTArray<OwnedAnonBox>& aResult) override;

#ifdef ACCESSIBILITY

  virtual mozilla::a11y::AccType AccessibleType() override;

#endif

#ifdef DEBUG_FRAME_DUMP

  virtual nsresult GetFrameName(nsAString& aResult) const override {

    return MakeFrameName(NS_LITERAL_STRING("FieldSet"), aResult);

  }

#endif

  /**

   * Return the anonymous frame that contains all descendants except

   * the legend frame.  This is currently always a block frame with

   * pseudo nsCSSAnonBoxes::fieldsetContent() -- this may change in the

   * future when we add support for CSS overflow for <fieldset>.  This really

   * can't return null, though callers seem to feel that it can.

   */

  nsIFrame* GetInner() const;

  /**

   * Return the frame that represents the legend if any.  This may be

   * a nsLegendFrame or a nsHTMLScrollFrame with the nsLegendFrame as the

   * scrolled frame (aka content insertion frame).

   */

  nsIFrame* GetLegend() const;

protected:

  mozilla::LogicalRect mLegendRect;

  nscoord   mLegendSpace;

};

#endif // nsFieldSetFrame_h___