1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #ifndef CHATVIEWSETTINGS_H
22 #define CHATVIEWSETTINGS_H
24 #include "qtuisettings.h"
30 class ChatViewSettings : public QtUiSettings
33 Q_ENUMS(OperationMode)
40 Q_DECLARE_FLAGS(operationModes, OperationMode);
42 ChatViewSettings(const QString &id = "__default__");
43 ChatViewSettings(ChatScene *scene);
44 ChatViewSettings(ChatView *view);
46 inline bool showWebPreview() { return localValue("ShowWebPreview", true).toBool(); }
47 inline void enableWebPreview(bool enabled) { setLocalValue("ShowWebPreview", enabled); }
50 * Gets if a custom timestamp format is used.
52 * @returns True if custom timestamp format used, otherwise false
54 inline bool useCustomTimestampFormat() { return localValue("UseCustomTimestampFormat", false).toBool(); }
56 * Sets whether a custom timestamp format is used.
58 * @param[in] enabled True if custom timestamp format used, otherwise false
60 inline void setUseCustomTimestampFormat(bool enabled) { setLocalValue("UseCustomTimestampFormat", enabled); }
63 * Gets the format string for chat log timestamps.
65 * @returns String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
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.
71 * Sets the format string for chat log timestamps
73 * @param[in] format String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
75 inline void setTimestampFormatString(const QString &format) { setLocalValue("TimestampFormat", format); }
78 * Gets how prefix modes are shown before sender names
80 * @returns SenderPrefixMode of what format to use for showing sender prefix modes
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.
91 // There's probably a cleaner way of doing this. I couldn't find it within 4 hours, so...
95 * Gets if brackets are shown around sender names
97 * @returns True if sender brackets enabled, otherwise false
99 inline bool showSenderBrackets() { return localValue("ShowSenderBrackets", false).toBool(); }
101 * Sets whether brackets are shown around around sender names.
103 * @param[in] enabled True if enabling sender brackets, otherwise false
105 inline void enableSenderBrackets(bool enabled) { setLocalValue("ShowSenderBrackets", enabled); }
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); }
112 Q_DECLARE_METATYPE(ChatViewSettings::OperationMode)
113 #endif //CHATVIEWSETTINGS_H