File: system_nudge_view.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (102 lines) | stat: -rw-r--r-- 3,678 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
// 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 ASH_SYSTEM_TOAST_SYSTEM_NUDGE_VIEW_H_
#define ASH_SYSTEM_TOAST_SYSTEM_NUDGE_VIEW_H_

#include "ash/ash_export.h"
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/raw_ptr.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/views/layout/flex_layout_view.h"
#include "ui/views/widget/widget_observer.h"

namespace views {
class ImageButton;
class ViewTracker;
class Widget;
}  // namespace views

namespace gfx {
class RoundedCornersF;
}  // namespace gfx

namespace ash {

struct AnchoredNudgeData;
class SystemShadow;

// The System Nudge view. (go/cros-educationalnudge-spec)
// This view supports different configurations depending on the provided
// nudge data parameters. It will always have a body text, and may have a
// leading image view, a title text, and up to two buttons placed on the bottom.
class ASH_EXPORT SystemNudgeView : public views::FlexLayoutView,
                                   public views::WidgetObserver {
  METADATA_HEADER(SystemNudgeView, views::FlexLayoutView)

 public:
  DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kBubbleIdForTesting);
  DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kPrimaryButtonIdForTesting);
  DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kSecondaryButtonIdForTesting);

  explicit SystemNudgeView(const AnchoredNudgeData& nudge_data,
                           base::RepeatingCallback<void(bool)>
                               hover_focus_callback = base::DoNothing());
  SystemNudgeView(const SystemNudgeView&) = delete;
  SystemNudgeView& operator=(const SystemNudgeView&) = delete;
  ~SystemNudgeView() override;

  // views::View:
  void AddedToWidget() override;
  void RemovedFromWidget() override;
  void OnMouseEntered(const ui::MouseEvent& event) override;
  void OnMouseExited(const ui::MouseEvent& event) override;

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

 private:
  class FocusableChildrenObserver;

  // Handles observed child focus state changes.
  void HandleOnChildFocusStateChanged(bool focus_entered);

  // Handles mouse enter/exit events to either show or hide `close_button_`.
  void HandleOnMouseHovered(bool mouse_entered);

  // Returns true if the nudge is mouse hovered or a child is focused.
  bool IsHoveredOrChildHasFocus();

  // Sets the corner radius for the nudge view, shadow and highlight border.
  void SetNudgeRoundedCornerRadius(const gfx::RoundedCornersF& rounded_corners);

  // Owned by the views hierarchy.
  raw_ptr<views::ImageButton> close_button_ = nullptr;

  std::unique_ptr<views::ViewTracker> anchor_view_tracker_;

  std::unique_ptr<SystemShadow> shadow_;

  // Used to determine if the nudge will draw a pointy corner.
  const bool is_corner_anchored_;

  // Observes focus state changes in the nudge's focusable children.
  std::unique_ptr<FocusableChildrenObserver> focusable_children_observer_;

  // Custom callback triggered whenever the nudge's hover state changes. It may
  // be empty since it's an optional parameter set in `nudge_data`.
  const base::RepeatingCallback<void(/*is_hovered=*/bool)>
      hover_changed_callback_;

  // Callback triggered whenever the hover or focus state changes.
  const base::RepeatingCallback<void(/*is_hovered_or_has_focus=*/bool)>
      hover_or_focus_changed_callback_;
};

}  // namespace ash

#endif  // ASH_SYSTEM_TOAST_SYSTEM_NUDGE_VIEW_H_