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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_USER_EDUCATION_COMMON_ANCHOR_ELEMENT_PROVIDER_H_
#define COMPONENTS_USER_EDUCATION_COMMON_ANCHOR_ELEMENT_PROVIDER_H_
#include "base/functional/callback_forward.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/interaction/element_tracker.h"
namespace user_education {
// Abstract interface for an object that can locate and return a
// `ui::TrackedElement`.
class AnchorElementProvider {
public:
AnchorElementProvider() = default;
virtual ~AnchorElementProvider() = default;
// Returns the target element, using `default_context`.
// For rotating promos, specify `index`.
virtual ui::TrackedElement* GetAnchorElement(
ui::ElementContext default_context,
std::optional<int> index) const = 0;
// Gets the next valid index for a rotating promo.
virtual int GetNextValidIndex(int starting_index) const = 0;
};
// Common implementation of AnchorElementProvider.
class AnchorElementProviderCommon : public AnchorElementProvider {
public:
AnchorElementProviderCommon();
explicit AnchorElementProviderCommon(ui::ElementIdentifier anchor_element_id);
AnchorElementProviderCommon(AnchorElementProviderCommon&&) noexcept;
AnchorElementProviderCommon& operator=(
AnchorElementProviderCommon&&) noexcept;
~AnchorElementProviderCommon() override;
// Optional method that filters a set of potential `elements` to choose and
// return the anchor element, or null if none of the inputs is appropriate.
// This method can return an element different from the input list, or null
// if no valid element is found.
using AnchorElementFilter = base::RepeatingCallback<ui::TrackedElement*(
const ui::ElementTracker::ElementList& elements)>;
ui::ElementIdentifier anchor_element_id() const { return anchor_element_id_; }
bool in_any_context() const { return in_any_context_; }
const AnchorElementFilter& anchor_element_filter() const {
return anchor_element_filter_;
}
// AnchorElementProvider:
ui::TrackedElement* GetAnchorElement(ui::ElementContext context,
std::optional<int> index) const override;
int GetNextValidIndex(int starting_index) const override;
protected:
void set_in_any_context(bool in_any_context) {
in_any_context_ = in_any_context;
}
void set_anchor_element_filter(AnchorElementFilter anchor_element_filter) {
anchor_element_filter_ = std::move(anchor_element_filter);
}
private:
// The element identifier of the anchor element.
ui::ElementIdentifier anchor_element_id_;
// Whether we are allowed to search for the anchor element in any context.
bool in_any_context_ = false;
// The filter to use if there is more than one matching element, or
// additional processing is needed (default is to always use the first
// matching element).
AnchorElementFilter anchor_element_filter_;
};
} // namespace user_education
#endif // COMPONENTS_USER_EDUCATION_COMMON_ANCHOR_ELEMENT_PROVIDER_H_
|
