layout/base/nsDisplayListInvalidation.h

   1 /*-*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef NSDISPLAYLISTINVALIDATION_H_
   7 #define NSDISPLAYLISTINVALIDATION_H_
   8
   9 #include "mozilla/Attributes.h"
  10 #include "nsRect.h"
  11 #include "nsColor.h"
  12 #include "gfxRect.h"
  13
  14 class nsDisplayItem;
  15 class nsDisplayListBuilder;
  16 class nsDisplayBackgroundImage;
  17 class nsDisplayThemedBackground;
  18 class nsDisplaySVGEffects;
  19
  20 /**
  21  * This stores the geometry of an nsDisplayItem, and the area
  22  * that will be affected when painting the item.
  23  *
  24  * It is used to retain information about display items so they
  25  * can be compared against new display items in the next paint.
  26  */
  27 class nsDisplayItemGeometry
  28 {
  29 public:
  30   nsDisplayItemGeometry(nsDisplayItem* aItem, nsDisplayListBuilder* aBuilder);
  31   virtual ~nsDisplayItemGeometry();
  32
  33   /**
  34    * Compute the area required to be invalidated if this
  35    * display item is removed.
  36    */
  37   const nsRect& ComputeInvalidationRegion() { return mBounds; }
  38
  39   /**
  40    * Shifts all retained areas of the nsDisplayItemGeometry by the given offset.
  41    *
  42    * This is used to compensate for scrolling, since the destination buffer
  43    * can scroll without requiring a full repaint.
  44    *
  45    * @param aOffset Offset to shift by.
  46    */
  47   virtual void MoveBy(const nsPoint& aOffset)
  48   {
  49     mBounds.MoveBy(aOffset);
  50   }
  51
  52   /**
  53    * Bounds of the display item
  54    */
  55   nsRect mBounds;
  56 };
  57
  58 /**
  59  * A default geometry implementation, used by nsDisplayItem. Retains
  60  * and compares the bounds, and border rect.
  61  *
  62  * This should be sufficient for the majority of display items.
  63  */
  64 class nsDisplayItemGenericGeometry : public nsDisplayItemGeometry
  65 {
  66 public:
  67   nsDisplayItemGenericGeometry(nsDisplayItem* aItem, nsDisplayListBuilder* aBuilder);
  68
  69   virtual void MoveBy(const nsPoint& aOffset) MOZ_OVERRIDE;
  70
  71   nsRect mBorderRect;
  72 };
  73
  74 class nsDisplayItemBoundsGeometry : public nsDisplayItemGeometry
  75 {
  76 public:
  77   nsDisplayItemBoundsGeometry(nsDisplayItem* aItem, nsDisplayListBuilder* aBuilder);
  78
  79   bool mHasRoundedCorners;
  80 };
  81
  82 class nsDisplayBorderGeometry : public nsDisplayItemGeometry
  83 {
  84 public:
  85   nsDisplayBorderGeometry(nsDisplayItem* aItem, nsDisplayListBuilder* aBuilder);
  86
  87   virtual void MoveBy(const nsPoint& aOffset) MOZ_OVERRIDE;
  88
  89   nsRect mContentRect;
  90 };
  91
  92 class nsDisplayBackgroundGeometry : public nsDisplayItemGeometry
  93 {
  94 public:
  95   nsDisplayBackgroundGeometry(nsDisplayBackgroundImage* aItem, nsDisplayListBuilder* aBuilder);
  96
  97   virtual void MoveBy(const nsPoint& aOffset) MOZ_OVERRIDE;
  98
  99   nsRect mPositioningArea;
 100 };
 101
 102 class nsDisplayThemedBackgroundGeometry : public nsDisplayItemGeometry
 103 {
 104 public:
 105   nsDisplayThemedBackgroundGeometry(nsDisplayThemedBackground* aItem, nsDisplayListBuilder* aBuilder);
 106
 107   virtual void MoveBy(const nsPoint& aOffset) MOZ_OVERRIDE;
 108
 109   nsRect mPositioningArea;
 110   bool mWindowIsActive;
 111 };
 112
 113 class nsDisplayBoxShadowInnerGeometry : public nsDisplayItemGeometry
 114 {
 115 public:
 116   nsDisplayBoxShadowInnerGeometry(nsDisplayItem* aItem, nsDisplayListBuilder* aBuilder);
 117
 118   virtual void MoveBy(const nsPoint& aOffset) MOZ_OVERRIDE;
 119
 120   nsRect mPaddingRect;
 121 };
 122
 123 class nsDisplayBoxShadowOuterGeometry : public nsDisplayItemGenericGeometry
 124 {
 125 public:
 126   nsDisplayBoxShadowOuterGeometry(nsDisplayItem* aItem,
 127                                   nsDisplayListBuilder* aBuilder,
 128                                   float aOpacity);
 129
 130   float mOpacity;
 131 };
 132
 133 class nsDisplaySolidColorGeometry : public nsDisplayItemBoundsGeometry
 134 {
 135 public:
 136   nsDisplaySolidColorGeometry(nsDisplayItem* aItem,
 137                               nsDisplayListBuilder* aBuilder,
 138                               nscolor aColor)
 139     : nsDisplayItemBoundsGeometry(aItem, aBuilder)
 140     , mColor(aColor)
 141   { }
 142
 143   nscolor mColor;
 144 };
 145
 146 class nsDisplaySVGEffectsGeometry : public nsDisplayItemGeometry
 147 {
 148 public:
 149   nsDisplaySVGEffectsGeometry(nsDisplaySVGEffects* aItem, nsDisplayListBuilder* aBuilder);
 150
 151   virtual void MoveBy(const nsPoint& aOffset) MOZ_OVERRIDE;
 152
 153   gfxRect mBBox;
 154   gfxPoint mUserSpaceOffset;
 155   nsPoint mFrameOffsetToReferenceFrame;
 156 };
 157
 158 #endif /*NSDISPLAYLISTINVALIDATION_H_*/