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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
// Copyright 2018 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_UNIFIED_UNIFIED_SYSTEM_TRAY_MODEL_H_
#define ASH_SYSTEM_UNIFIED_UNIFIED_SYSTEM_TRAY_MODEL_H_
#include <optional>
#include "ash/ash_export.h"
#include "ash/public/cpp/pagination/pagination_model.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/observer_list.h"
#include "chromeos/dbus/power/power_manager_client.h"
#include "chromeos/dbus/power_manager/backlight.pb.h"
namespace display {
class Display;
} // namespace display
namespace ash {
class Shelf;
// Model class that stores UnifiedSystemTray's UI specific variables. Owned by
// UnifiedSystemTray status area button. Not to be confused with UI agnostic
// SystemTrayModel.
class ASH_EXPORT UnifiedSystemTrayModel
: public base::RefCounted<UnifiedSystemTrayModel> {
public:
enum class NotificationTargetMode {
// Notification list scrolls to the last notification.
LAST_NOTIFICATION,
// Notification list scrolls to the last scroll position.
LAST_POSITION,
// Notification list scrolls to the specified notification defined by
// |SetTargetNotification(notification_id)|.
NOTIFICATION_ID,
};
// Enumeration of possible sizes of the system tray button. Larger screen will
// have larger tray button with additional information.
enum class SystemTrayButtonSize {
// Display wifi, battery, notification counter icons and time.
kSmall = 0,
// Display those in small unified system tray, plus important notification
// icons.
kMedium = 1,
// Display those in medium unified system tray, plus the current date.
kLarge = 2,
kMaxValue = kLarge,
};
class Observer {
public:
virtual ~Observer() = default;
// |by_user| is true when brightness is changed by user action.
virtual void OnDisplayBrightnessChanged(bool by_user) {}
virtual void OnKeyboardBrightnessChanged(
power_manager::BacklightBrightnessChange_Cause cause) {}
};
explicit UnifiedSystemTrayModel(Shelf* shelf);
UnifiedSystemTrayModel(const UnifiedSystemTrayModel&) = delete;
UnifiedSystemTrayModel& operator=(const UnifiedSystemTrayModel&) = delete;
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
// Returns empty if it's not manually expanded/collapsed. Otherwise, the value
// is true if the notification is manually expanded, and false if it's
// manually collapsed.
std::optional<bool> GetNotificationExpanded(
const std::string& notification_id) const;
// Sets a notification of |notification_id| is manually |expanded|.
void SetNotificationExpanded(const std::string& notification_id,
bool expanded);
// Removes the state of the notification of |notification_id|.
void RemoveNotificationExpanded(const std::string& notification_id);
// Clears all changes by SetNotificationExpanded().
void ClearNotificationChanges();
// Set the notification id of the target. This sets target mode as
// NOTIFICATION_ID.
void SetTargetNotification(const std::string& notification_id);
// Get the size of the system tray depends on the size of the display screen.
SystemTrayButtonSize GetSystemTrayButtonSize() const;
float display_brightness() const { return display_brightness_; }
float keyboard_brightness() const { return keyboard_brightness_; }
void set_notification_target_mode(NotificationTargetMode mode) {
notification_target_mode_ = mode;
}
NotificationTargetMode notification_target_mode() const {
return notification_target_mode_;
}
const std::string& notification_target_id() const {
return notification_target_id_;
}
PaginationModel* pagination_model() { return pagination_model_.get(); }
private:
friend class UnifiedSystemTrayControllerTest;
// Required for private destructor to be called from RefCounted<>.
friend class base::RefCounted<UnifiedSystemTrayModel>;
class DBusObserver;
// Private destructor to prevent subverting reference counting.
// TODO(crbug/1269517): The use of this class should be refactored so that
// reference counting is not required. Likely, Message Center and Quick
// Settings will need to be combined.
~UnifiedSystemTrayModel();
void DisplayBrightnessChanged(float brightness, bool by_user);
void KeyboardBrightnessChanged(
float brightness,
power_manager::BacklightBrightnessChange_Cause cause);
void SystemTrayButtonSizeChanged(SystemTrayButtonSize system_tray_size);
// Get the display that owns the tray.
const display::Display GetDisplay() const;
// Target mode which is used to decide the scroll position of the message
// center on opening. See the comment in |NotificationTargetMode|.
NotificationTargetMode notification_target_mode_ =
NotificationTargetMode::LAST_NOTIFICATION;
// Set the notification id of the target. This id is used if the target mode
// is NOTIFICATION_ID.
std::string notification_target_id_;
// The last value of the display brightness slider. Between 0.0 and 1.0.
float display_brightness_ = 1.f;
// The last value of the keyboard brightness slider. Between 0.0 and 1.0.
float keyboard_brightness_ = 1.f;
// Stores Manual changes to notification expanded / collapsed state in order
// to restore on reopen.
// <notification ID, if notification is manually expanded>
std::map<std::string, bool> notification_changes_;
const raw_ptr<Shelf> shelf_;
std::unique_ptr<DBusObserver> dbus_observer_;
base::ObserverList<Observer>::Unchecked observers_;
std::unique_ptr<PaginationModel> pagination_model_;
};
} // namespace ash
#endif // ASH_SYSTEM_UNIFIED_UNIFIED_SYSTEM_TRAY_MODEL_H_
|
