File: embedded_permission_prompt_content_scrim_view.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; 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 (78 lines) | stat: -rw-r--r-- 3,299 bytes parent folder | download | duplicates (6)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
// 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_UI_VIEWS_PERMISSIONS_EMBEDDED_PERMISSION_PROMPT_CONTENT_SCRIM_VIEW_H_
#define CHROME_BROWSER_UI_VIEWS_PERMISSIONS_EMBEDDED_PERMISSION_PROMPT_CONTENT_SCRIM_VIEW_H_

#include <memory>

#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "chrome/browser/ui/views/permissions/embedded_permission_prompt_view_delegate.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/events/event.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/views/view.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_observer.h"

// The view class, which is owned by the `EmbeddedPermissionPrompt`, applies a
// scrim to the contents view on the root window while the permission prompt is
// presenting. This view will always float above and cover entirely the root
// window's content view, the intention is to obscure the content UI and prevent
// web-content interaction while the user is interacting with the permission
// prompt.
// The `EmbeddedPermissionPrompt` is responsible for managing the lifetime of
// the scrim view and the in-progress `EmbeddedPermissionPromptBaseView`. When
// the prompt view is destroyed, the scrim is automatically removed. Clicking on
// this scrim view will destroy both the scrim view and the in-progress
// `EmbeddedPermissionPromptBaseView`.
class EmbeddedPermissionPromptContentScrimView : public views::View,
                                                 public views::WidgetObserver {
  METADATA_HEADER(EmbeddedPermissionPromptContentScrimView, views::View)

 public:
  DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kContentScrimViewId);

  class Delegate {
   public:
    virtual void DismissScrim() = 0;
    virtual base::WeakPtr<permissions::PermissionPrompt::Delegate>
    GetPermissionPromptDelegate() const = 0;
  };

  EmbeddedPermissionPromptContentScrimView(base::WeakPtr<Delegate> delegate,
                                           views::Widget* widget,
                                           bool should_dismiss_on_click);

  ~EmbeddedPermissionPromptContentScrimView() override;

  EmbeddedPermissionPromptContentScrimView(
      const EmbeddedPermissionPromptContentScrimView&) = delete;
  EmbeddedPermissionPromptContentScrimView& operator=(
      const EmbeddedPermissionPromptContentScrimView&) = delete;

  // Create and returns the widget that contains this scrim view.
  static std::unique_ptr<views::Widget> CreateScrimWidget(
      base::WeakPtr<Delegate> delegate,
      SkColor color,
      bool should_dismiss_on_click);

  // Views::View
  bool OnMousePressed(const ui::MouseEvent& event) override;
  void OnGestureEvent(ui::GestureEvent* event) override;

  // views::WidgetObserver
  void OnWidgetDestroyed(views::Widget* widget) override;
  void OnWidgetBoundsChanged(views::Widget* widget,
                             const gfx::Rect& new_bounds) override;

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

  base::WeakPtr<Delegate> delegate_;
  bool should_dismiss_on_click_;
};

#endif  // CHROME_BROWSER_UI_VIEWS_PERMISSIONS_EMBEDDED_PERMISSION_PROMPT_CONTENT_SCRIM_VIEW_H_