File: user_prefs.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (47 lines) | stat: -rw-r--r-- 1,549 bytes parent folder | download | duplicates (7)
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
// Copyright 2013 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_PREFS_USER_PREFS_H_
#define COMPONENTS_USER_PREFS_USER_PREFS_H_

#include "base/memory/raw_ptr.h"
#include "base/supports_user_data.h"
#include "components/user_prefs/user_prefs_export.h"

class PrefService;

namespace user_prefs {

// Components may use preferences associated with a given user. These hang off
// of base::SupportsUserData and can be retrieved using UserPrefs::Get().
//
// It is up to the embedder to create and own the PrefService and attach it to
// base::SupportsUserData using the UserPrefs::Set() function.
class USER_PREFS_EXPORT UserPrefs : public base::SupportsUserData::Data {
 public:
  UserPrefs(const UserPrefs&) = delete;
  UserPrefs& operator=(const UserPrefs&) = delete;

  ~UserPrefs() override;

  // Returns true if there is a PrefService attached to the given context.
  static bool IsInitialized(base::SupportsUserData* context);

  // Retrieves the PrefService for a given context.
  static PrefService* Get(base::SupportsUserData* context);

  // Hangs the specified |prefs| off of |context|. Should be called
  // only once per context.
  static void Set(base::SupportsUserData* context, PrefService* prefs);

 private:
  explicit UserPrefs(PrefService* prefs);

  // Non-owning; owned by embedder.
  raw_ptr<PrefService, AcrossTasksDanglingUntriaged> prefs_;
};

}  // namespace user_prefs

#endif  // COMPONENTS_USER_PREFS_USER_PREFS_H_