OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef COMPONENTS_USER_PREFS_USER_PREFS_H_ | 5 #ifndef COMPONENTS_USER_PREFS_USER_PREFS_H_ |
6 #define COMPONENTS_USER_PREFS_USER_PREFS_H_ | 6 #define COMPONENTS_USER_PREFS_USER_PREFS_H_ |
7 | 7 |
8 #include "base/macros.h" | 8 #include "base/basictypes.h" |
9 #include "base/supports_user_data.h" | 9 #include "base/supports_user_data.h" |
| 10 #include "components/user_prefs/user_prefs_export.h" |
10 | 11 |
11 class PrefService; | 12 class PrefService; |
12 | 13 |
13 namespace user_prefs { | 14 namespace user_prefs { |
14 | 15 |
15 // Components may use preferences associated with a given user. These hang off | 16 // Components may use preferences associated with a given user. These hang off |
16 // of base::SupportsUserData and can be retrieved using UserPrefs::Get(). | 17 // of base::SupportsUserData and can be retrieved using UserPrefs::Get(). |
17 // | 18 // |
18 // It is up to the embedder to create and own the PrefService and attach it to | 19 // It is up to the embedder to create and own the PrefService and attach it to |
19 // base::SupportsUserData using the UserPrefs::Set() function. | 20 // base::SupportsUserData using the UserPrefs::Set() function. |
20 class UserPrefs : public base::SupportsUserData::Data { | 21 class USER_PREFS_EXPORT UserPrefs : public base::SupportsUserData::Data { |
21 public: | 22 public: |
22 // Retrieves the PrefService for a given context, or null if none is attached. | 23 // Retrieves the PrefService for a given context, or null if none is attached. |
23 static PrefService* Get(base::SupportsUserData* context); | 24 static PrefService* Get(base::SupportsUserData* context); |
24 | 25 |
25 // Hangs the specified |prefs| off of |context|. Should be called | 26 // Hangs the specified |prefs| off of |context|. Should be called |
26 // only once per context. | 27 // only once per context. |
27 static void Set(base::SupportsUserData* context, PrefService* prefs); | 28 static void Set(base::SupportsUserData* context, PrefService* prefs); |
28 | 29 |
29 private: | 30 private: |
30 explicit UserPrefs(PrefService* prefs); | 31 explicit UserPrefs(PrefService* prefs); |
31 ~UserPrefs() override; | 32 ~UserPrefs() override; |
32 | 33 |
33 // Non-owning; owned by embedder. | 34 // Non-owning; owned by embedder. |
34 PrefService* prefs_; | 35 PrefService* prefs_; |
35 | 36 |
36 DISALLOW_COPY_AND_ASSIGN(UserPrefs); | 37 DISALLOW_COPY_AND_ASSIGN(UserPrefs); |
37 }; | 38 }; |
38 | 39 |
39 } // namespace user_prefs | 40 } // namespace user_prefs |
40 | 41 |
41 #endif // COMPONENTS_USER_PREFS_USER_PREFS_H_ | 42 #endif // COMPONENTS_USER_PREFS_USER_PREFS_H_ |
OLD | NEW |