dom/events/NotifyPaintEvent.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 #ifndef mozilla_dom_NotifyPaintEvent_h_
   8 #define mozilla_dom_NotifyPaintEvent_h_
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/dom/Event.h"
  12 #include "mozilla/dom/BindingDeclarations.h"
  13 #include "mozilla/dom/NotifyPaintEventBinding.h"
  14 #include "nsDOMNavigationTiming.h"
  15 #include "nsPresContext.h"
  16
  17 namespace mozilla::dom {
  18
  19 class DOMRect;
  20 class DOMRectList;
  21 class PaintRequestList;
  22
  23 class NotifyPaintEvent : public Event {
  24  public:
  25   NotifyPaintEvent(EventTarget* aOwner, nsPresContext* aPresContext,
  26                    WidgetEvent* aEvent, EventMessage aEventMessage,
  27                    nsTArray<nsRect>* aInvalidateRequests,
  28                    uint64_t aTransactionId, DOMHighResTimeStamp aTimeStamp);
  29
  30   NS_INLINE_DECL_REFCOUNTING_INHERITED(NotifyPaintEvent, Event)
  31
  32   void Serialize(IPC::MessageWriter* aWriter,
  33                  bool aSerializeInterfaceType) override;
  34   bool Deserialize(IPC::MessageReader* aReader) override;
  35
  36   virtual JSObject* WrapObjectInternal(
  37       JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override {
  38     return NotifyPaintEvent_Binding::Wrap(aCx, this, aGivenProto);
  39   }
  40
  41   already_AddRefed<DOMRectList> ClientRects(SystemCallerGuarantee aGuarantee);
  42
  43   already_AddRefed<DOMRect> BoundingClientRect(
  44       SystemCallerGuarantee aGuarantee);
  45
  46   already_AddRefed<PaintRequestList> PaintRequests(SystemCallerGuarantee);
  47
  48   uint64_t TransactionId(SystemCallerGuarantee);
  49
  50   DOMHighResTimeStamp PaintTimeStamp(SystemCallerGuarantee);
  51
  52  protected:
  53   ~NotifyPaintEvent() = default;
  54
  55  private:
  56   nsRegion GetRegion(SystemCallerGuarantee);
  57
  58   nsTArray<nsRect> mInvalidateRequests;
  59   uint64_t mTransactionId;
  60   DOMHighResTimeStamp mTimeStamp;
  61 };
  62
  63 }  // namespace mozilla::dom
  64
  65 // This empties aInvalidateRequests.
  66 already_AddRefed<mozilla::dom::NotifyPaintEvent> NS_NewDOMNotifyPaintEvent(
  67     mozilla::dom::EventTarget* aOwner, nsPresContext* aPresContext,
  68     mozilla::WidgetEvent* aEvent,
  69     mozilla::EventMessage aEventMessage = mozilla::eVoidEvent,
  70     nsTArray<nsRect>* aInvalidateRequests = nullptr,
  71     uint64_t aTransactionId = 0, DOMHighResTimeStamp aTimeStamp = 0);
  72
  73 #endif  // mozilla_dom_NotifyPaintEvent_h_