File: ElementVisibilityObserver.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (56 lines) | stat: -rw-r--r-- 1,847 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// 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 ElementVisibilityObserver_h
#define ElementVisibilityObserver_h

#include "core/CoreExport.h"
#include "core/dom/IntersectionObserver.h"
#include "platform/heap/Heap.h"
#include "platform/heap/Member.h"

namespace blink {

class Element;

// ElementVisibilityObserver is a helper class to be used to track the
// visibility of an Element in the viewport. Creating an
// ElementVisibilityObserver is a no-op with regards to CPU cycle. The observing
// has be started by calling |start()| and can be stopped with |stop()|.
// When creating an instance, the caller will have to pass a callback taking
// a boolean as an argument. The boolean will be the new visibility state.
// The ElementVisibilityObserver is implemented on top of IntersectionObserver.
// It is a layer meant to simplify the usage for C++ Blink code checking for the
// visibility of an element.
class CORE_EXPORT ElementVisibilityObserver final
    : public GarbageCollectedFinalized<ElementVisibilityObserver> {
  WTF_MAKE_NONCOPYABLE(ElementVisibilityObserver);

 public:
  using VisibilityCallback = Function<void(bool), WTF::SameThreadAffinity>;

  ElementVisibilityObserver(Element*, std::unique_ptr<VisibilityCallback>);
  virtual ~ElementVisibilityObserver();

  void start();
  void stop();

  void deliverObservationsForTesting();

  DECLARE_VIRTUAL_TRACE();

 private:
  class ElementVisibilityCallback;

  void onVisibilityChanged(
      const HeapVector<Member<IntersectionObserverEntry>>&);

  Member<Element> m_element;
  Member<IntersectionObserver> m_intersectionObserver;
  std::unique_ptr<VisibilityCallback> m_callback;
};

}  // namespace blink

#endif  // ElementVisibilityObserver_h