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
|
// 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 CHROME_BROWSER_SYNC_SYNC_UI_UTIL_H_
#define CHROME_BROWSER_SYNC_SYNC_UI_UTIL_H_
#pragma once
#include <string>
#include "base/string16.h"
#include "base/values.h"
#include "chrome/browser/sync/profile_sync_service.h"
class Browser;
class Profile;
namespace base {
class ListValue;
class DictionaryValue;
}
// Utility functions to gather current sync status information from the sync
// service and constructs messages suitable for showing in UI.
namespace sync_ui_util {
enum MessageType {
PRE_SYNCED, // User has not set up sync.
SYNCED, // We are synced and authenticated to a gmail account.
SYNC_ERROR, // A sync error (such as invalid credentials) has occurred.
SYNC_PROMO, // A situation has occurred which should be brought to the user's
// attention, but not as an error.
};
enum StatusLabelStyle {
PLAIN_TEXT, // Label will be plain-text only.
WITH_HTML // Label may contain an HTML-formatted link.
};
// TODO(akalin): audit the use of ProfileSyncService* service below,
// and use const ProfileSyncService& service where possible.
// Create status and link labels for the current status labels and link text
// by querying |service|.
// |style| sets the link properties, see |StatusLabelStyle|.
MessageType GetStatusLabels(ProfileSyncService* service,
const SigninManager& signin,
StatusLabelStyle style,
string16* status_label,
string16* link_label);
// Same as above but for use specifically on the New Tab Page.
// |status_label| may contain an HTML-formatted link.
MessageType GetStatusLabelsForNewTabPage(ProfileSyncService* service,
const SigninManager& signin,
string16* status_label,
string16* link_label);
// Gets various labels for the sync global error based on the sync error state.
// |menu_item_label|, |bubble_message|, and |bubble_accept_label| must not be
// NULL.
void GetStatusLabelsForSyncGlobalError(ProfileSyncService* service,
const SigninManager& signin,
string16* menu_item_label,
string16* bubble_message,
string16* bubble_accept_label);
MessageType GetStatus(ProfileSyncService* service, const SigninManager& signin);
// Returns a string with the synchronization status.
string16 GetSyncMenuLabel(ProfileSyncService* service,
const SigninManager& signin);
void AddBoolSyncDetail(base::ListValue* details,
const std::string& stat_name,
bool stat_value);
// |service| can be NULL.
void ConstructAboutInformation(ProfileSyncService* service,
DictionaryValue* strings);
void AddIntSyncDetail(base::ListValue* details,
const std::string& stat_name,
int64 stat_value);
void AddStringSyncDetails(ListValue* details, const std::string& stat_name,
const std::string& stat_value);
// Returns a string describing the chrome version environment. Version format:
// <Build Info> <OS> <Version number> (<Last change>)<channel or "-devel">
// If version information is unavailable, returns "invalid."
// TODO(zea): this approximately matches MakeUserAgentForSyncApi in
// sync_backend_host.cc. Unify the two if possible.
std::string GetVersionString();
} // namespace sync_ui_util
#endif // CHROME_BROWSER_SYNC_SYNC_UI_UTIL_H_
|