qa: Avoid deprecation warnings for QList/QSet conversions
[quassel.git] / src / qtui / chatviewsettings.h
index ef5f4d3..1728f01 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-09 by the Quassel Project                          *
+ *   Copyright (C) 2005-2019 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
+#pragma once
 
 #include "qtuisettings.h"
+#include "uistyle.h"
 
 class ChatScene;
 class ChatView;
 
-class ChatViewSettings : public QtUiSettings {
+class ChatViewSettings : public QtUiSettings
+{
 public:
-  Q_ENUMS(OperationMode)
-  public:
-    enum OperationMode {
-      InvalidMode = 0,
-      OptIn = 1,
-      OptOut = 2
+    Q_ENUMS(OperationMode)
+public:
+    enum OperationMode
+    {
+        InvalidMode = 0,
+        OptIn = 1,
+        OptOut = 2
     };
-  Q_DECLARE_FLAGS(operationModes, OperationMode);
+    Q_DECLARE_FLAGS(OperationModes, OperationMode)
+
+    ChatViewSettings(const QString& id = "__default__");
+    ChatViewSettings(ChatScene* scene);
+    ChatViewSettings(ChatView* view);
+
+    bool showWebPreview() const;
+    void enableWebPreview(bool enabled);
 
-  ChatViewSettings(const QString &id = "__default__");
-  ChatViewSettings(ChatScene *scene);
-  ChatViewSettings(ChatView *view);
+    /**
+     * Gets if a custom timestamp format is used.
+     *
+     * @returns True if custom timestamp format used, otherwise false
+     */
+    bool useCustomTimestampFormat() const;
+    /**
+     * Sets whether a custom timestamp format is used.
+     *
+     * @param[in] enabled True if custom timestamp format used, otherwise false
+     */
+    void setUseCustomTimestampFormat(bool enabled);
 
-  inline bool showWebPreview() { return localValue("ShowWebPreview", true).toBool(); }
-  inline void enableWebPreview(bool enabled) { setLocalValue("ShowWebPreview", enabled); }
+    /**
+     * Gets the format string for chat log timestamps.
+     *
+     * @returns String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
+     */
+    QString timestampFormatString() const;
+    // 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"
+     */
+    void setTimestampFormatString(const QString& format);
 
-  inline QString timestampFormatString() { return localValue("TimestampFormat", "[hh:mm:ss]").toString(); }
-  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
+     */
+    UiStyle::SenderPrefixMode senderPrefixDisplay() const;
+
+    /**
+     * Gets if brackets are shown around sender names
+     *
+     * @returns True if sender brackets enabled, otherwise false
+     */
+    bool showSenderBrackets() const;
+    /**
+     * Sets whether brackets are shown around around sender names.
+     *
+     * @param[in] enabled True if enabling sender brackets, otherwise false
+     */
+    void enableSenderBrackets(bool enabled);
+
+    QString webSearchUrlFormatString() const;
+    void setWebSearchUrlFormatString(const QString& format);
 };
-Q_DECLARE_METATYPE(ChatViewSettings::OperationMode);
-#endif //CHATVIEWSETTINGS_H
+
+Q_DECLARE_METATYPE(ChatViewSettings::OperationMode)