docshell/base/nsIScrollObserver.h
author Kris Maglione <maglione.k@gmail.com>
Fri, 23 Aug 2019 15:26:51 -0700
changeset 550415 f77f33c7c2d0fd2e07a4e19f27d065cd5c0ca963
parent 521387 005ab4b76f8c43b8a9a1dd792786b65d4dd4d05a
permissions -rw-r--r--
Bug 1532994: Part 1 - Move cross-origin-accessible Location logic to base class. r=farre Differential Revision: https://phabricator.services.mozilla.com/D43327

/* -*- 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 nsIScrollObserver_h___
#define nsIScrollObserver_h___

#include "nsISupports.h"
#include "Units.h"

// Must be kept in sync with xpcom/rust/xpcom/src/interfaces/nonidl.rs
#define NS_ISCROLLOBSERVER_IID                       \
  {                                                  \
    0xaa5026eb, 0x2f88, 0x4026, {                    \
      0xa4, 0x6b, 0xf4, 0x59, 0x6b, 0x4e, 0xdf, 0x00 \
    }                                                \
  }

class nsIScrollObserver : public nsISupports {
 public:
  NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCROLLOBSERVER_IID)

  /**
   * Called when the scroll position of some element has changed.
   */
  virtual void ScrollPositionChanged() = 0;

  /**
   * Called when an async panning/zooming transform has started being applied
   * and passed the scroll offset
   */
  MOZ_CAN_RUN_SCRIPT virtual void AsyncPanZoomStarted(){};

  /**
   * Called when an async panning/zooming transform is no longer applied
   * and passed the scroll offset
   */
  MOZ_CAN_RUN_SCRIPT virtual void AsyncPanZoomStopped(){};
};

NS_DEFINE_STATIC_IID_ACCESSOR(nsIScrollObserver, NS_ISCROLLOBSERVER_IID)

#endif /* nsIScrollObserver_h___ */