src/qtui/chatviewsettings.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 CHATVIEWSETTINGS_H
  22 #define CHATVIEWSETTINGS_H
  23
  24 #include "qtuisettings.h"
  25 #include "uistyle.h"
  26
  27 class ChatScene;
  28 class ChatView;
  29
  30 class ChatViewSettings : public QtUiSettings
  31 {
  32 public:
  33     Q_ENUMS(OperationMode)
  34 public:
  35     enum OperationMode {
  36         InvalidMode = 0,
  37         OptIn = 1,
  38         OptOut = 2
  39     };
  40     Q_DECLARE_FLAGS(operationModes, OperationMode)
  41
  42     ChatViewSettings(const QString &id = "__default__");
  43     ChatViewSettings(ChatScene *scene);
  44     ChatViewSettings(ChatView *view);
  45
  46     inline bool showWebPreview() { return localValue("ShowWebPreview", false).toBool(); }
  47     inline void enableWebPreview(bool enabled) { setLocalValue("ShowWebPreview", enabled); }
  48
  49     /**
  50      * Gets if a custom timestamp format is used.
  51      *
  52      * @returns True if custom timestamp format used, otherwise false
  53      */
  54     inline bool useCustomTimestampFormat() { return localValue("UseCustomTimestampFormat", false).toBool(); }
  55     /**
  56      * Sets whether a custom timestamp format is used.
  57      *
  58      * @param[in] enabled True if custom timestamp format used, otherwise false
  59      */
  60     inline void setUseCustomTimestampFormat(bool enabled) { setLocalValue("UseCustomTimestampFormat", enabled); }
  61
  62     /**
  63      * Gets the format string for chat log timestamps.
  64      *
  65      * @returns String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
  66      */
  67     inline QString timestampFormatString() { return localValue("TimestampFormat", " hh:mm:ss").toString(); }
  68     // Include a space in the default TimestampFormat to give the timestamp a small bit of padding
  69     // between the border of the chat buffer window and the numbers.  Helps with readability.
  70     /**
  71      * Sets the format string for chat log timestamps
  72      *
  73      * @param[in] format String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
  74      */
  75     inline void setTimestampFormatString(const QString &format) { setLocalValue("TimestampFormat", format); }
  76
  77     /**
  78      * Gets how prefix modes are shown before sender names
  79      *
  80      * @returns SenderPrefixMode of what format to use for showing sender prefix modes
  81      */
  82     inline UiStyle::SenderPrefixMode SenderPrefixDisplay() {
  83         return static_cast<UiStyle::SenderPrefixMode>(
  84                     localValue("SenderPrefixMode",
  85                                QVariant::fromValue<UiStyle::SenderPrefixMode>(
  86                                    UiStyle::SenderPrefixMode::HighestMode)).toInt());
  87         // Cast the QVariant to an integer, then cast that to the enum class.
  88         // .canConvert<UiStyle::SenderPrefixMode>() returned true, but
  89         // .value<UiStyle::SenderPrefixMode>(); always gave the default value 0.
  90         //
  91         // There's probably a cleaner way of doing this.  I couldn't find it within 4 hours, so...
  92     }
  93
  94     /**
  95      * Gets if brackets are shown around sender names
  96      *
  97      * @returns True if sender brackets enabled, otherwise false
  98      */
  99     inline bool showSenderBrackets() { return localValue("ShowSenderBrackets", false).toBool(); }
 100     /**
 101      * Sets whether brackets are shown around around sender names.
 102      *
 103      * @param[in] enabled True if enabling sender brackets, otherwise false
 104      */
 105     inline void enableSenderBrackets(bool enabled) { setLocalValue("ShowSenderBrackets", enabled); }
 106
 107     inline QString webSearchUrlFormatString() { return localValue("WebSearchUrlFormat", "https://www.google.com/search?q=%s").toString(); }
 108     inline void setWebSearchUrlFormatString(const QString &format) { setLocalValue("WebSearchUrlFormat", format); }
 109 };
 110
 111
 112 Q_DECLARE_METATYPE(ChatViewSettings::OperationMode)
 113 #endif //CHATVIEWSETTINGS_H