src/uisupport/multilineedit.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 "uisupport-export.h"
  24
  25 #include <QKeyEvent>
  26 #include <QHash>
  27
  28 #if defined HAVE_KF5
  29 #  include <KTextWidgets/KTextEdit>
  30 #  define MultiLineEditParent KTextEdit
  31 #else
  32 #  include <QTextEdit>
  33 #  define MultiLineEditParent QTextEdit
  34 #endif
  35
  36 #if defined HAVE_SONNET && !defined HAVE_KDE
  37 #  include <QContextMenuEvent>
  38 #  include <Sonnet/Highlighter>
  39 #  include <Sonnet/SpellCheckDecorator>
  40 #endif
  41
  42 class UISUPPORT_EXPORT MultiLineEdit : public MultiLineEditParent
  43 {
  44     Q_OBJECT
  45
  46 public:
  47     enum Mode {
  48         SingleLine,
  49         MultiLine
  50     };
  51
  52     MultiLineEdit(QWidget *parent = nullptr);
  53     ~MultiLineEdit() override;
  54
  55     void setCustomFont(const QFont &); // should be used instead setFont(), so we can set our size correctly
  56
  57     // Compatibility methods with the rest of the classes which still expect this to be a QLineEdit
  58     inline QString text() const { return toPlainText(); }
  59     inline QString html() const { return toHtml(); }
  60     inline int cursorPosition() const { return textCursor().position(); }
  61     inline void insert(const QString &newText) { insertPlainText(newText); }
  62     inline void backspace() { keyPressEvent(new QKeyEvent(QEvent::KeyPress, Qt::Key_Backspace, Qt::NoModifier)); }
  63     inline bool hasSelectedText() const { return textCursor().hasSelection(); }
  64
  65     inline bool isSingleLine() const { return _singleLine; }
  66     inline bool pasteProtectionEnabled() const { return _pasteProtectionEnabled; }
  67
  68     QSize sizeHint() const override;
  69     QSize minimumSizeHint() const override;
  70
  71     inline QString mircColorFromRGB(QString rgbColor) const { return _mircColorMap.key(rgbColor); }
  72     inline QString rgbColorFromMirc(QString mircColor) const { return _mircColorMap[mircColor]; }
  73     inline QMap<QString, QString>  mircColorMap() const { return _mircColorMap; }
  74
  75     inline QStringList history() const { return _history; }
  76     inline QHash<int, QString> tempHistory() const { return _tempHistory; }
  77     inline qint32 idx() const { return _idx; }
  78     inline bool emacsMode() const { return _emacsMode; }
  79
  80     void addCompletionSpace();
  81
  82 public slots:
  83     void setMode(Mode mode);
  84     void setMinHeight(int numLines);
  85     void setMaxHeight(int numLines);
  86     void setEmacsMode(bool enable = true);
  87     void setScrollBarsEnabled(bool enable = true);
  88     void setPasteProtectionEnabled(bool enable = true, QWidget *msgBoxParent = nullptr);
  89     void setLineWrapEnabled(bool enable = false);
  90
  91     inline void setHistory(QStringList history) { _history = history; }
  92     inline void setTempHistory(QHash<int, QString> tempHistory) { _tempHistory = tempHistory; }
  93     inline void setIdx(qint32 idx) { _idx = idx; }
  94
  95 signals:
  96     void textEntered(const QString &text);
  97     void noTextEntered();
  98
  99 protected:
 100     bool event(QEvent *e) override;
 101     void keyPressEvent(QKeyEvent *event) override;
 102     void resizeEvent(QResizeEvent *event) override;
 103
 104 #if defined HAVE_SONNET && !defined HAVE_KDE
 105     void contextMenuEvent(QContextMenuEvent *event) override;
 106 #endif
 107
 108 private slots:
 109     void on_returnPressed();
 110     void on_returnPressed(QString text);
 111     void on_textChanged();
 112     void on_documentHeightChanged(qreal height);
 113
 114     bool addToHistory(const QString &text, bool temporary = false);
 115     void historyMoveForward();
 116     void historyMoveBack();
 117
 118     QString convertRichtextToMircCodes();
 119     QString convertMircCodesToHtml(const QString &text);
 120     bool mircCodesChanged(QTextCursor &cursor, QTextCursor &peekcursor);
 121
 122 private:
 123     void reset();
 124     void showHistoryEntry();
 125     void updateScrollBars();
 126     void updateSizeHint();
 127
 128 private:
 129     QStringList _history;
 130     QHash<int, QString> _tempHistory;
 131     qint32 _idx;
 132     Mode _mode;
 133     bool _singleLine;
 134     int _minHeight;
 135     int _maxHeight;
 136     bool _scrollBarsEnabled;
 137     bool _pasteProtectionEnabled;
 138     bool _emacsMode;
 139     int _completionSpace;
 140
 141     QSize _sizeHint;
 142     qreal _lastDocumentHeight;
 143
 144     QMap<QString, QString> _mircColorMap;
 145
 146 #if defined HAVE_SONNET && !defined HAVE_KDE
 147     // This member function is provided by KTextEdit
 148     Sonnet::Highlighter *highlighter() const;
 149
 150 private slots:
 151     void setSpellCheckEnabled(bool enabled);
 152
 153 private:
 154     Sonnet::SpellCheckDecorator *_spellCheckDecorator{nullptr};
 155 #endif
 156 };