summaryrefslogtreecommitdiffstats
path: root/layout/generic/ScrollSnap.h
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /layout/generic/ScrollSnap.h
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'layout/generic/ScrollSnap.h')
-rw-r--r--layout/generic/ScrollSnap.h41
1 files changed, 41 insertions, 0 deletions
diff --git a/layout/generic/ScrollSnap.h b/layout/generic/ScrollSnap.h
new file mode 100644
index 000000000..a2877564d
--- /dev/null
+++ b/layout/generic/ScrollSnap.h
@@ -0,0 +1,41 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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 mozilla_layout_ScrollSnap_h_
+#define mozilla_layout_ScrollSnap_h_
+
+namespace mozilla {
+
+namespace layers {
+struct ScrollSnapInfo;
+}
+
+struct ScrollSnapUtils {
+ /**
+ * GetSnapPointForDestination determines which point to snap to after
+ * scrolling. |aStartPos| gives the position before scrolling and
+ * |aDestination| gives the position after scrolling, with no snapping.
+ * Behaviour is dependent on the value of |aUnit|.
+ * |aSnapInfo|, |aScrollPortSize|, and |aScrollRange| are characteristics
+ * of the scroll frame for which snapping is being performed.
+ * If a suitable snap point could be found, it is returned. Otherwise, an
+ * empty Maybe is returned.
+ * IMPORTANT NOTE: This function is designed to be called both on and off
+ * the main thread. If modifying its implementation, be sure
+ * not to touch main-thread-only data structures without
+ * appropriate locking.
+ */
+ static Maybe<nsPoint> GetSnapPointForDestination(
+ const layers::ScrollSnapInfo& aSnapInfo,
+ nsIScrollableFrame::ScrollUnit aUnit,
+ const nsSize& aScrollPortSize,
+ const nsRect& aScrollRange,
+ const nsPoint& aStartPos,
+ const nsPoint& aDestination);
+};
+
+} // namespace mozilla
+
+#endif // mozilla_layout_ScrollSnap_h_