File: ambient_ui_settings.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (65 lines) | stat: -rw-r--r-- 2,351 bytes parent folder | download
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
// 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 ASH_AMBIENT_AMBIENT_UI_SETTINGS_H_
#define ASH_AMBIENT_AMBIENT_UI_SETTINGS_H_

#include <string>

#include "ash/ambient/ambient_constants.h"
#include "ash/ash_export.h"
#include "ash/constants/ambient_video.h"
#include "ash/webui/personalization_app/mojom/personalization_app.mojom-shared.h"
#include "base/values.h"
#include "third_party/abseil-cpp/absl/types/optional.h"

class PrefService;

namespace ash {

// Captures the ambient UI that the user has selected in the Hub.
class ASH_EXPORT AmbientUiSettings {
 public:
  // Returns default set of |AmbientUiSettings| if the settings do not exist in
  // |pref_service| or the existing settings are corrupted in pref store.
  static AmbientUiSettings ReadFromPrefService(PrefService& pref_service);

  // Creates the default ui settings. This is guaranteed to be valid.
  AmbientUiSettings();
  // Fatal error occurs if an invalid combination of settings is provided.
  explicit AmbientUiSettings(
      personalization_app::mojom::AmbientTheme theme,
      absl::optional<AmbientVideo> video = absl::nullopt);
  AmbientUiSettings(const AmbientUiSettings&);
  AmbientUiSettings& operator=(const AmbientUiSettings&);
  ~AmbientUiSettings();

  personalization_app::mojom::AmbientTheme theme() const { return theme_; }
  // Must be set if |theme()| is |kVideo|. Otherwise, may be nullopt.
  const absl::optional<AmbientVideo>& video() const { return video_; }

  bool operator==(const AmbientUiSettings& other) const;
  bool operator!=(const AmbientUiSettings& other) const;

  void WriteToPrefService(PrefService& pref_service) const;

  // Used for both metrics and debugging.
  std::string ToString() const;

 private:
  // Returns nullopt if the |dict| contains an invalid group of settings.
  static absl::optional<AmbientUiSettings> CreateFromDict(
      const base::Value::Dict& dict);

  // This is private because the caller by design should never be working with
  // an invalid instance. A fatal error should occur before then.
  bool IsValid() const;

  personalization_app::mojom::AmbientTheme theme_ = kDefaultAmbientTheme;
  absl::optional<AmbientVideo> video_;
};

}  // namespace ash

#endif  // ASH_AMBIENT_AMBIENT_UI_SETTINGS_H_