src/qtui/chatviewsettings.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2020 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     {
  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     bool showWebPreview() const;
  47     void enableWebPreview(bool 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     bool useCustomTimestampFormat() const;
  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     void setUseCustomTimestampFormat(bool 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     QString timestampFormatString() const;
  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     void setTimestampFormatString(const QString& 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     UiStyle::SenderPrefixMode senderPrefixDisplay() const;
  83
  84     /**
  85      * Gets if brackets are shown around sender names
  86      *
  87      * @returns True if sender brackets enabled, otherwise false
  88      */
  89     bool showSenderBrackets() const;
  90     /**
  91      * Sets whether brackets are shown around around sender names.
  92      *
  93      * @param[in] enabled True if enabling sender brackets, otherwise false
  94      */
  95     void enableSenderBrackets(bool enabled);
  96
  97     QString webSearchUrlFormatString() const;
  98     void setWebSearchUrlFormatString(const QString& format);
  99 };
 100
 101 Q_DECLARE_METATYPE(ChatViewSettings::OperationMode)