File: scoped_picture_in_picture_occlusion_observation.h

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (63 lines) | stat: -rw-r--r-- 2,748 bytes parent folder | download | duplicates (3)
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
57
58
59
60
61
62
63
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_PICTURE_IN_PICTURE_SCOPED_PICTURE_IN_PICTURE_OCCLUSION_OBSERVATION_H_
#define CHROME_BROWSER_PICTURE_IN_PICTURE_SCOPED_PICTURE_IN_PICTURE_OCCLUSION_OBSERVATION_H_

#include <memory>

#include "base/functional/callback.h"
#include "base/scoped_observation.h"
#include "ui/views/widget/widget_observer.h"

class PictureInPictureOcclusionObserver;
class PictureInPictureOcclusionTracker;
class PictureInPictureOcclusionTrackerObserver;

// The ScopedPictureInPictureOcclusionObservation observes the
// PictureInPictureOcclusionTracker owned by the PictureInPictureWindowManager.
// It starts observing when `Observe()` is called with a given widget and
// `occlusion_observer_` will be notified of occlusion state updates.
// `occlusion_observer_` is also synchronously notified on the call to
// `Observe()`. The ScopedPictureInPictureOcclusionObservation will stop
// observing for occlusions when EITHER:
// 1) The observed widget is destroyed, OR
// 2) The ScopedPictureInPictureOcclusionObservation itself is destroyed.
//
// See chrome/browser/picture_in_picture/picture_in_picture_occlusion_tracker.h
// for usage examples.
class ScopedPictureInPictureOcclusionObservation
    : public views::WidgetObserver {
 public:
  explicit ScopedPictureInPictureOcclusionObservation(
      PictureInPictureOcclusionObserver* occlusion_observer);
  ScopedPictureInPictureOcclusionObservation(
      const ScopedPictureInPictureOcclusionObservation&) = delete;
  ScopedPictureInPictureOcclusionObservation& operator=(
      const ScopedPictureInPictureOcclusionObservation&) = delete;
  ~ScopedPictureInPictureOcclusionObservation() override;

  // Starts observing the given `widget` for occlusions. If a widget is already
  // being observed, that widget will stop being observed and `widget` will be
  // observed instead. `occlusion_observer_` will immediately and synchronously
  // be notified of the current occlusion state.
  void Observe(views::Widget* widget);

  // views::WidgetObserver:
  void OnWidgetDestroying(views::Widget* widget) override;

 private:
  std::unique_ptr<PictureInPictureOcclusionTrackerObserver> observer_;
  std::unique_ptr<
      base::ScopedObservation<PictureInPictureOcclusionTracker,
                              PictureInPictureOcclusionTrackerObserver>>
      observation_;

  base::ScopedObservation<views::Widget, views::WidgetObserver>
      widget_observation_{this};

  const raw_ptr<PictureInPictureOcclusionObserver> occlusion_observer_;
};

#endif  // CHROME_BROWSER_PICTURE_IN_PICTURE_SCOPED_PICTURE_IN_PICTURE_OCCLUSION_OBSERVATION_H_