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 #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
  48 class UISUPPORT_EXPORT UiStyleSettings : public UiSettings
  49 {
  50 public:
  51     UiStyleSettings();
  52     UiStyleSettings(const QString &subGroup);
  53
  54     void setCustomFormat(UiStyle::FormatType, const QTextCharFormat &format);
  55     QTextCharFormat customFormat(UiStyle::FormatType) const;
  56
  57     void removeCustomFormat(UiStyle::FormatType);
  58     QList<UiStyle::FormatType> availableFormats() const;
  59 };
  60
  61
  62 class UISUPPORT_EXPORT SessionSettings : public UiSettings
  63 {
  64 public:
  65     SessionSettings(QString sessionId, QString group = "Session");
  66
  67     void setValue(const QString &key, const QVariant &data) override;
  68     QVariant value(const QString &key, const QVariant &def = {}) const override;
  69
  70     void removeKey(const QString &key);
  71     void removeSession();
  72
  73     void cleanup();
  74     void sessionAging();
  75
  76     int sessionAge();
  77     void setSessionAge(int age);
  78     QString sessionId() const;
  79     void setSessionId(QString sessionId);
  80
  81 private:
  82     QString _sessionId;
  83 };
  84
  85
  86 class UISUPPORT_EXPORT ShortcutSettings : public UiSettings
  87 {
  88 public:
  89     ShortcutSettings();
  90
  91     //! Remove all stored shortcuts
  92     void clear();
  93
  94     QStringList savedShortcuts() const;
  95
  96     void saveShortcut(const QString &name, const QKeySequence &shortcut);
  97     QKeySequence loadShortcut(const QString &name) const;
  98 };