File: popup_row_with_button_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 (125 lines) | stat: -rw-r--r-- 4,239 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// 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_AUTOFILL_POPUP_POPUP_ROW_WITH_BUTTON_VIEW_H_
#define CHROME_BROWSER_UI_VIEWS_AUTOFILL_POPUP_POPUP_ROW_WITH_BUTTON_VIEW_H_

#include <memory>
#include <optional>
#include <string>

#include "base/memory/raw_ptr.h"
#include "base/scoped_observation.h"
#include "chrome/browser/ui/views/autofill/popup/popup_row_view.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/views/view_observer.h"

namespace content {
struct NativeWebKeyboardEvent;
}  // namespace content

namespace views {
class ImageButton;
}  // namespace views

namespace autofill {

class AutofillPopupController;
class PopupRowContentView;

// Receives notifications of mouse enter/exit events of the button.
class ButtonDelegate {
 public:
  virtual void OnMouseEnteredButton() = 0;
  virtual void OnMouseExitedButton() = 0;
};

// A class for a single selectable popup cell that also has a button.
class PopupRowWithButtonView : public PopupRowView, public ButtonDelegate {
  METADATA_HEADER(PopupRowWithButtonView, PopupRowView)

 public:
  // Determines under which conditions the button (if there is one) is visible.
  enum class ButtonVisibility : uint8_t {
    // The button is only visible if the cell or the button are selected or
    // hovered.
    kShowOnHoverOrSelect,
    // The button is always visible.
    kShowAlways
  };

  // Determines whether the suggestion is communicated as "selected" or "not
  // selected" to the controller when the button is selected.
  enum class ButtonSelectBehavior : uint8_t {
    // When the button is selected, the suggestion does not count as selected
    // (and, for example, the content is not previewed).
    kUnselectSuggestion,
    // When the button  is selected, the suggestion is also selected.
    kSelectSuggestion
  };

  PopupRowWithButtonView(
      AccessibilitySelectionDelegate& a11y_selection_delegate,
      SelectionDelegate& selection_delegate,
      base::WeakPtr<AutofillPopupController> controller,
      int line_number,
      std::unique_ptr<PopupRowContentView> content_view,
      std::unique_ptr<views::ImageButton> button,
      ButtonVisibility button_visibility,
      ButtonSelectBehavior button_select_behavior);

  PopupRowWithButtonView(const PopupRowWithButtonView&) = delete;
  PopupRowWithButtonView& operator=(const PopupRowWithButtonView&) = delete;
  ~PopupRowWithButtonView() override;

  views::ImageButton* GetButtonForTest() { return button_; }
  bool GetButtonFocusedForTest() {
    return focused_part_ == RowWithButtonPart::kButton;
  }

  // Returns the view that contains the button or `nullptr` if no button is set.
  views::View* GetButtonContainer();

  // PopupRowView:
  void SetSelectedCell(std::optional<CellType> cell) override;
  // Handles key press events coming from the parent class. Returns false if
  // the parent should handle it.
  bool HandleKeyPressEvent(const input::NativeWebKeyboardEvent& event) override;

 private:
  // Enumerates logical parts of the row. Used for accessibility and arrow
  // navigation purposes.
  enum class RowWithButtonPart {
    kContent,
    kButton,
  };

  // ButtonDelegate:
  void OnMouseEnteredButton() override;
  void OnMouseExitedButton() override;

  // Sets the `focused_part_` property and calls `SelectSuggestion()` on
  // the controller according to the focused part.
  void UpdateFocusedPartAndSelectedSuggestion(
      std::optional<RowWithButtonPart> part);
  void HandleKeyPressEventFocusOnButton();
  void HandleKeyPressEventFocusOnContent();

  // Returns whether the button (if there is one) should be visible.
  bool ShouldButtonBeVisible() const;

  raw_ptr<views::ImageButton> button_ = nullptr;
  raw_ptr<views::View> button_placeholder_ = nullptr;

  // Defines the part of the row that is currently highlighted and accepts
  // user input.
  std::optional<RowWithButtonPart> focused_part_;

  const ButtonVisibility button_visibility_;
  const ButtonSelectBehavior button_select_behavior_;
};

}  // namespace autofill

#endif  // CHROME_BROWSER_UI_VIEWS_AUTOFILL_POPUP_POPUP_ROW_WITH_BUTTON_VIEW_H_