Add rough instructions for synchronizing the i18n repository
[quassel.git] / src / uisupport / uisettings.h
1 /***************************************************************************
2  *   Copyright (C) 2005-2020 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) version 3.                                           *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
19  ***************************************************************************/
20
21 #pragma once
22
23 #include "uisupport-export.h"
24
25 #include "clientsettings.h"
26 #include "uistyle.h"
27
28 class UISUPPORT_EXPORT UiSettings : public ClientSettings
29 {
30 public:
31     UiSettings(QString group = "Ui");
32
33     virtual void setValue(const QString& key, const QVariant& data);
34     virtual QVariant value(const QString& key, const QVariant& def = {}) const;
35
36     /**
37      * Gets if a value exists in settings
38      *
39      * @param[in] key ID of local settings key
40      * @returns True if key exists in settings, otherwise false
41      */
42     bool valueExists(const QString& key) const;
43
44     void remove(const QString& key);
45 };
46
47 class UISUPPORT_EXPORT UiStyleSettings : public UiSettings
48 {
49 public:
50     UiStyleSettings();
51     UiStyleSettings(const QString& subGroup);
52
53     void setCustomFormat(UiStyle::FormatType, const QTextCharFormat& format);
54     QTextCharFormat customFormat(UiStyle::FormatType) const;
55
56     void removeCustomFormat(UiStyle::FormatType);
57     QList<UiStyle::FormatType> availableFormats() const;
58 };
59
60 class UISUPPORT_EXPORT SessionSettings : public UiSettings
61 {
62 public:
63     SessionSettings(QString sessionId, QString group = "Session");
64
65     void setValue(const QString& key, const QVariant& data) override;
66     QVariant value(const QString& key, const QVariant& def = {}) const override;
67
68     void removeKey(const QString& key);
69     void removeSession();
70
71     void cleanup();
72     void sessionAging();
73
74     int sessionAge();
75     void setSessionAge(int age);
76     QString sessionId() const;
77     void setSessionId(QString sessionId);
78
79 private:
80     QString _sessionId;
81 };
82
83 class UISUPPORT_EXPORT ShortcutSettings : public UiSettings
84 {
85 public:
86     ShortcutSettings();
87
88     //! Remove all stored shortcuts
89     void clear();
90
91     QStringList savedShortcuts() const;
92
93     void saveShortcut(const QString& name, const QKeySequence& shortcut);
94     QKeySequence loadShortcut(const QString& name) const;
95 };