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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/*
* Copyright (C) by Klaas Freitag <freitag@owncloud.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
#ifndef _THEME_H
#define _THEME_H
#include "mirall/syncresult.h"
class QIcon;
class QString;
class QObject;
class QPixmap;
class QColor;
namespace Mirall {
class SyncResult;
class OWNCLOUDSYNC_EXPORT Theme : public QObject
{
Q_OBJECT
public:
enum CustomMediaType {
oCSetupTop, // ownCloud connect page
oCSetupSide,
oCSetupBottom,
oCSetupResultTop // ownCloud connect result page
};
/* returns a singleton instance. */
static Theme* instance();
/**
* @brief appNameGUI - Human readable application name.
*
* Use and redefine this if the human readable name contains spaces,
* special chars and such.
*
* By default, the name is derived from the APPLICATION_NAME
* cmake variable.
*
* @return QString with human readable app name.
*/
virtual QString appNameGUI() const;
/**
* @brief appName - Application name (short)
*
* Use and redefine this as an application name. Keep it straight as
* it is used for config files etc. If you need a more sophisticated
* name in the GUI, redefine appNameGUI.
*
* By default, the name is derived from the APPLICATION_SHORTNAME
* cmake variable, and should be the same. This method is only
* reimplementable for legacy reasons.
*
* Warning: Do not modify this value, as many things, e.g. settings
* depend on it! You most likely want to modify \ref appNameGUI().
*
* @return QString with app name.
*/
virtual QString appName() const;
/**
* @brief configFileName
* @return the name of the config file.
*/
virtual QString configFileName() const = 0;
#ifndef TOKEN_AUTH_ONLY
/**
* the icon that is shown in the tray context menu left of the folder name
*/
virtual QIcon trayFolderIcon( const QString& ) const;
/**
* get an sync state icon
*/
virtual QIcon syncStateIcon( SyncResult::Status, bool sysTray = false ) const;
virtual QIcon folderDisabledIcon() const;
virtual QIcon folderOfflineIcon(bool systray = false) const;
virtual QIcon applicationIcon() const = 0;
#endif
virtual QString statusHeaderText( SyncResult::Status ) const;
virtual QString version() const;
/**
* Characteristics: bool if more than one sync folder is allowed
*/
virtual bool singleSyncFolder() const;
/**
* URL to help file
*/
virtual QString helpUrl() const { return QString::null; }
/**
* Setting a value here will pre-define the server url.
*
* The respective UI controls will be disabled
*/
virtual QString overrideServerUrl() const;
/**
* The default folder name without path on the server at setup time.
*/
virtual QString defaultServerFolder() const;
/**
* The default folder name without path on the client side at setup time.
*/
virtual QString defaultClientFolder() const;
/**
* Override to encforce a particular locale, i.e. "de" or "pt_BR"
*/
virtual QString enforcedLocale() const { return QString::null; }
/** colored, white or black */
QString systrayIconFlavor(bool mono) const;
#ifndef TOKEN_AUTH_ONLY
/**
* Override to use a string or a custom image name.
* The default implementation will try to look up
* :/mirall/theme/<type>.png
*/
virtual QVariant customMedia( CustomMediaType type );
/** @return color for the setup wizard */
virtual QColor wizardHeaderTitleColor() const;
/** @return color for the setup wizard. */
virtual QColor wizardHeaderBackgroundColor() const;
/** @return logo for the setup wizard. */
virtual QPixmap wizardHeaderLogo() const;
/**
* The default implementation creates a
* background based on
* \ref wizardHeaderTitleColor().
*
* @return banner for the setup wizard.
*/
virtual QPixmap wizardHeaderBanner() const;
#endif
/**
* The SHA sum of the released git commit
*/
QString gitSHA1() const;
/**
* About dialog contents
*/
virtual QString about() const;
/**
* Define if the systray icons should be using mono design
*/
void setSystrayUseMonoIcons(bool mono);
/**
* Retrieve wether to use mono icons for systray
*/
bool systrayUseMonoIcons() const;
/**
* @brief Where to check for new Updates.
*/
virtual QString updateCheckUrl() const;
protected:
QIcon themeIcon(const QString& name, bool sysTray = false) const;
Theme();
signals:
void systrayUseMonoIconsChanged(bool);
private:
Theme(Theme const&);
Theme& operator=(Theme const&);
static Theme* _instance;
bool _mono;
};
}
#endif // _THEME_H
|
