michael@0: /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #ifndef nsTreeBodyFrame_h
michael@0: #define nsTreeBodyFrame_h
michael@0: 
michael@0: #include "mozilla/Attributes.h"
michael@0: 
michael@0: #include "nsLeafBoxFrame.h"
michael@0: #include "nsITreeView.h"
michael@0: #include "nsICSSPseudoComparator.h"
michael@0: #include "nsIScrollbarMediator.h"
michael@0: #include "nsITimer.h"
michael@0: #include "nsIReflowCallback.h"
michael@0: #include "nsTArray.h"
michael@0: #include "nsTreeStyleCache.h"
michael@0: #include "nsTreeColumns.h"
michael@0: #include "nsAutoPtr.h"
michael@0: #include "nsDataHashtable.h"
michael@0: #include "imgIRequest.h"
michael@0: #include "imgINotificationObserver.h"
michael@0: #include "nsScrollbarFrame.h"
michael@0: #include "nsThreadUtils.h"
michael@0: #include "mozilla/LookAndFeel.h"
michael@0: #include "nsIScrollbarOwner.h"
michael@0: 
michael@0: class nsOverflowChecker;
michael@0: class nsTreeImageListener;
michael@0: 
michael@0: namespace mozilla {
michael@0: namespace layout {
michael@0: class ScrollbarActivity;
michael@0: }
michael@0: }
michael@0: 
michael@0: // An entry in the tree's image cache
michael@0: struct nsTreeImageCacheEntry
michael@0: {
michael@0:   nsTreeImageCacheEntry() {}
michael@0:   nsTreeImageCacheEntry(imgIRequest *aRequest, imgINotificationObserver *aListener)
michael@0:     : request(aRequest), listener(aListener) {}
michael@0: 
michael@0:   nsCOMPtr<imgIRequest> request;
michael@0:   nsCOMPtr<imgINotificationObserver> listener;
michael@0: };
michael@0: 
michael@0: // The actual frame that paints the cells and rows.
michael@0: class nsTreeBodyFrame MOZ_FINAL
michael@0:   : public nsLeafBoxFrame
michael@0:   , public nsICSSPseudoComparator
michael@0:   , public nsIScrollbarMediator
michael@0:   , public nsIReflowCallback
michael@0:   , public nsIScrollbarOwner
michael@0: {
michael@0: public:
michael@0:   typedef mozilla::layout::ScrollbarActivity ScrollbarActivity;
michael@0: 
michael@0:   nsTreeBodyFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
michael@0:   ~nsTreeBodyFrame();
michael@0: 
michael@0:   NS_DECL_QUERYFRAME_TARGET(nsTreeBodyFrame)
michael@0:   NS_DECL_QUERYFRAME
michael@0:   NS_DECL_FRAMEARENA_HELPERS
michael@0: 
michael@0:   // Callback handler methods for refresh driver based animations.
michael@0:   // Calls to these functions are forwarded from nsTreeImageListener. These
michael@0:   // mirror how nsImageFrame works.
michael@0:   nsresult OnImageIsAnimated(imgIRequest* aRequest);
michael@0: 
michael@0:   // non-virtual signatures like nsITreeBodyFrame
michael@0:   already_AddRefed<nsTreeColumns> Columns() const
michael@0:   {
michael@0:     nsRefPtr<nsTreeColumns> cols = mColumns;
michael@0:     return cols.forget();
michael@0:   }
michael@0:   already_AddRefed<nsITreeView> GetExistingView() const
michael@0:   {
michael@0:     nsCOMPtr<nsITreeView> view = mView;
michael@0:     return view.forget();
michael@0:   }
michael@0:   nsresult GetView(nsITreeView **aView);
michael@0:   nsresult SetView(nsITreeView *aView);
michael@0:   nsresult GetFocused(bool *aFocused);
michael@0:   nsresult SetFocused(bool aFocused);
michael@0:   nsresult GetTreeBody(nsIDOMElement **aElement);
michael@0:   nsresult GetRowHeight(int32_t *aValue);
michael@0:   nsresult GetRowWidth(int32_t *aValue);
michael@0:   nsresult GetHorizontalPosition(int32_t *aValue);
michael@0:   nsresult GetSelectionRegion(nsIScriptableRegion **aRegion);
michael@0:   int32_t FirstVisibleRow() const { return mTopRowIndex; }
michael@0:   int32_t LastVisibleRow() const { return mTopRowIndex + mPageLength; }
michael@0:   int32_t PageLength() const { return mPageLength; }
michael@0:   nsresult EnsureRowIsVisible(int32_t aRow);
michael@0:   nsresult EnsureCellIsVisible(int32_t aRow, nsITreeColumn *aCol);
michael@0:   nsresult ScrollToRow(int32_t aRow);
michael@0:   nsresult ScrollByLines(int32_t aNumLines);
michael@0:   nsresult ScrollByPages(int32_t aNumPages);
michael@0:   nsresult ScrollToCell(int32_t aRow, nsITreeColumn *aCol);
michael@0:   nsresult ScrollToColumn(nsITreeColumn *aCol);
michael@0:   nsresult ScrollToHorizontalPosition(int32_t aValue);
michael@0:   nsresult Invalidate();
michael@0:   nsresult InvalidateColumn(nsITreeColumn *aCol);
michael@0:   nsresult InvalidateRow(int32_t aRow);
michael@0:   nsresult InvalidateCell(int32_t aRow, nsITreeColumn *aCol);
michael@0:   nsresult InvalidateRange(int32_t aStart, int32_t aEnd);
michael@0:   nsresult InvalidateColumnRange(int32_t aStart, int32_t aEnd,
michael@0:                                  nsITreeColumn *aCol);
michael@0:   nsresult GetRowAt(int32_t aX, int32_t aY, int32_t *aValue);
michael@0:   nsresult GetCellAt(int32_t aX, int32_t aY, int32_t *aRow,
michael@0:                      nsITreeColumn **aCol, nsACString &aChildElt);
michael@0:   nsresult GetCoordsForCellItem(int32_t aRow, nsITreeColumn *aCol,
michael@0:                                 const nsACString &aElt,
michael@0:                                 int32_t *aX, int32_t *aY,
michael@0:                                 int32_t *aWidth, int32_t *aHeight);
michael@0:   nsresult IsCellCropped(int32_t aRow, nsITreeColumn *aCol, bool *aResult);
michael@0:   nsresult RowCountChanged(int32_t aIndex, int32_t aCount);
michael@0:   nsresult BeginUpdateBatch();
michael@0:   nsresult EndUpdateBatch();
michael@0:   nsresult ClearStyleAndImageCaches();
michael@0: 
michael@0:   void ManageReflowCallback(const nsRect& aRect, nscoord aHorzWidth);
michael@0: 
michael@0:   virtual nsSize GetMinSize(nsBoxLayoutState& aBoxLayoutState) MOZ_OVERRIDE;
michael@0:   virtual void SetBounds(nsBoxLayoutState& aBoxLayoutState, const nsRect& aRect,
michael@0:                          bool aRemoveOverflowArea = false) MOZ_OVERRIDE;
michael@0: 
michael@0:   // nsIReflowCallback
michael@0:   virtual bool ReflowFinished() MOZ_OVERRIDE;
michael@0:   virtual void ReflowCallbackCanceled() MOZ_OVERRIDE;
michael@0: 
michael@0:   // nsICSSPseudoComparator
michael@0:   virtual bool PseudoMatches(nsCSSSelector* aSelector) MOZ_OVERRIDE;
michael@0: 
michael@0:   // nsIScrollbarMediator
michael@0:   NS_IMETHOD PositionChanged(nsScrollbarFrame* aScrollbar, int32_t aOldIndex, int32_t& aNewIndex) MOZ_OVERRIDE;
michael@0:   NS_IMETHOD ScrollbarButtonPressed(nsScrollbarFrame* aScrollbar, int32_t aOldIndex, int32_t aNewIndex) MOZ_OVERRIDE;
michael@0:   NS_IMETHOD VisibilityChanged(bool aVisible) MOZ_OVERRIDE { Invalidate(); return NS_OK; }
michael@0: 
michael@0:   // nsIScrollbarOwner
michael@0:   virtual nsIFrame* GetScrollbarBox(bool aVertical) MOZ_OVERRIDE {
michael@0:     ScrollParts parts = GetScrollParts();
michael@0:     return aVertical ? parts.mVScrollbar : parts.mHScrollbar;
michael@0:   }
michael@0: 
michael@0:   // Overridden from nsIFrame to cache our pres context.
michael@0:   virtual void Init(nsIContent*     aContent,
michael@0:                     nsIFrame*       aParent,
michael@0:                     nsIFrame*       aPrevInFlow) MOZ_OVERRIDE;
michael@0:   virtual void DestroyFrom(nsIFrame* aDestructRoot) MOZ_OVERRIDE;
michael@0: 
michael@0:   virtual nsresult GetCursor(const nsPoint& aPoint,
michael@0:                              nsIFrame::Cursor& aCursor) MOZ_OVERRIDE;
michael@0: 
michael@0:   virtual nsresult HandleEvent(nsPresContext* aPresContext,
michael@0:                                mozilla::WidgetGUIEvent* aEvent,
michael@0:                                nsEventStatus* aEventStatus) MOZ_OVERRIDE;
michael@0: 
michael@0:   virtual void BuildDisplayList(nsDisplayListBuilder*   aBuilder,
michael@0:                                 const nsRect&           aDirtyRect,
michael@0:                                 const nsDisplayListSet& aLists) MOZ_OVERRIDE;
michael@0: 
michael@0:   virtual void DidSetStyleContext(nsStyleContext* aOldStyleContext) MOZ_OVERRIDE;
michael@0: 
michael@0:   friend nsIFrame* NS_NewTreeBodyFrame(nsIPresShell* aPresShell);
michael@0:   friend class nsTreeColumn;
michael@0: 
michael@0:   struct ScrollParts {
michael@0:     nsScrollbarFrame*    mVScrollbar;
michael@0:     nsCOMPtr<nsIContent> mVScrollbarContent;
michael@0:     nsScrollbarFrame*    mHScrollbar;
michael@0:     nsCOMPtr<nsIContent> mHScrollbarContent;
michael@0:     nsIFrame*            mColumnsFrame;
michael@0:     nsIScrollableFrame*  mColumnsScrollFrame;
michael@0:   };
michael@0: 
michael@0:   void PaintTreeBody(nsRenderingContext& aRenderingContext,
michael@0:                      const nsRect& aDirtyRect, nsPoint aPt);
michael@0: 
michael@0:   nsITreeBoxObject* GetTreeBoxObject() const { return mTreeBoxObject; }
michael@0: 
michael@0:   // Get the base element, <tree> or <select>
michael@0:   nsIContent* GetBaseElement();
michael@0: 
michael@0:   bool GetVerticalOverflow() const { return mVerticalOverflow; }
michael@0:   bool GetHorizontalOverflow() const {return mHorizontalOverflow; }
michael@0: 
michael@0: protected:
michael@0:   friend class nsOverflowChecker;
michael@0: 
michael@0:   // This method paints a specific column background of the tree.
michael@0:   void PaintColumn(nsTreeColumn*        aColumn,
michael@0:                    const nsRect&        aColumnRect,
michael@0:                    nsPresContext*      aPresContext,
michael@0:                    nsRenderingContext& aRenderingContext,
michael@0:                    const nsRect&        aDirtyRect);
michael@0: 
michael@0:   // This method paints a single row in the tree.
michael@0:   void PaintRow(int32_t              aRowIndex,
michael@0:                 const nsRect&        aRowRect,
michael@0:                 nsPresContext*       aPresContext,
michael@0:                 nsRenderingContext& aRenderingContext,
michael@0:                 const nsRect&        aDirtyRect,
michael@0:                 nsPoint              aPt);
michael@0: 
michael@0:   // This method paints a single separator in the tree.
michael@0:   void PaintSeparator(int32_t              aRowIndex,
michael@0:                       const nsRect&        aSeparatorRect,
michael@0:                       nsPresContext*      aPresContext,
michael@0:                       nsRenderingContext& aRenderingContext,
michael@0:                       const nsRect&        aDirtyRect);
michael@0: 
michael@0:   // This method paints a specific cell in a given row of the tree.
michael@0:   void PaintCell(int32_t              aRowIndex, 
michael@0:                  nsTreeColumn*        aColumn,
michael@0:                  const nsRect&        aCellRect,
michael@0:                  nsPresContext*       aPresContext,
michael@0:                  nsRenderingContext& aRenderingContext,
michael@0:                  const nsRect&        aDirtyRect,
michael@0:                  nscoord&             aCurrX,
michael@0:                  nsPoint              aPt);
michael@0: 
michael@0:   // This method paints the twisty inside a cell in the primary column of an tree.
michael@0:   void PaintTwisty(int32_t              aRowIndex,
michael@0:                    nsTreeColumn*        aColumn,
michael@0:                    const nsRect&        aTwistyRect,
michael@0:                    nsPresContext*      aPresContext,
michael@0:                    nsRenderingContext& aRenderingContext,
michael@0:                    const nsRect&        aDirtyRect,
michael@0:                    nscoord&             aRemainingWidth,
michael@0:                    nscoord&             aCurrX);
michael@0: 
michael@0:   // This method paints the image inside the cell of an tree.
michael@0:   void PaintImage(int32_t              aRowIndex,
michael@0:                   nsTreeColumn*        aColumn,
michael@0:                   const nsRect&        aImageRect,
michael@0:                   nsPresContext*      aPresContext,
michael@0:                   nsRenderingContext& aRenderingContext,
michael@0:                   const nsRect&        aDirtyRect,
michael@0:                   nscoord&             aRemainingWidth,
michael@0:                   nscoord&             aCurrX);
michael@0: 
michael@0:   // This method paints the text string inside a particular cell of the tree.
michael@0:   void PaintText(int32_t              aRowIndex, 
michael@0:                  nsTreeColumn*        aColumn,
michael@0:                  const nsRect&        aTextRect,
michael@0:                  nsPresContext*      aPresContext,
michael@0:                  nsRenderingContext& aRenderingContext,
michael@0:                  const nsRect&        aDirtyRect,
michael@0:                  nscoord&             aCurrX);
michael@0: 
michael@0:   // This method paints the checkbox inside a particular cell of the tree.
michael@0:   void PaintCheckbox(int32_t              aRowIndex, 
michael@0:                      nsTreeColumn*        aColumn,
michael@0:                      const nsRect&        aCheckboxRect,
michael@0:                      nsPresContext*      aPresContext,
michael@0:                      nsRenderingContext& aRenderingContext,
michael@0:                      const nsRect&        aDirtyRect);
michael@0: 
michael@0:   // This method paints the progress meter inside a particular cell of the tree.
michael@0:   void PaintProgressMeter(int32_t              aRowIndex, 
michael@0:                           nsTreeColumn*        aColumn,
michael@0:                           const nsRect&        aProgressMeterRect,
michael@0:                           nsPresContext*      aPresContext,
michael@0:                           nsRenderingContext& aRenderingContext,
michael@0:                           const nsRect&        aDirtyRect);
michael@0: 
michael@0:   // This method paints a drop feedback of the tree.
michael@0:   void PaintDropFeedback(const nsRect&        aDropFeedbackRect, 
michael@0:                          nsPresContext*      aPresContext,
michael@0:                          nsRenderingContext& aRenderingContext,
michael@0:                          const nsRect&        aDirtyRect,
michael@0:                          nsPoint              aPt);
michael@0: 
michael@0:   // This method is called with a specific style context and rect to
michael@0:   // paint the background rect as if it were a full-blown frame.
michael@0:   void PaintBackgroundLayer(nsStyleContext*      aStyleContext,
michael@0:                             nsPresContext*      aPresContext, 
michael@0:                             nsRenderingContext& aRenderingContext, 
michael@0:                             const nsRect&        aRect,
michael@0:                             const nsRect&        aDirtyRect);
michael@0: 
michael@0: 
michael@0:   // An internal hit test.  aX and aY are expected to be in twips in the
michael@0:   // coordinate system of this frame.
michael@0:   int32_t GetRowAt(nscoord aX, nscoord aY);
michael@0: 
michael@0:   // Check for bidi characters in the text, and if there are any, ensure
michael@0:   // that the prescontext is in bidi mode.
michael@0:   void CheckTextForBidi(nsAutoString& aText);
michael@0: 
michael@0:   void AdjustForCellText(nsAutoString& aText,
michael@0:                          int32_t aRowIndex,  nsTreeColumn* aColumn,
michael@0:                          nsRenderingContext& aRenderingContext,
michael@0:                          nsRect& aTextRect);
michael@0: 
michael@0:   // A helper used when hit testing.
michael@0:   nsIAtom* GetItemWithinCellAt(nscoord aX, const nsRect& aCellRect,
michael@0:                                int32_t aRowIndex, nsTreeColumn* aColumn);
michael@0: 
michael@0:   // An internal hit test.  aX and aY are expected to be in twips in the
michael@0:   // coordinate system of this frame.
michael@0:   void GetCellAt(nscoord aX, nscoord aY, int32_t* aRow, nsTreeColumn** aCol,
michael@0:                  nsIAtom** aChildElt);
michael@0: 
michael@0:   // Retrieve the area for the twisty for a cell.
michael@0:   nsITheme* GetTwistyRect(int32_t aRowIndex,
michael@0:                           nsTreeColumn* aColumn,
michael@0:                           nsRect& aImageRect,
michael@0:                           nsRect& aTwistyRect,
michael@0:                           nsPresContext* aPresContext,
michael@0:                           nsRenderingContext& aRenderingContext,
michael@0:                           nsStyleContext* aTwistyContext);
michael@0: 
michael@0:   // Fetch an image from the image cache.
michael@0:   nsresult GetImage(int32_t aRowIndex, nsTreeColumn* aCol, bool aUseContext,
michael@0:                     nsStyleContext* aStyleContext, bool& aAllowImageRegions, imgIContainer** aResult);
michael@0: 
michael@0:   // Returns the size of a given image.   This size *includes* border and
michael@0:   // padding.  It does not include margins.
michael@0:   nsRect GetImageSize(int32_t aRowIndex, nsTreeColumn* aCol, bool aUseContext, nsStyleContext* aStyleContext);
michael@0: 
michael@0:   // Returns the destination size of the image, not including borders and padding.
michael@0:   nsSize GetImageDestSize(nsStyleContext* aStyleContext, bool useImageRegion, imgIContainer* image);
michael@0: 
michael@0:   // Returns the source rectangle of the image to be displayed.
michael@0:   nsRect GetImageSourceRect(nsStyleContext* aStyleContext, bool useImageRegion, imgIContainer* image);
michael@0: 
michael@0:   // Returns the height of rows in the tree.
michael@0:   int32_t GetRowHeight();
michael@0: 
michael@0:   // Returns our indentation width.
michael@0:   int32_t GetIndentation();
michael@0: 
michael@0:   // Calculates our width/height once border and padding have been removed.
michael@0:   void CalcInnerBox();
michael@0: 
michael@0:   // Calculate the total width of our scrollable portion
michael@0:   nscoord CalcHorzWidth(const ScrollParts& aParts);
michael@0: 
michael@0:   // Looks up a style context in the style cache.  On a cache miss we resolve
michael@0:   // the pseudo-styles passed in and place them into the cache.
michael@0:   nsStyleContext* GetPseudoStyleContext(nsIAtom* aPseudoElement);
michael@0: 
michael@0:   // Retrieves the scrollbars and scrollview relevant to this treebody. We
michael@0:   // traverse the frame tree under our base element, in frame order, looking
michael@0:   // for the first relevant vertical scrollbar, horizontal scrollbar, and
michael@0:   // scrollable frame (with associated content and scrollable view). These
michael@0:   // are all volatile and should not be retained.
michael@0:   ScrollParts GetScrollParts();
michael@0: 
michael@0:   // Update the curpos of the scrollbar.
michael@0:   void UpdateScrollbars(const ScrollParts& aParts);
michael@0: 
michael@0:   // Update the maxpos of the scrollbar.
michael@0:   void InvalidateScrollbars(const ScrollParts& aParts, nsWeakFrame& aWeakColumnsFrame);
michael@0: 
michael@0:   // Check overflow and generate events.
michael@0:   void CheckOverflow(const ScrollParts& aParts);
michael@0: 
michael@0:   // Calls UpdateScrollbars, Invalidate aNeedsFullInvalidation if true,
michael@0:   // InvalidateScrollbars and finally CheckOverflow.
michael@0:   // returns true if the frame is still alive after the method call.
michael@0:   bool FullScrollbarsUpdate(bool aNeedsFullInvalidation);
michael@0: 
michael@0:   // Use to auto-fill some of the common properties without the view having to do it.
michael@0:   // Examples include container, open, selected, and focus.
michael@0:   void PrefillPropertyArray(int32_t aRowIndex, nsTreeColumn* aCol);
michael@0: 
michael@0:   // Our internal scroll method, used by all the public scroll methods.
michael@0:   nsresult ScrollInternal(const ScrollParts& aParts, int32_t aRow);
michael@0:   nsresult ScrollToRowInternal(const ScrollParts& aParts, int32_t aRow);
michael@0:   nsresult ScrollToColumnInternal(const ScrollParts& aParts, nsITreeColumn* aCol);
michael@0:   nsresult ScrollHorzInternal(const ScrollParts& aParts, int32_t aPosition);
michael@0:   nsresult EnsureRowIsVisibleInternal(const ScrollParts& aParts, int32_t aRow);
michael@0: 
michael@0:   // Convert client pixels into appunits in our coordinate space.
michael@0:   nsPoint AdjustClientCoordsToBoxCoordSpace(int32_t aX, int32_t aY);
michael@0: 
michael@0:   // Cache the box object
michael@0:   void EnsureBoxObject();
michael@0: 
michael@0:   void EnsureView();
michael@0: 
michael@0:   nsresult GetCellWidth(int32_t aRow, nsTreeColumn* aCol,
michael@0:                         nsRenderingContext* aRenderingContext,
michael@0:                         nscoord& aDesiredSize, nscoord& aCurrentSize);
michael@0:   nscoord CalcMaxRowWidth();
michael@0: 
michael@0:   // Translate the given rect horizontally from tree coordinates into the
michael@0:   // coordinate system of our nsTreeBodyFrame.  If clip is true, then clip the
michael@0:   // rect to its intersection with mInnerBox in the horizontal direction.
michael@0:   // Return whether the result has a nonempty intersection with mInnerBox
michael@0:   // after projecting both onto the horizontal coordinate axis.
michael@0:   bool OffsetForHorzScroll(nsRect& rect, bool clip);
michael@0: 
michael@0:   bool CanAutoScroll(int32_t aRowIndex);
michael@0: 
michael@0:   // Calc the row and above/below/on status given where the mouse currently is hovering.
michael@0:   // Also calc if we're in the region in which we want to auto-scroll the tree.
michael@0:   // A positive value of |aScrollLines| means scroll down, a negative value
michael@0:   // means scroll up, a zero value means that we aren't in drag scroll region.
michael@0:   void ComputeDropPosition(mozilla::WidgetGUIEvent* aEvent,
michael@0:                            int32_t* aRow,
michael@0:                            int16_t* aOrient,
michael@0:                            int16_t* aScrollLines);
michael@0: 
michael@0:   // Mark ourselves dirty if we're a select widget
michael@0:   void MarkDirtyIfSelect();
michael@0: 
michael@0:   void InvalidateDropFeedback(int32_t aRow, int16_t aOrientation) {
michael@0:     InvalidateRow(aRow);
michael@0:     if (aOrientation != nsITreeView::DROP_ON)
michael@0:       InvalidateRow(aRow + aOrientation);
michael@0:   }
michael@0: 
michael@0: public:
michael@0:   static
michael@0:   already_AddRefed<nsTreeColumn> GetColumnImpl(nsITreeColumn* aUnknownCol) {
michael@0:     if (!aUnknownCol)
michael@0:       return nullptr;
michael@0: 
michael@0:     nsCOMPtr<nsTreeColumn> col = do_QueryInterface(aUnknownCol);
michael@0:     return col.forget();
michael@0:   }
michael@0: 
michael@0:   /**
michael@0:    * Remove an nsITreeImageListener from being tracked by this frame. Only tree
michael@0:    * image listeners that are created by this frame are tracked.
michael@0:    *
michael@0:    * @param aListener A pointer to an nsTreeImageListener to no longer
michael@0:    *        track.
michael@0:    */
michael@0:   void RemoveTreeImageListener(nsTreeImageListener* aListener);
michael@0: 
michael@0: protected:
michael@0: 
michael@0:   // Create a new timer. This method is used to delay various actions like
michael@0:   // opening/closing folders or tree scrolling.
michael@0:   // aID is type of the action, aFunc is the function to be called when
michael@0:   // the timer fires and aType is type of timer - one shot or repeating.
michael@0:   nsresult CreateTimer(const mozilla::LookAndFeel::IntID aID,
michael@0:                        nsTimerCallbackFunc aFunc, int32_t aType,
michael@0:                        nsITimer** aTimer);
michael@0: 
michael@0:   static void OpenCallback(nsITimer *aTimer, void *aClosure);
michael@0: 
michael@0:   static void CloseCallback(nsITimer *aTimer, void *aClosure);
michael@0: 
michael@0:   static void LazyScrollCallback(nsITimer *aTimer, void *aClosure);
michael@0: 
michael@0:   static void ScrollCallback(nsITimer *aTimer, void *aClosure);
michael@0: 
michael@0:   class ScrollEvent : public nsRunnable {
michael@0:   public:
michael@0:     NS_DECL_NSIRUNNABLE
michael@0:     ScrollEvent(nsTreeBodyFrame *aInner) : mInner(aInner) {}
michael@0:     void Revoke() { mInner = nullptr; }
michael@0:   private:
michael@0:     nsTreeBodyFrame* mInner;
michael@0:   };
michael@0: 
michael@0:   void PostScrollEvent();
michael@0:   void FireScrollEvent();
michael@0: 
michael@0:   virtual void ScrollbarActivityStarted() const MOZ_OVERRIDE;
michael@0:   virtual void ScrollbarActivityStopped() const MOZ_OVERRIDE;
michael@0: 
michael@0:   /**
michael@0:    * Clear the pointer to this frame for all nsTreeImageListeners that were
michael@0:    * created by this frame.
michael@0:    */
michael@0:   void DetachImageListeners();
michael@0: 
michael@0: #ifdef ACCESSIBILITY
michael@0:   /**
michael@0:    * Fires 'treeRowCountChanged' event asynchronously. The event supports
michael@0:    * nsIDOMCustomEvent interface that is used to expose the following
michael@0:    * information structures.
michael@0:    *
michael@0:    * @param aIndex  the row index rows are added/removed from
michael@0:    * @param aCount  the number of added/removed rows (the sign points to
michael@0:    *                an operation, plus - addition, minus - removing)
michael@0:    */
michael@0:   void FireRowCountChangedEvent(int32_t aIndex, int32_t aCount);
michael@0: 
michael@0:   /**
michael@0:    * Fires 'treeInvalidated' event asynchronously. The event supports
michael@0:    * nsIDOMCustomEvent interface that is used to expose the information
michael@0:    * structures described by method arguments.
michael@0:    *
michael@0:    * @param aStartRow  the start index of invalidated rows, -1 means that
michael@0:    *                   columns have been invalidated only
michael@0:    * @param aEndRow    the end index of invalidated rows, -1 means that columns
michael@0:    *                   have been invalidated only
michael@0:    * @param aStartCol  the start invalidated column, nullptr means that only rows
michael@0:    *                   have been invalidated
michael@0:    * @param aEndCol    the end invalidated column, nullptr means that rows have
michael@0:    *                   been invalidated only
michael@0:    */
michael@0:   void FireInvalidateEvent(int32_t aStartRow, int32_t aEndRow,
michael@0:                            nsITreeColumn *aStartCol, nsITreeColumn *aEndCol);
michael@0: #endif
michael@0: 
michael@0: protected: // Data Members
michael@0: 
michael@0:   class Slots {
michael@0:     public:
michael@0:       Slots() {
michael@0:       }
michael@0: 
michael@0:       ~Slots() {
michael@0:         if (mTimer)
michael@0:           mTimer->Cancel();
michael@0:       }
michael@0: 
michael@0:       friend class nsTreeBodyFrame;
michael@0: 
michael@0:     protected:
michael@0:       // If the drop is actually allowed here or not.
michael@0:       bool                     mDropAllowed;
michael@0: 
michael@0:       // True while dragging over the tree.
michael@0:       bool mIsDragging;
michael@0: 
michael@0:       // The row the mouse is hovering over during a drop.
michael@0:       int32_t                  mDropRow;
michael@0: 
michael@0:       // Where we want to draw feedback (above/on this row/below) if allowed.
michael@0:       int16_t                  mDropOrient;
michael@0: 
michael@0:       // Number of lines to be scrolled.
michael@0:       int16_t                  mScrollLines;
michael@0: 
michael@0:       // The drag action that was received for this slot
michael@0:       uint32_t                 mDragAction;
michael@0: 
michael@0:       // Timer for opening/closing spring loaded folders or scrolling the tree.
michael@0:       nsCOMPtr<nsITimer>       mTimer;
michael@0: 
michael@0:       // An array used to keep track of all spring loaded folders.
michael@0:       nsTArray<int32_t>        mArray;
michael@0:   };
michael@0: 
michael@0:   Slots* mSlots;
michael@0: 
michael@0:   nsRevocableEventPtr<ScrollEvent> mScrollEvent;
michael@0: 
michael@0:   nsRefPtr<ScrollbarActivity> mScrollbarActivity;
michael@0: 
michael@0:   // The cached box object parent.
michael@0:   nsCOMPtr<nsITreeBoxObject> mTreeBoxObject;
michael@0: 
michael@0:   // Cached column information.
michael@0:   nsRefPtr<nsTreeColumns> mColumns;
michael@0: 
michael@0:   // The current view for this tree widget.  We get all of our row and cell data
michael@0:   // from the view.
michael@0:   nsCOMPtr<nsITreeView> mView;
michael@0: 
michael@0:   // A cache of all the style contexts we have seen for rows and cells of the tree.  This is a mapping from
michael@0:   // a list of atoms to a corresponding style context.  This cache stores every combination that
michael@0:   // occurs in the tree, so for n distinct properties, this cache could have 2 to the n entries
michael@0:   // (the power set of all row properties).
michael@0:   nsTreeStyleCache mStyleCache;
michael@0: 
michael@0:   // A hashtable that maps from URLs to image request/listener pairs.  The URL
michael@0:   // is provided by the view or by the style context. The style context
michael@0:   // represents a resolved :-moz-tree-cell-image (or twisty) pseudo-element.
michael@0:   // It maps directly to an imgIRequest.
michael@0:   nsDataHashtable<nsStringHashKey, nsTreeImageCacheEntry> mImageCache;
michael@0: 
michael@0:   // A scratch array used when looking up cached style contexts.
michael@0:   AtomArray mScratchArray;
michael@0: 
michael@0:   // The index of the first visible row and the # of rows visible onscreen.  
michael@0:   // The tree only examines onscreen rows, starting from
michael@0:   // this index and going up to index+pageLength.
michael@0:   int32_t mTopRowIndex;
michael@0:   int32_t mPageLength;
michael@0: 
michael@0:   // The horizontal scroll position
michael@0:   nscoord mHorzPosition;
michael@0: 
michael@0:   // The original desired horizontal width before changing it and posting a
michael@0:   // reflow callback. In some cases, the desired horizontal width can first be
michael@0:   // different from the current desired horizontal width, only to return to
michael@0:   // the same value later during the same reflow. In this case, we can cancel
michael@0:   // the posted reflow callback and prevent an unnecessary reflow.
michael@0:   nscoord mOriginalHorzWidth;
michael@0:   // Our desired horizontal width (the width for which we actually have tree
michael@0:   // columns).
michael@0:   nscoord mHorzWidth;
michael@0:   // The amount by which to adjust the width of the last cell.
michael@0:   // This depends on whether or not the columnpicker and scrollbars are present.
michael@0:   nscoord mAdjustWidth;
michael@0: 
michael@0:   // Cached heights and indent info.
michael@0:   nsRect mInnerBox; // 4-byte aligned
michael@0:   int32_t mRowHeight;
michael@0:   int32_t mIndentation;
michael@0:   nscoord mStringWidth;
michael@0: 
michael@0:   int32_t mUpdateBatchNest;
michael@0: 
michael@0:   // Cached row count.
michael@0:   int32_t mRowCount;
michael@0: 
michael@0:   // The row the mouse is hovering over.
michael@0:   int32_t mMouseOverRow;
michael@0: 
michael@0:   // Whether or not we're currently focused.
michael@0:   bool mFocused;
michael@0: 
michael@0:   // Do we have a fixed number of onscreen rows?
michael@0:   bool mHasFixedRowCount;
michael@0: 
michael@0:   bool mVerticalOverflow;
michael@0:   bool mHorizontalOverflow;
michael@0: 
michael@0:   bool mReflowCallbackPosted;
michael@0: 
michael@0:   // Set while we flush layout to take account of effects of
michael@0:   // overflow/underflow event handlers
michael@0:   bool mCheckingOverflow;
michael@0: 
michael@0:   // Hash table to keep track of which listeners we created and thus
michael@0:   // have pointers to us.
michael@0:   nsTHashtable<nsPtrHashKey<nsTreeImageListener> > mCreatedListeners;
michael@0: 
michael@0: }; // class nsTreeBodyFrame
michael@0: 
michael@0: #endif