2012-02-16 13:42:44 +04:00
|
|
|
/*
|
|
|
|
* 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
|
|
|
|
|
2015-04-20 10:46:43 +03:00
|
|
|
#include <QObject>
|
2014-07-11 02:31:24 +04:00
|
|
|
#include "syncresult.h"
|
2012-02-20 19:45:27 +04:00
|
|
|
|
|
|
|
class QIcon;
|
|
|
|
class QString;
|
|
|
|
class QObject;
|
2012-02-23 14:44:44 +04:00
|
|
|
class QPixmap;
|
2013-05-17 20:05:22 +04:00
|
|
|
class QColor;
|
2015-02-16 12:24:42 +03:00
|
|
|
class QPaintDevice;
|
2012-02-20 19:45:27 +04:00
|
|
|
|
2014-11-10 00:34:07 +03:00
|
|
|
namespace OCC {
|
2012-02-16 13:42:44 +04:00
|
|
|
|
2012-02-20 19:45:27 +04:00
|
|
|
class SyncResult;
|
|
|
|
|
2015-06-29 19:56:09 +03:00
|
|
|
/**
|
|
|
|
* @brief The Theme class
|
|
|
|
* @ingroup libsync
|
2015-06-26 18:07:47 +03:00
|
|
|
*/
|
2014-04-29 17:30:19 +04:00
|
|
|
class OWNCLOUDSYNC_EXPORT Theme : public QObject
|
2012-02-16 13:42:44 +04:00
|
|
|
{
|
2013-07-04 21:59:40 +04:00
|
|
|
Q_OBJECT
|
2012-02-16 13:42:44 +04:00
|
|
|
public:
|
2013-01-09 19:29:50 +04:00
|
|
|
enum CustomMediaType {
|
|
|
|
oCSetupTop, // ownCloud connect page
|
|
|
|
oCSetupSide,
|
|
|
|
oCSetupBottom,
|
|
|
|
oCSetupResultTop // ownCloud connect result page
|
|
|
|
};
|
|
|
|
|
2013-02-21 15:21:42 +04:00
|
|
|
/* returns a singleton instance. */
|
2012-09-24 19:55:10 +04:00
|
|
|
static Theme *instance();
|
2012-02-16 13:42:44 +04:00
|
|
|
|
2015-06-24 11:14:55 +03:00
|
|
|
~Theme();
|
|
|
|
|
2013-02-21 15:21:42 +04:00
|
|
|
/**
|
|
|
|
* @brief appNameGUI - Human readable application name.
|
|
|
|
*
|
|
|
|
* Use and redefine this if the human readable name contains spaces,
|
|
|
|
* special chars and such.
|
|
|
|
*
|
2013-08-23 12:33:30 +04:00
|
|
|
* By default, the name is derived from the APPLICATION_NAME
|
|
|
|
* cmake variable.
|
2013-02-21 15:21:42 +04:00
|
|
|
*
|
|
|
|
* @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.
|
|
|
|
*
|
2013-08-23 12:33:30 +04:00
|
|
|
* 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().
|
|
|
|
*
|
2013-02-21 15:21:42 +04:00
|
|
|
* @return QString with app name.
|
|
|
|
*/
|
2013-08-22 11:40:15 +04:00
|
|
|
virtual QString appName() const;
|
2012-02-16 13:42:44 +04:00
|
|
|
|
2013-02-21 15:21:42 +04:00
|
|
|
/**
|
|
|
|
* @brief configFileName
|
|
|
|
* @return the name of the config file.
|
|
|
|
*/
|
2012-02-17 14:11:18 +04:00
|
|
|
virtual QString configFileName() const = 0;
|
2012-02-16 13:42:44 +04:00
|
|
|
|
2014-04-06 21:34:56 +04:00
|
|
|
#ifndef TOKEN_AUTH_ONLY
|
2015-02-16 12:24:42 +03:00
|
|
|
static QString hidpiFileName(const QString &fileName, QPaintDevice *dev = 0);
|
|
|
|
|
2012-05-02 17:50:01 +04:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*/
|
2016-10-06 18:18:51 +03:00
|
|
|
virtual QIcon syncStateIcon(SyncResult::Status, bool sysTray = false, bool sysTrayMenuVisible = false) const;
|
2012-05-02 17:50:01 +04:00
|
|
|
|
2014-08-15 17:01:01 +04:00
|
|
|
virtual QIcon folderDisabledIcon() const;
|
2016-10-06 18:18:51 +03:00
|
|
|
virtual QIcon folderOfflineIcon(bool sysTray = false, bool sysTrayMenuVisible = false) const;
|
2012-05-02 17:50:01 +04:00
|
|
|
virtual QIcon applicationIcon() const = 0;
|
2014-04-06 21:34:56 +04:00
|
|
|
#endif
|
2012-05-02 17:50:01 +04:00
|
|
|
|
|
|
|
virtual QString statusHeaderText(SyncResult::Status) const;
|
2012-02-21 13:48:18 +04:00
|
|
|
virtual QString version() const;
|
2012-05-02 17:50:01 +04:00
|
|
|
|
2012-09-19 13:58:02 +04:00
|
|
|
/**
|
|
|
|
* Characteristics: bool if more than one sync folder is allowed
|
|
|
|
*/
|
|
|
|
virtual bool singleSyncFolder() const;
|
2015-10-19 13:26:42 +03:00
|
|
|
|
2015-08-13 10:38:53 +03:00
|
|
|
/**
|
2015-10-19 13:26:42 +03:00
|
|
|
* When true, client works with multiple accounts.
|
2015-08-13 10:38:53 +03:00
|
|
|
*/
|
2015-10-19 13:26:42 +03:00
|
|
|
virtual bool multiAccount() const;
|
2012-09-19 13:58:02 +04:00
|
|
|
|
2013-07-04 21:59:40 +04:00
|
|
|
/**
|
|
|
|
* URL to help file
|
|
|
|
*/
|
|
|
|
virtual QString helpUrl() const { return QString::null; }
|
|
|
|
|
2013-01-09 19:29:50 +04:00
|
|
|
/**
|
|
|
|
* Setting a value here will pre-define the server url.
|
|
|
|
*
|
|
|
|
* The respective UI controls will be disabled
|
|
|
|
*/
|
|
|
|
virtual QString overrideServerUrl() const;
|
|
|
|
|
2016-04-15 14:16:49 +03:00
|
|
|
/**
|
|
|
|
* This is only usefull when previous version had a different overrideServerUrl
|
|
|
|
* with a different auth type in that case You should then specify "http" or "shibboleth".
|
|
|
|
* Normaly this should be left empty.
|
|
|
|
*/
|
|
|
|
virtual QString forceConfigAuthType() const;
|
|
|
|
|
2012-09-28 15:42:22 +04:00
|
|
|
/**
|
|
|
|
* 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;
|
|
|
|
|
2012-11-16 14:49:55 +04:00
|
|
|
/**
|
|
|
|
* Override to encforce a particular locale, i.e. "de" or "pt_BR"
|
|
|
|
*/
|
|
|
|
virtual QString enforcedLocale() const { return QString::null; }
|
|
|
|
|
2013-08-14 18:35:36 +04:00
|
|
|
/** colored, white or black */
|
2016-10-06 18:18:51 +03:00
|
|
|
QString systrayIconFlavor(bool mono, bool sysTrayMenuVisible = false) const;
|
2013-01-09 19:29:50 +04:00
|
|
|
|
2014-04-06 21:34:56 +04:00
|
|
|
#ifndef TOKEN_AUTH_ONLY
|
2013-01-09 19:29:50 +04:00
|
|
|
/**
|
|
|
|
* Override to use a string or a custom image name.
|
|
|
|
* The default implementation will try to look up
|
2014-12-08 20:00:29 +03:00
|
|
|
* :/client/theme/<type>.png
|
2013-01-09 19:29:50 +04:00
|
|
|
*/
|
|
|
|
virtual QVariant customMedia(CustomMediaType type);
|
|
|
|
|
2013-05-17 20:05:22 +04:00
|
|
|
/** @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;
|
2014-04-06 21:34:56 +04:00
|
|
|
#endif
|
2013-05-17 20:05:22 +04:00
|
|
|
|
2014-08-18 13:24:03 +04:00
|
|
|
/**
|
|
|
|
* The SHA sum of the released git commit
|
|
|
|
*/
|
|
|
|
QString gitSHA1() const;
|
|
|
|
|
2013-01-23 16:45:31 +04:00
|
|
|
/**
|
|
|
|
* About dialog contents
|
|
|
|
*/
|
|
|
|
virtual QString about() const;
|
|
|
|
|
2012-12-20 19:31:24 +04:00
|
|
|
/**
|
|
|
|
* 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;
|
2012-11-16 14:49:55 +04:00
|
|
|
|
2016-10-10 13:38:05 +03:00
|
|
|
/**
|
|
|
|
* Check if mono icons are available
|
|
|
|
*/
|
|
|
|
bool monoIconsAvailable() const;
|
|
|
|
|
2013-12-09 19:35:30 +04:00
|
|
|
/**
|
|
|
|
* @brief Where to check for new Updates.
|
|
|
|
*/
|
|
|
|
virtual QString updateCheckUrl() const;
|
|
|
|
|
2015-01-22 17:53:33 +03:00
|
|
|
/**
|
|
|
|
* When true, the setup wizard will show the selective sync dialog by default and default
|
|
|
|
* to nothing selected
|
|
|
|
*/
|
|
|
|
virtual bool wizardSelectiveSyncDefaultNothing() const;
|
|
|
|
|
2015-08-05 16:33:38 +03:00
|
|
|
/**
|
|
|
|
* Default option for the newBigFolderSizeLimit.
|
|
|
|
* Size in MB of the maximum size of folder before we ask the confirmation.
|
|
|
|
* Set -1 to never ask confirmation. 0 to ask confirmation for every folder.
|
|
|
|
**/
|
|
|
|
virtual qint64 newBigFolderSizeLimit() const;
|
|
|
|
|
2017-01-24 12:16:10 +03:00
|
|
|
/**
|
|
|
|
* Hide the checkbox that says "Ask for confirmation before synchronizing folders larger than X MB"
|
|
|
|
* in the account wizard
|
|
|
|
*/
|
|
|
|
virtual bool wizardHideFolderSizeLimitCheckbox() const;
|
|
|
|
/**
|
|
|
|
* Hide the checkbox that says "Ask for confirmation before synchronizing external storages"
|
|
|
|
* in the account wizard
|
|
|
|
*/
|
|
|
|
virtual bool wizardHideExternalStorageConfirmationCheckbox() const;
|
|
|
|
|
2015-02-18 19:49:07 +03:00
|
|
|
/**
|
|
|
|
* Alternative path on the server that provides access to the webdav capabilities
|
|
|
|
*
|
|
|
|
* Attention: Make sure that this string does NOT have a leading slash and that
|
|
|
|
* it has a trailing slash, for example "remote.php/webdav/".
|
|
|
|
*/
|
|
|
|
virtual QString webDavPath() const;
|
2015-11-03 00:57:17 +03:00
|
|
|
virtual QString webDavPathNonShib() const;
|
2015-02-18 19:49:07 +03:00
|
|
|
|
2016-02-22 15:53:45 +03:00
|
|
|
/**
|
|
|
|
* @brief Sharing options
|
|
|
|
*
|
|
|
|
* Allow link sharing and or user/group sharing
|
|
|
|
*/
|
|
|
|
virtual bool linkSharing() const;
|
|
|
|
virtual bool userGroupSharing() const;
|
|
|
|
|
2016-03-29 14:00:38 +03:00
|
|
|
/**
|
|
|
|
* If this returns true, the user cannot configure the proxy in the network settings.
|
|
|
|
* The proxy settings will be disabled in the configuration dialog.
|
|
|
|
* Default returns false.
|
|
|
|
*/
|
2016-03-11 18:21:40 +03:00
|
|
|
virtual bool forceSystemNetworkProxy() const;
|
|
|
|
|
2016-03-17 18:47:27 +03:00
|
|
|
/**
|
|
|
|
* @brief How to handle the userID
|
|
|
|
*
|
|
|
|
* @value UserIDUserName Wizard asks for user name as ID
|
|
|
|
* @value UserIDEmail Wizard asks for an email as ID
|
|
|
|
* @value UserIDCustom Specify string in \ref customUserID
|
|
|
|
*/
|
|
|
|
enum UserIDType { UserIDUserName = 0,
|
|
|
|
UserIDEmail,
|
|
|
|
UserIDCustom };
|
|
|
|
|
|
|
|
/** @brief What to display as the userID (e.g. in the wizards)
|
|
|
|
*
|
|
|
|
* @return UserIDType::UserIDUserName, unless reimplemented
|
|
|
|
*/
|
|
|
|
virtual UserIDType userIDType() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Allows to customize the type of user ID (e.g. user name, email)
|
|
|
|
*
|
|
|
|
* @note This string cannot be translated, but is still useful for
|
|
|
|
* referencing brand name IDs (e.g. "ACME ID", when using ACME.)
|
|
|
|
*
|
|
|
|
* @return An empty string, unless reimplemented
|
|
|
|
*/
|
|
|
|
virtual QString customUserID() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Demo string to be displayed when no text has been
|
|
|
|
* entered for the user id (e.g. mylogin@company.com)
|
|
|
|
*
|
|
|
|
* @return An empty string, unless reimplemented
|
|
|
|
*/
|
|
|
|
virtual QString userIDHint() const;
|
|
|
|
|
2016-03-22 12:20:20 +03:00
|
|
|
/**
|
|
|
|
* @brief Postfix that will be enforced in a URL. e.g.
|
|
|
|
* ".myhosting.com".
|
|
|
|
*
|
|
|
|
* @return An empty string, unless reimplemented
|
|
|
|
*/
|
|
|
|
virtual QString wizardUrlPostfix() const;
|
|
|
|
|
2016-04-13 16:59:25 +03:00
|
|
|
/**
|
|
|
|
* @brief String that will be shown as long as no text has been entered by the user.
|
|
|
|
*
|
|
|
|
* @return An empty string, unless reimplemented
|
|
|
|
*/
|
2016-04-12 17:24:06 +03:00
|
|
|
virtual QString wizardUrlHint() const;
|
|
|
|
|
2016-04-22 11:05:50 +03:00
|
|
|
/**
|
|
|
|
* @brief the server folder that should be queried for the quota information
|
|
|
|
*
|
|
|
|
* This can be configured to show the quota infromation for a different
|
|
|
|
* folder than the root. This is the folder on which the client will do
|
|
|
|
* PROPFIND calls to get "quota-available-bytes" and "quota-used-bytes"
|
|
|
|
*
|
|
|
|
* Defaults: "/"
|
|
|
|
*/
|
2016-04-22 11:09:07 +03:00
|
|
|
virtual QString quotaBaseFolder() const;
|
2016-04-12 17:24:06 +03:00
|
|
|
|
2017-03-28 11:31:38 +03:00
|
|
|
/**
|
|
|
|
* The OAuth client_id, secret pair.
|
|
|
|
* Note that client that change these value cannot connect to un-branded owncloud servers.
|
|
|
|
*/
|
|
|
|
virtual QString oauthClientId() const;
|
|
|
|
virtual QString oauthClientSecret() const;
|
|
|
|
|
2016-11-29 12:36:37 +03:00
|
|
|
|
2012-05-02 17:50:01 +04:00
|
|
|
protected:
|
2015-04-03 12:27:06 +03:00
|
|
|
#ifndef TOKEN_AUTH_ONLY
|
2016-10-06 18:18:51 +03:00
|
|
|
QIcon themeIcon(const QString &name, bool sysTray = false, bool sysTrayMenuVisible = false) const;
|
2015-04-03 12:27:06 +03:00
|
|
|
#endif
|
2014-06-20 14:44:24 +04:00
|
|
|
Theme();
|
2012-05-02 17:50:01 +04:00
|
|
|
|
2013-07-04 21:59:40 +04:00
|
|
|
signals:
|
|
|
|
void systrayUseMonoIconsChanged(bool);
|
|
|
|
|
2012-02-16 13:42:44 +04:00
|
|
|
private:
|
2012-10-26 00:40:20 +04:00
|
|
|
Theme(Theme const &);
|
|
|
|
Theme &operator=(Theme const &);
|
2012-09-24 19:55:10 +04:00
|
|
|
|
|
|
|
static Theme *_instance;
|
2012-12-20 19:31:24 +04:00
|
|
|
bool _mono;
|
2015-04-03 12:27:06 +03:00
|
|
|
#ifndef TOKEN_AUTH_ONLY
|
2015-03-25 16:57:23 +03:00
|
|
|
mutable QHash<QString, QIcon> _iconCache;
|
2015-04-03 12:27:06 +03:00
|
|
|
#endif
|
2012-02-16 13:42:44 +04:00
|
|
|
};
|
|
|
|
}
|
|
|
|
#endif // _THEME_H
|