src/uisupport/uisettings.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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 #ifndef UISETTINGS_H
  22 #define UISETTINGS_H
  23
  24 #include "clientsettings.h"
  25 #include "uistyle.h"
  26
  27 class UiSettings : public ClientSettings
  28 {
  29 public:
  30     UiSettings(const QString &group = "Ui");
  31
  32     virtual inline void setValue(const QString &key, const QVariant &data) { setLocalValue(key, data); }
  33     virtual inline QVariant value(const QString &key, const QVariant &def = QVariant()) { return localValue(key, def); }
  34
  35     /**
  36      * Gets if a value exists in settings
  37      *
  38      * @param[in] key ID of local settings key
  39      * @returns True if key exists in settings, otherwise false
  40      */
  41     virtual inline bool valueExists(const QString &key) { return localKeyExists(key); }
  42
  43     inline void remove(const QString &key) { removeLocalKey(key); }
  44 };
  45
  46
  47 class UiStyleSettings : public UiSettings
  48 {
  49 public:
  50     UiStyleSettings();
  51     UiStyleSettings(const QString &subGroup);
  52
  53     void setCustomFormat(UiStyle::FormatType, QTextCharFormat);
  54     QTextCharFormat customFormat(UiStyle::FormatType);
  55
  56     void removeCustomFormat(UiStyle::FormatType);
  57     QList<UiStyle::FormatType> availableFormats();
  58 };
  59
  60
  61 class SessionSettings : public UiSettings
  62 {
  63 public:
  64     SessionSettings(const QString &sessionId, const QString &group = "Session");
  65
  66     virtual void setValue(const QString &key, const QVariant &data);
  67     virtual QVariant value(const QString &key, const QVariant &def = QVariant());
  68
  69     void removeKey(const QString &key);
  70     void removeSession();
  71
  72     void cleanup();
  73     void sessionAging();
  74
  75     int sessionAge();
  76     void setSessionAge(int age);
  77     inline const QString sessionId() { return _sessionId; };
  78     inline void setSessionId(const QString &sessionId) { _sessionId = sessionId; }
  79
  80 private:
  81     QString _sessionId;
  82 };
  83
  84
  85 class ShortcutSettings : public UiSettings
  86 {
  87 public:
  88     ShortcutSettings();
  89
  90     //! Remove all stored shortcuts
  91     void clear();
  92
  93     QStringList savedShortcuts();
  94
  95     void saveShortcut(const QString &name, const QKeySequence &shortcut);
  96     QKeySequence loadShortcut(const QString &name);
  97 };
  98
  99
 100 #endif