Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(318)

Unified Diff: third_party/WebKit/Source/core/page/scrolling/RootScroller.h

Issue 2040693002: Rename RootScroller class to RootScrollerController. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 4 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: third_party/WebKit/Source/core/page/scrolling/RootScroller.h
diff --git a/third_party/WebKit/Source/core/page/scrolling/RootScroller.h b/third_party/WebKit/Source/core/page/scrolling/RootScroller.h
deleted file mode 100644
index 516290cf0c18ba7ddbf3856341559754d09bd970..0000000000000000000000000000000000000000
--- a/third_party/WebKit/Source/core/page/scrolling/RootScroller.h
+++ /dev/null
@@ -1,100 +0,0 @@
-// Copyright 2016 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-#ifndef RootScroller_h
-#define RootScroller_h
-
-#include "core/CoreExport.h"
-#include "platform/heap/Handle.h"
-
-namespace blink {
-
-class Document;
-class Element;
-class OverscrollController;
-class TopControls;
-class ViewportScrollCallback;
-
-// Manages the root scroller associated with a given document. The root scroller
-// causes top controls movement, overscroll effects and prevents chaining
-// scrolls up further in the DOM. It can be set from script using
-// document.setRootScroller.
-//
-// There are two notions of a root scroller in this class: m_rootScroller and
-// m_effectiveRootScroller. The former is the Element that was set as the root
-// scroller using document.setRootScroller. If the page didn't set a root
-// scroller this will be nullptr. The "effective" root scroller is the current
-// element we're using internally to apply viewport scroll actions. i.e It's the
-// element with the ViewportScrollCallback set as its apply-scroll callback.
-// The effective root scroller will only be null during document initialization.
-//
-// If the root scroller element is a valid element to become the root scroller,
-// it will be promoted to the effective root scroller. If it is not valid, the
-// effective root scroller will fall back to a default Element (see
-// defaultEffectiveRootScroller()). The rules for what makes an element a valid
-// root scroller are set in isValidRootScroller(). The validity of the current
-// root scroller is re-checked after each layout.
-class CORE_EXPORT RootScroller : public GarbageCollected<RootScroller> {
-public:
- // Creates a RootScroller for the given document. An optional
- // ViewportScrollCallback can be provided. If it is, RootScroller will
- // ensure that the effectiveRootScroller element always has this set as the
- // apply scroll callback.
- static RootScroller* create(
- Document& document,
- ViewportScrollCallback* applyScrollCallback)
- {
- return new RootScroller(document, applyScrollCallback);
- }
-
- // Creates an apply scroll callback that handles viewport actions like
- // TopControls movement and Overscroll.
- static ViewportScrollCallback* createViewportApplyScroll(
- TopControls&, OverscrollController&);
-
- DECLARE_TRACE();
-
- // Sets the element that will be used as the root scroller. This can be
- // nullptr, in which case we'll use the default element (documentElement) as
- // the effective root scroller.
- void set(Element*);
-
- // Returns the element currently set as the root scroller from script. This
- // differs from the effective root scroller since the set Element may not
- // currently be a valid root scroller. e.g. If the page sets an Element
- // with `display: none`, get() will return that element, even though the
- // effective root scroller will remain the element returned by
- // defaultEffectiveRootScroller().
- Element* get() const;
-
- // This returns the Element that's actually being used to control viewport
- // actions right now. This is different from get() if a root scroller hasn't
- // been set, or if the set root scroller isn't currently a valid scroller.
- Element* effectiveRootScroller() const;
-
- // This class needs to be informed of changes in layout so that it can
- // determine if the current root scroller is still valid or if it must be
- // replaced by the defualt root scroller.
- void didUpdateLayout();
-
-private:
- RootScroller(Document&, ViewportScrollCallback*);
-
- Element* defaultEffectiveRootScroller();
-
- // Ensures the effective root scroller is currently valid and replaces it
- // with the default if not.
- void updateEffectiveRootScroller();
- void moveViewportApplyScroll(Element* target);
-
- WeakMember<Document> m_document;
- Member<ViewportScrollCallback> m_viewportApplyScroll;
-
- WeakMember<Element> m_rootScroller;
- WeakMember<Element> m_effectiveRootScroller;
-};
-
-} // namespace blink
-
-#endif // RootScroller_h
« no previous file with comments | « third_party/WebKit/Source/core/input/ScrollManager.cpp ('k') | third_party/WebKit/Source/core/page/scrolling/RootScroller.cpp » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698