src: Yearly copyright bump
[quassel.git] / src / uisupport / multilineedit.h
index 3218e81..2546266 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2012 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 MULTILINEEDIT_H_
-#define MULTILINEEDIT_H_
+#pragma once
+
+#include "uisupport-export.h"
 
-#include <QKeyEvent>
 #include <QHash>
+#include <QKeyEvent>
 
-#ifdef HAVE_KDE
-#  include <KDE/KTextEdit>
-#  define MultiLineEditParent KTextEdit
+#if defined HAVE_KF5
+#    include <KTextWidgets/KTextEdit>
+#    define MultiLineEditParent KTextEdit
 #else
-#  include <QTextEdit>
-#  define MultiLineEditParent QTextEdit
+#    include <QTextEdit>
+#    define MultiLineEditParent QTextEdit
 #endif
 
-class QKeyEvent;
-class TabCompleter;
+#if defined HAVE_SONNET && !defined HAVE_KDE
+#    include <QContextMenuEvent>
 
-class MultiLineEdit : public MultiLineEditParent {
-  Q_OBJECT
+#    include <Sonnet/Highlighter>
+#    include <Sonnet/SpellCheckDecorator>
+#endif
 
-public:
-  enum Mode {
-    SingleLine,
-    MultiLine
-  };
+class UISUPPORT_EXPORT MultiLineEdit : public MultiLineEditParent
+{
+    Q_OBJECT
 
-  MultiLineEdit(QWidget *parent = 0);
-  ~MultiLineEdit();
+public:
+    enum Mode
+    {
+        SingleLine,
+        MultiLine
+    };
 
-  void setCustomFont(const QFont &); // should be used instead setFont(), so we can set our size correctly
+    MultiLineEdit(QWidget* parent = nullptr);
 
-  // Compatibility methods with the rest of the classes which still expect this to be a QLineEdit
-  inline QString text() const { return toPlainText(); }
-  inline QString html() const { return toHtml(); }
-  inline int cursorPosition() const { return textCursor().position(); }
-  inline void insert(const QString &newText) { insertPlainText(newText); }
-  inline void backspace() { keyPressEvent(new QKeyEvent(QEvent::KeyPress, Qt::Key_Backspace, Qt::NoModifier)); }
-  inline bool hasSelectedText() const { return textCursor().hasSelection(); }
+    void setCustomFont(const QFont&);  // should be used instead setFont(), so we can set our size correctly
 
-  inline bool isSingleLine() const { return _singleLine; }
-  inline bool pasteProtectionEnabled() const { return _pasteProtectionEnabled; }
+    // Compatibility methods with the rest of the classes which still expect this to be a QLineEdit
+    inline QString text() const { return toPlainText(); }
+    inline QString html() const { return toHtml(); }
+    inline int cursorPosition() const { return textCursor().position(); }
+    inline void insert(const QString& newText) { insertPlainText(newText); }
+    inline void backspace() { keyPressEvent(new QKeyEvent(QEvent::KeyPress, Qt::Key_Backspace, Qt::NoModifier)); }
+    inline bool hasSelectedText() const { return textCursor().hasSelection(); }
 
-  virtual QSize sizeHint() const;
-  virtual QSize minimumSizeHint() const;
+    inline bool isSingleLine() const { return _singleLine; }
+    inline bool pasteProtectionEnabled() const { return _pasteProtectionEnabled; }
 
-  inline QString mircColorFromRGB(QString rgbColor) const { return _mircColorMap.key(rgbColor); }
-  inline QString rgbColorFromMirc(QString mircColor) const { return _mircColorMap[mircColor]; }
-  inline QMap<QString, QString>  mircColorMap() const { return _mircColorMap; }
+    QSize sizeHint() const override;
+    QSize minimumSizeHint() const override;
 
-  inline QStringList history() const { return _history; }
-  inline QHash<int, QString> tempHistory() const { return _tempHistory; }
-  inline qint32 idx() const { return _idx; }
-  inline bool emacsMode() const { return _emacsMode; }
+    inline QString mircColorFromRGB(QString rgbColor) const { return _mircColorMap.key(rgbColor); }
+    inline QString rgbColorFromMirc(QString mircColor) const { return _mircColorMap[mircColor]; }
+    inline QMap<QString, QString> mircColorMap() const { return _mircColorMap; }
 
-public slots:
-  void setMode(Mode mode);
-  void setMinHeight(int numLines);
-  void setMaxHeight(int numLines);
-  void setEmacsMode(bool enable = true);
-  void setScrollBarsEnabled(bool enable = true);
-  void setSpellCheckEnabled(bool enable = true);
-  void setPasteProtectionEnabled(bool enable = true, QWidget *msgBoxParent = 0);
+    inline QStringList history() const { return _history; }
+    inline QHash<int, QString> tempHistory() const { return _tempHistory; }
+    inline qint32 idx() const { return _idx; }
+    inline bool emacsMode() const { return _emacsMode; }
 
-  // Note: Enabling wrap will make isSingleLine() not work correctly, so only use this if minHeight() > 1!
-  void setWordWrapEnabled(bool enable = true);
+    void addCompletionSpace();
 
-  inline void setHistory(QStringList history) { _history = history; }
-  inline void setTempHistory(QHash<int, QString> tempHistory) { _tempHistory = tempHistory; }
-  inline void setIdx(qint32 idx) { _idx = idx; }
+public slots:
+    void setMode(Mode mode);
+    void setMinHeight(int numLines);
+    void setMaxHeight(int numLines);
+    void setEmacsMode(bool enable = true);
+    void setScrollBarsEnabled(bool enable = true);
+    void setPasteProtectionEnabled(bool enable = true, QWidget* msgBoxParent = nullptr);
+    void setLineWrapEnabled(bool enable = false);
+
+    inline void setHistory(QStringList history) { _history = history; }
+    inline void setTempHistory(QHash<int, QString> tempHistory) { _tempHistory = tempHistory; }
+    inline void setIdx(qint32 idx) { _idx = idx; }
 
 signals:
-  void textEntered(const QString &text);
-  void noTextEntered();
+    void textEntered(const QString& text);
+    void noTextEntered();
 
 protected:
-  virtual bool event(QEvent *e);
-  virtual void keyPressEvent(QKeyEvent * event);
-  virtual void resizeEvent(QResizeEvent *event);
+    bool event(QEvent* e) override;
+    void keyPressEvent(QKeyEvent* event) override;
+    void resizeEvent(QResizeEvent* event) override;
+
+#if defined HAVE_SONNET && !defined HAVE_KDE
+    void contextMenuEvent(QContextMenuEvent* event) override;
+#endif
 
 private slots:
-  void on_returnPressed();
-  void on_returnPressed(const QString &text);
-  void on_textChanged();
-  void on_documentHeightChanged(qreal height);
+    void on_returnPressed();
+    void on_returnPressed(QString text);
+    void on_textChanged();
+    void on_documentHeightChanged(qreal height);
 
-  bool addToHistory(const QString &text, bool temporary = false);
-  void historyMoveForward();
-  void historyMoveBack();
+    bool addToHistory(const QString& text, bool temporary = false);
+    void historyMoveForward();
+    void historyMoveBack();
 
-  QString convertRichtextToMircCodes();
-  QString convertMircCodesToHtml(const QString &text);
-  bool mircCodesChanged(QTextCursor &cursor, QTextCursor &peekcursor);
+    QString convertRichtextToMircCodes();
+    QString convertMircCodesToHtml(const QString& text);
+    bool mircCodesChanged(QTextCursor& cursor, QTextCursor& peekcursor);
 
 private:
-  QStringList _history;
-  QHash<int, QString> _tempHistory;
-  qint32 _idx;
-  Mode _mode;
-  bool _singleLine;
-  int _minHeight;
-  int _maxHeight;
-  bool _scrollBarsEnabled;
-  bool _pasteProtectionEnabled;
-  bool _emacsMode;
-
-  QSize _sizeHint;
-  qreal _lastDocumentHeight;
-
-  QMap<QString, QString> _mircColorMap;
-
-  void reset();
-  void showHistoryEntry();
-  void updateScrollBars();
-  void updateSizeHint();
-};
+    void reset();
+    void showHistoryEntry();
+    void updateScrollBars();
+    void updateSizeHint();
+
+private:
+    QStringList _history;
+    QHash<int, QString> _tempHistory;
+    qint32 _idx{0};
+    Mode _mode{SingleLine};
+    bool _singleLine{true};
+    int _minHeight{1};
+    int _maxHeight{5};
+    bool _scrollBarsEnabled{true};
+    bool _pasteProtectionEnabled{true};
+    bool _emacsMode{false};
+    int _completionSpace{0};
+
+    QSize _sizeHint;
+    qreal _lastDocumentHeight{-1};
+
+    QMap<QString, QString> _mircColorMap;
+
+#if defined HAVE_SONNET && !defined HAVE_KDE
+    // This member function is provided by KTextEdit
+    Sonnet::Highlighter* highlighter() const;
 
+private slots:
+    void setSpellCheckEnabled(bool enabled);
+
+private:
+    Sonnet::SpellCheckDecorator* _spellCheckDecorator{nullptr};
 #endif
+};