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
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_USER_PREFS_PREF_REGISTRY_SYNCABLE_H_
#define COMPONENTS_USER_PREFS_PREF_REGISTRY_SYNCABLE_H_
#include <set>
#include <string>
#include "base/prefs/pref_registry.h"
#include "components/user_prefs/user_prefs_export.h"
namespace base {
class DictionaryValue;
class FilePath;
class ListValue;
class Value;
}
// A PrefRegistry that forces users to choose whether each registered
// preference is syncable or not.
//
// Classes or components that want to register such preferences should
// define a static function named RegisterUserPrefs that takes a
// PrefRegistrySyncable*, and the top-level application using the
// class or embedding the component should call this function at an
// appropriate time before the PrefService for these preferences is
// constructed. See e.g. chrome/browser/prefs/browser_prefs.cc which
// does this for Chrome.
class USER_PREFS_EXPORT PrefRegistrySyncable : public PrefRegistry {
public:
typedef base::Callback<void(const char* path)> SyncableRegistrationCallback;
// Enum used when registering preferences to determine if it should
// be synced or not.
enum PrefSyncStatus {
UNSYNCABLE_PREF,
SYNCABLE_PREF
};
PrefRegistrySyncable();
// Retrieve the set of syncable preferences currently registered.
const std::set<std::string>& syncable_preferences() const;
// Exactly one callback can be set for the event of a syncable
// preference being registered. It will be fired after the
// registration has occurred.
//
// Calling this method after a callback has already been set will
// make the object forget the previous callback and use the new one
// instead.
void SetSyncableRegistrationCallback(const SyncableRegistrationCallback& cb);
void RegisterBooleanPref(const char* path,
bool default_value,
PrefSyncStatus sync_status);
void RegisterIntegerPref(const char* path,
int default_value,
PrefSyncStatus sync_status);
void RegisterDoublePref(const char* path,
double default_value,
PrefSyncStatus sync_status);
void RegisterStringPref(const char* path,
const std::string& default_value,
PrefSyncStatus sync_status);
void RegisterFilePathPref(const char* path,
const base::FilePath& default_value,
PrefSyncStatus sync_status);
void RegisterListPref(const char* path,
PrefSyncStatus sync_status);
void RegisterDictionaryPref(const char* path,
PrefSyncStatus sync_status);
void RegisterListPref(const char* path,
base::ListValue* default_value,
PrefSyncStatus sync_status);
void RegisterDictionaryPref(const char* path,
base::DictionaryValue* default_value,
PrefSyncStatus sync_status);
void RegisterLocalizedBooleanPref(const char* path,
int locale_default_message_id,
PrefSyncStatus sync_status);
void RegisterLocalizedIntegerPref(const char* path,
int locale_default_message_id,
PrefSyncStatus sync_status);
void RegisterLocalizedDoublePref(const char* path,
int locale_default_message_id,
PrefSyncStatus sync_status);
void RegisterLocalizedStringPref(const char* path,
int locale_default_message_id,
PrefSyncStatus sync_status);
void RegisterInt64Pref(const char* path,
int64 default_value,
PrefSyncStatus sync_status);
void RegisterUint64Pref(const char* path,
uint64 default_value,
PrefSyncStatus sync_status);
// Returns a new PrefRegistrySyncable that uses the same defaults
// store.
scoped_refptr<PrefRegistrySyncable> ForkForIncognito();
private:
virtual ~PrefRegistrySyncable();
void RegisterSyncablePreference(const char* path,
base::Value* default_value,
PrefSyncStatus sync_status);
SyncableRegistrationCallback callback_;
// Contains the names of all registered preferences that are syncable.
std::set<std::string> syncable_preferences_;
DISALLOW_COPY_AND_ASSIGN(PrefRegistrySyncable);
};
#endif // COMPONENTS_USER_PREFS_PREF_REGISTRY_SYNCABLE_H_
|
