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 #pragma once
  22
  23 #include "qtuisettings.h"
  24 #include "uistyle.h"
  25
  26 class ChatScene;
  27 class ChatView;
  28
  29 class ChatViewSettings : public QtUiSettings
  30 {
  31 public:
  32     Q_ENUMS(OperationMode)
  33 public:
  34     enum OperationMode {
  35         InvalidMode = 0,
  36         OptIn = 1,
  37         OptOut = 2
  38     };
  39     Q_DECLARE_FLAGS(OperationModes, OperationMode)
  40
  41     ChatViewSettings(const QString &id = "__default__");
  42     ChatViewSettings(ChatScene *scene);
  43     ChatViewSettings(ChatView *view);
  44
  45     bool showWebPreview() const;
  46     void enableWebPreview(bool enabled);
  47
  48     /**
  49      * Gets if a custom timestamp format is used.
  50      *
  51      * @returns True if custom timestamp format used, otherwise false
  52      */
  53     bool useCustomTimestampFormat() const;
  54     /**
  55      * Sets whether a custom timestamp format is used.
  56      *
  57      * @param[in] enabled True if custom timestamp format used, otherwise false
  58      */
  59     void setUseCustomTimestampFormat(bool enabled);
  60
  61     /**
  62      * Gets the format string for chat log timestamps.
  63      *
  64      * @returns String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
  65      */
  66     QString timestampFormatString() const;
  67     // Include a space in the default TimestampFormat to give the timestamp a small bit of padding
  68     // between the border of the chat buffer window and the numbers.  Helps with readability.
  69     /**
  70      * Sets the format string for chat log timestamps
  71      *
  72      * @param[in] format String representing timestamp format, e.g. "[hh:mm:ss]" or " hh:mm:ss"
  73      */
  74     void setTimestampFormatString(const QString &format);
  75
  76     /**
  77      * Gets how prefix modes are shown before sender names
  78      *
  79      * @returns SenderPrefixMode of what format to use for showing sender prefix modes
  80      */
  81     UiStyle::SenderPrefixMode senderPrefixDisplay() const;
  82
  83     /**
  84      * Gets if brackets are shown around sender names
  85      *
  86      * @returns True if sender brackets enabled, otherwise false
  87      */
  88     bool showSenderBrackets() const;
  89     /**
  90      * Sets whether brackets are shown around around sender names.
  91      *
  92      * @param[in] enabled True if enabling sender brackets, otherwise false
  93      */
  94     void enableSenderBrackets(bool enabled);
  95
  96     QString webSearchUrlFormatString() const;
  97     void setWebSearchUrlFormatString(const QString &format);
  98 };
  99
 100 Q_DECLARE_METATYPE(ChatViewSettings::OperationMode)