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
|
// Copyright 2012 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_AUTOFILL_AUTOFILL_POPUP_CONTROLLER_H_
#define CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_POPUP_CONTROLLER_H_
#include <optional>
#include <string>
#include <vector>
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "chrome/browser/ui/autofill/autofill_popup_view_delegate.h"
#include "components/autofill/core/browser/autofill_client.h"
#include "components/autofill/core/browser/ui/suggestion.h"
#include "components/autofill/core/common/aliases.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
namespace autofill {
// This interface provides data to an AutofillPopupView.
class AutofillPopupController : public AutofillPopupViewDelegate {
public:
// Recalculates the height and width of the popup and triggers a redraw when
// suggestions change.
virtual void OnSuggestionsChanged() = 0;
// Selects the suggestion with `index`. For fillable items, this will trigger
// preview. For other items, it does not do anything.
virtual void SelectSuggestion(absl::optional<size_t> index) = 0;
// Accepts the suggestion at `index`. The suggestion will only be accepted if
// the popup has been shown for at least `show_threshold` compared to
// `event_time` to allow ruling out accidental popup interactions
// (crbug.com/1279268).
virtual void AcceptSuggestion(int index, base::TimeTicks event_time) = 0;
// Executes the action associated with the button that is displayed in the
// suggestion at `index`. Button actions depend on the type of the suggestion.
virtual void PerformButtonActionForSuggestion(int index) = 0;
// Removes the suggestion at the given index.
virtual bool RemoveSuggestion(int index) = 0;
// Returns the number of lines of data that there are.
virtual int GetLineCount() const = 0;
// Returns the full set of autofill suggestions, if applicable.
virtual std::vector<Suggestion> GetSuggestions() const = 0;
// Returns the suggestion at the given `row` index. The `Suggestion` is the
// data model including information that is to be shown in the UI.
virtual const Suggestion& GetSuggestionAt(int row) const = 0;
// Returns the suggestion main text string at the given `row` index. The main
// text is shown in primary or secondary text style, serving as the title of
// the suggestion.
virtual std::u16string GetSuggestionMainTextAt(int row) const = 0;
// Returns the suggestion minor text string at the given `row` index. The
// minor text is shown in secondary text style, serving as the sub-title of
// the suggestion item.
virtual std::u16string GetSuggestionMinorTextAt(int row) const = 0;
// Returns all the labels of the suggestion at the given `row` index. The
// labels are presented as a N*M matrix, and the position of the text in the
// matrix decides where the text will be shown on the UI. (e.g. The text
// labels[1][2] will be shown on the second line, third column in the grid
// view of label).
virtual std::vector<std::vector<Suggestion::Text>> GetSuggestionLabelsAt(
int row) const = 0;
// Returns whether the item at `list_index` can be removed. If so, fills
// out `title` and `body` (when non-null) with relevant user-facing text.
virtual bool GetRemovalConfirmationText(int index,
std::u16string* title,
std::u16string* body) = 0;
// Returns the popup type corresponding to the controller.
virtual PopupType GetPopupType() const = 0;
// Returns the suggestion source that triggered autofill.
virtual AutofillSuggestionTriggerSource GetAutofillSuggestionTriggerSource()
const = 0;
// Returns whether the popup should ignore the check that the mouse was
// observed out of bounds - see PopupCellView for more detail.
virtual bool ShouldIgnoreMouseObservedOutsideItemBoundsCheck() const = 0;
// Creates and shows a sub-popup adjacent to `anchor_bounds`. The sub-popup
// represents another level of `suggestions` which must be semantically
// connected to a parent level suggestion, e.g. an address suggestion
// break down providing more granular fillings.
// The popup created via this method and this popup instance are linked
// as child-parent. The child's lifetime depends on its parent, i.e. when
// the parent dies the child dies also.
virtual base::WeakPtr<AutofillPopupController> OpenSubPopup(
const gfx::RectF& anchor_bounds,
std::vector<Suggestion> suggestions,
AutoselectFirstSuggestion autoselect_first_suggestion) = 0;
// Hides open by `OpenSubPopup()` popup, noop if there is no open sub-popup.
virtual void HideSubPopup() = 0;
virtual std::optional<AutofillClient::PopupScreenLocation>
GetPopupScreenLocation() const = 0;
protected:
~AutofillPopupController() override = default;
};
} // namespace autofill
#endif // CHROME_BROWSER_UI_AUTOFILL_AUTOFILL_POPUP_CONTROLLER_H_
|
