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
126
127
128
129
130
131
132
|
// 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_TOOLBAR_PINNED_TOOLBAR_PINNED_TOOLBAR_ACTIONS_MODEL_H_
#define CHROME_BROWSER_UI_TOOLBAR_PINNED_TOOLBAR_PINNED_TOOLBAR_ACTIONS_MODEL_H_
#include <string>
#include "base/observer_list.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/prefs/pref_change_registrar.h"
#include "components/prefs/pref_service.h"
#include "ui/actions/action_id.h"
class Profile;
// Used to keep track of the pinned elements/actions in the toolbar of the
// browser. This is a per-profile instance, and manages the user's pinned action
// preferences.
class PinnedToolbarActionsModel : public KeyedService {
public:
explicit PinnedToolbarActionsModel(Profile* profile);
PinnedToolbarActionsModel(const PinnedToolbarActionsModel&) = delete;
PinnedToolbarActionsModel& operator=(const PinnedToolbarActionsModel&) =
delete;
~PinnedToolbarActionsModel() override;
// Used to notify objects that extend this class that a change has occurred in
// the model. Note that added/removed/moved are NOT called when the pref is
// updated directly, e.g. for changes synced from another device.
class Observer {
public:
// Signals that `id` has been added to the model. This will
// *only* be called after the model has been initialized. N.B. Direct pref
// updates which happen to add an action WILL NOT call this method.
virtual void OnActionAddedLocally(actions::ActionId id) {}
// Signals that the given action with `id` has been removed from the
// model. N.B. Direct pref updates which happen to remove an action WILL NOT
// call this method.
virtual void OnActionRemovedLocally(actions::ActionId id) {}
// Signals that the given action with `id` has been moved in the model.
// N.B. Direct pref updates which happen to move an action WILL NOT call
// this method.
virtual void OnActionMovedLocally(actions::ActionId id,
int from_index,
int to_index) {}
// Called when the pinned actions change, in any way for any reason. Unlike
// the above methods, this does include pref updates.
virtual void OnActionsChanged() {}
protected:
virtual ~Observer() = default;
};
// Convenience function to get the PinnedToolbarActionsModel for a Profile.
static PinnedToolbarActionsModel* Get(Profile* profile);
// Adds or removes an observer.
virtual void AddObserver(Observer* observer);
virtual void RemoveObserver(Observer* observer);
// Verify if we can update the model with the current profile.
bool CanUpdate();
// Returns true if `action_id` is in the toolbar model.
bool Contains(actions::ActionId action_id) const;
// Move the pinned action for |action_id| to |target_index|.
void MovePinnedAction(actions::ActionId action_id, int target_index);
// Updates the Action state of `action_id`.
// 1) Adds `action_id` to the model if `should_pin` is true and the id does
// not exist in the model.
// 2) Removes `action_id` from the model if
// `should_pin` is false and the id exists in the model.
virtual void UpdatePinnedState(actions::ActionId action_id,
const bool should_pin);
// Resets the pinned actions to default. NOTE: This also affects the home and
// forward buttons, even though those are not otherwise managed by this model.
virtual void ResetToDefault();
// Returns true if the set of pinned actions is the default set. NOTE: This
// also includes the home and forward buttons, even though those are not
// otherwise managed by this model.
bool IsDefault() const;
// TODO(crbug.com/353323253): Remove after Pinned Chrome Labs, Cast and Tab
// Search migrations are complete.
void MaybeMigrateExistingPinnedStates();
// Returns the ordered list of pinned ActionIds.
virtual const std::vector<actions::ActionId>& PinnedActionIds() const;
private:
// Adds the `action_id` to the kPinnedActions pref.
void PinAction(actions::ActionId action_id);
// Removes the `action_id` from the kPinnedActions pref.
void UnpinAction(actions::ActionId action_id);
// Called when the kPinnedActions pref is changed. |pinned_action_ids_| is
// replaced with the entries in the kPinnedActions pref object. Should
// maintain insertion order. Notify observers the model has been updated with
// the latest data from the pref.
void UpdatePinnedActionIds();
void UpdatePref(const std::vector<actions::ActionId>& updated_list);
// Our observers.
base::ObserverList<Observer>::Unchecked observers_;
raw_ptr<Profile> profile_;
// Used to retrieve and update the prefs object storing the currently pinned
// actions.
raw_ptr<PrefService> pref_service_;
// For observing changes to the pinned actions.
PrefChangeRegistrar pref_change_registrar_;
// Ordered list of pinned action IDs which will be displayed in the toolbar.
std::vector<actions::ActionId> pinned_action_ids_;
};
#endif // CHROME_BROWSER_UI_TOOLBAR_PINNED_TOOLBAR_PINNED_TOOLBAR_ACTIONS_MODEL_H_
|
