qa: Remove lots of superfluous semicolons
[quassel.git] / src / qtui / chatviewsettings.h
index 01d9d71..19aed61 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #ifndef CHATVIEWSETTINGS_H
 #define CHATVIEWSETTINGS_H
 
 #include "qtuisettings.h"
+#include "uistyle.h"
 
-class ChatViewSettings : public QtUiSettings {
+class ChatScene;
+class ChatView;
+
+class ChatViewSettings : public QtUiSettings
+{
+public:
+    Q_ENUMS(OperationMode)
 public:
-  ChatViewSettings(const QString &id = "__default__");
+    enum OperationMode {
+        InvalidMode = 0,
+        OptIn = 1,
+        OptOut = 2
+    };
+    Q_DECLARE_FLAGS(operationModes, OperationMode)
+
+    ChatViewSettings(const QString &id = "__default__");
+    ChatViewSettings(ChatScene *scene);
+    ChatViewSettings(ChatView *view);
+
+    inline bool showWebPreview() { return localValue("ShowWebPreview", false).toBool(); }
+    inline void enableWebPreview(bool enabled) { setLocalValue("ShowWebPreview", enabled); }
+
+    /**
+     * Gets if a custom timestamp format is used.
+     *
+     * @returns True if custom timestamp format used, otherwise false
+     */
+    inline bool useCustomTimestampFormat() { return localValue("UseCustomTimestampFormat", false).toBool(); }
+    /**
+     * Sets whether a custom timestamp format is used.
+     *
+     * @param[in] enabled True if custom timestamp format used, otherwise false
+     */
+    inline void setUseCustomTimestampFormat(bool enabled) { setLocalValue("UseCustomTimestampFormat", enabled); }
+
+    /**
+     * Gets the format string for chat log timestamps.
+     *
+     * @returns String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
+     */
+    inline QString timestampFormatString() { return localValue("TimestampFormat", " hh:mm:ss").toString(); }
+    // Include a space in the default TimestampFormat to give the timestamp a small bit of padding
+    // between the border of the chat buffer window and the numbers.  Helps with readability.
+    /**
+     * Sets the format string for chat log timestamps
+     *
+     * @param[in] format String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
+     */
+    inline void setTimestampFormatString(const QString &format) { setLocalValue("TimestampFormat", format); }
+
+    /**
+     * Gets how prefix modes are shown before sender names
+     *
+     * @returns SenderPrefixMode of what format to use for showing sender prefix modes
+     */
+    inline UiStyle::SenderPrefixMode SenderPrefixDisplay() {
+        return static_cast<UiStyle::SenderPrefixMode>(
+                    localValue("SenderPrefixMode",
+                               QVariant::fromValue<UiStyle::SenderPrefixMode>(
+                                   UiStyle::SenderPrefixMode::HighestMode)).toInt());
+        // Cast the QVariant to an integer, then cast that to the enum class.
+        // .canConvert<UiStyle::SenderPrefixMode>() returned true, but
+        // .value<UiStyle::SenderPrefixMode>(); always gave the default value 0.
+        //
+        // There's probably a cleaner way of doing this.  I couldn't find it within 4 hours, so...
+    }
+
+    /**
+     * Gets if brackets are shown around sender names
+     *
+     * @returns True if sender brackets enabled, otherwise false
+     */
+    inline bool showSenderBrackets() { return localValue("ShowSenderBrackets", false).toBool(); }
+    /**
+     * Sets whether brackets are shown around around sender names.
+     *
+     * @param[in] enabled True if enabling sender brackets, otherwise false
+     */
+    inline void enableSenderBrackets(bool enabled) { setLocalValue("ShowSenderBrackets", enabled); }
+
+    inline QString webSearchUrlFormatString() { return localValue("WebSearchUrlFormat", "https://www.google.com/search?q=%s").toString(); }
+    inline void setWebSearchUrlFormatString(const QString &format) { setLocalValue("WebSearchUrlFormat", format); }
 };
 
+
+Q_DECLARE_METATYPE(ChatViewSettings::OperationMode)
 #endif //CHATVIEWSETTINGS_H