layout/xul/nsBoxFrame.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /**
   8
   9   Eric D Vaughan
  10   nsBoxFrame is a frame that can lay its children out either vertically or
  11 horizontally. It lays them out according to a min max or preferred size.
  12
  13 **/
  14
  15 #ifndef nsBoxFrame_h___
  16 #define nsBoxFrame_h___
  17
  18 #include "mozilla/Attributes.h"
  19 #include "nsCOMPtr.h"
  20 #include "nsContainerFrame.h"
  21 #include "nsBoxLayout.h"
  22
  23 class nsBoxLayoutState;
  24
  25 namespace mozilla {
  26 class PresShell;
  27 namespace gfx {
  28 class DrawTarget;
  29 }  // namespace gfx
  30 }  // namespace mozilla
  31
  32 nsIFrame* NS_NewBoxFrame(mozilla::PresShell* aPresShell,
  33                          mozilla::ComputedStyle* aStyle, bool aIsRoot,
  34                          nsBoxLayout* aLayoutManager);
  35 nsIFrame* NS_NewBoxFrame(mozilla::PresShell* aPresShell,
  36                          mozilla::ComputedStyle* aStyle);
  37
  38 class nsBoxFrame : public nsContainerFrame {
  39  protected:
  40   typedef mozilla::gfx::DrawTarget DrawTarget;
  41
  42  public:
  43   NS_DECL_FRAMEARENA_HELPERS(nsBoxFrame)
  44 #ifdef DEBUG
  45   NS_DECL_QUERYFRAME
  46 #endif
  47
  48   friend nsIFrame* NS_NewBoxFrame(mozilla::PresShell* aPresShell,
  49                                   ComputedStyle* aStyle, bool aIsRoot,
  50                                   nsBoxLayout* aLayoutManager);
  51   friend nsIFrame* NS_NewBoxFrame(mozilla::PresShell* aPresShell,
  52                                   ComputedStyle* aStyle);
  53
  54   // gets the rect inside our border and debug border. If you wish to paint
  55   // inside a box call this method to get the rect so you don't draw on the
  56   // debug border or outer border.
  57
  58   virtual void SetXULLayoutManager(nsBoxLayout* aLayout) override {
  59     mLayoutManager = aLayout;
  60   }
  61   virtual nsBoxLayout* GetXULLayoutManager() override { return mLayoutManager; }
  62
  63   virtual nsSize GetXULPrefSize(nsBoxLayoutState& aBoxLayoutState) override;
  64   virtual nsSize GetXULMinSize(nsBoxLayoutState& aBoxLayoutState) override;
  65   virtual nsSize GetXULMaxSize(nsBoxLayoutState& aBoxLayoutState) override;
  66   virtual nscoord GetXULFlex() override;
  67   virtual nscoord GetXULBoxAscent(nsBoxLayoutState& aBoxLayoutState) override;
  68   virtual Valignment GetXULVAlign() const override { return mValign; }
  69   virtual Halignment GetXULHAlign() const override { return mHalign; }
  70   NS_IMETHOD DoXULLayout(nsBoxLayoutState& aBoxLayoutState) override;
  71
  72   virtual bool XULComputesOwnOverflowArea() override { return false; }
  73
  74   // ----- child and sibling operations ---
  75
  76   // ----- public methods -------
  77
  78   virtual void Init(nsIContent* aContent, nsContainerFrame* aParent,
  79                     nsIFrame* aPrevInFlow) override;
  80
  81   virtual nsresult AttributeChanged(int32_t aNameSpaceID, nsAtom* aAttribute,
  82                                     int32_t aModType) override;
  83
  84   virtual void MarkIntrinsicISizesDirty() override;
  85   virtual nscoord GetMinISize(gfxContext* aRenderingContext) override;
  86   virtual nscoord GetPrefISize(gfxContext* aRenderingContext) override;
  87
  88   virtual void Reflow(nsPresContext* aPresContext, ReflowOutput& aDesiredSize,
  89                       const ReflowInput& aReflowInput,
  90                       nsReflowStatus& aStatus) override;
  91
  92   virtual void SetInitialChildList(ChildListID aListID,
  93                                    nsFrameList& aChildList) override;
  94   virtual void AppendFrames(ChildListID aListID,
  95                             nsFrameList& aFrameList) override;
  96   virtual void InsertFrames(ChildListID aListID, nsIFrame* aPrevFrame,
  97                             const nsLineList::iterator* aPrevFrameLine,
  98                             nsFrameList& aFrameList) override;
  99   virtual void RemoveFrame(ChildListID aListID, nsIFrame* aOldFrame) override;
 100
 101   virtual nsContainerFrame* GetContentInsertionFrame() override;
 102
 103   virtual void DidSetComputedStyle(ComputedStyle* aOldComputedStyle) override;
 104
 105   virtual bool IsFrameOfType(uint32_t aFlags) const override {
 106     // record that children that are ignorable whitespace should be excluded
 107     // (When content was loaded via the XUL content sink, it's already
 108     // been excluded, but we need this for when the XUL namespace is used
 109     // in other MIME types or when the XUL CSS display types are used with
 110     // non-XUL elements.)
 111
 112     // This is bogus, but it's what we've always done.
 113     // (Given that we're replaced, we need to say we're a replaced element
 114     // that contains a block so ReflowInput doesn't tell us to be
 115     // NS_UNCONSTRAINEDSIZE wide.)
 116     return nsContainerFrame::IsFrameOfType(
 117         aFlags &
 118         ~(nsIFrame::eReplaced | nsIFrame::eReplacedContainsBlock | eXULBox));
 119   }
 120
 121 #ifdef DEBUG_FRAME_DUMP
 122   virtual nsresult GetFrameName(nsAString& aResult) const override;
 123 #endif
 124
 125   virtual void DidReflow(nsPresContext* aPresContext,
 126                          const ReflowInput* aReflowInput) override;
 127
 128   virtual bool HonorPrintBackgroundSettings() const override;
 129
 130   // virtual so nsStackFrame, nsButtonBoxFrame, nsSliderFrame and nsMenuFrame
 131   // can override it
 132   virtual void BuildDisplayListForChildren(nsDisplayListBuilder* aBuilder,
 133                                            const nsDisplayListSet& aLists);
 134
 135   virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
 136                                 const nsDisplayListSet& aLists) override;
 137
 138   static nsresult LayoutChildAt(nsBoxLayoutState& aState, nsIFrame* aBox,
 139                                 const nsRect& aRect);
 140
 141   /**
 142    * Utility method to redirect events on descendants to this frame.
 143    * Supports 'allowevents' attribute on descendant elements to allow those
 144    * elements and their descendants to receive events.
 145    */
 146   void WrapListsInRedirector(nsDisplayListBuilder* aBuilder,
 147                              const nsDisplayListSet& aIn,
 148                              const nsDisplayListSet& aOut);
 149
 150   /**
 151    * Return our wrapper block, if any.
 152    */
 153   void AppendDirectlyOwnedAnonBoxes(nsTArray<OwnedAnonBox>& aResult) override;
 154
 155   // Gets a next / prev sibling accounting for ordinal group. Slow, please avoid
 156   // usage if possible.
 157   static nsIFrame* SlowOrdinalGroupAwareSibling(nsIFrame*, bool aNext);
 158
 159  private:
 160   explicit nsBoxFrame(ComputedStyle* aStyle, nsPresContext* aPresContext)
 161       : nsBoxFrame(aStyle, aPresContext, kClassID, false, nullptr) {}
 162
 163  protected:
 164   nsBoxFrame(ComputedStyle* aStyle, nsPresContext* aPresContext, ClassID aID,
 165              bool aIsRoot = false, nsBoxLayout* aLayoutManager = nullptr);
 166   virtual ~nsBoxFrame();
 167
 168   virtual bool GetInitialEqualSize(bool& aEqualSize);
 169   virtual void GetInitialOrientation(bool& aIsHorizontal);
 170   virtual void GetInitialDirection(bool& aIsNormal);
 171   virtual bool GetInitialHAlignment(Halignment& aHalign);
 172   virtual bool GetInitialVAlignment(Valignment& aValign);
 173   virtual bool GetInitialAutoStretch(bool& aStretch);
 174
 175   virtual void DestroyFrom(nsIFrame* aDestructRoot,
 176                            PostDestroyData& aPostDestroyData) override;
 177
 178   nsSize mPrefSize;
 179   nsSize mMinSize;
 180   nsSize mMaxSize;
 181   nscoord mFlex;
 182   nscoord mAscent;
 183
 184   nsCOMPtr<nsBoxLayout> mLayoutManager;
 185
 186   // Get the point associated with this event. Returns true if a single valid
 187   // point was found. Otherwise false.
 188   bool GetEventPoint(mozilla::WidgetGUIEvent* aEvent, nsPoint& aPoint);
 189   // Gets the event coordinates relative to the widget offset associated with
 190   // this frame. Return true if a single valid point was found.
 191   bool GetEventPoint(mozilla::WidgetGUIEvent* aEvent,
 192                      mozilla::LayoutDeviceIntPoint& aPoint);
 193
 194  private:
 195   void CacheAttributes();
 196
 197   // instance variables.
 198   Halignment mHalign;
 199   Valignment mValign;
 200
 201 };  // class nsBoxFrame
 202
 203 #endif