src/uisupport/multilineedit.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef MULTILINEEDIT_H_
  22 #define MULTILINEEDIT_H_
  23
  24 #include <QKeyEvent>
  25 #include <QHash>
  26 #include <QTextEdit>
  27
  28 #ifdef HAVE_KDE
  29 #  include <KDE/KTextEdit>
  30 #endif
  31
  32 class QKeyEvent;
  33 class TabCompleter;
  34
  35 class MultiLineEdit : public
  36 #ifdef HAVE_KDE
  37                   KTextEdit
  38 #else
  39                   QTextEdit
  40 #endif
  41 {
  42   Q_OBJECT
  43
  44 public:
  45   enum Mode {
  46     SingleLine,
  47     MultiLine
  48   };
  49
  50   MultiLineEdit(QWidget *parent = 0);
  51   ~MultiLineEdit();
  52
  53   void setCustomFont(const QFont &); // should be used instead setFont(), so we can set our size correctly
  54
  55   // Compatibility methods with the rest of the classes which still expect this to be a QLineEdit
  56   inline QString text() { return toPlainText(); }
  57   inline int cursorPosition() { return textCursor().position(); }
  58   inline void insert(const QString &newText) { insertPlainText(newText); }
  59   inline void backspace() { keyPressEvent(new QKeyEvent(QEvent::KeyPress, Qt::Key_Backspace, Qt::NoModifier)); }
  60   inline bool hasSelectedText() { return textCursor().hasSelection(); }
  61
  62   inline bool isSingleLine() const { return _singleLine; }
  63   inline bool pasteProtectionEnabled() const { return _pasteProtectionEnabled; }
  64
  65   virtual QSize sizeHint() const;
  66   virtual QSize minimumSizeHint() const;
  67
  68 public slots:
  69   void setMode(Mode mode);
  70   void setMinHeight(int numLines);
  71   void setMaxHeight(int numLines);
  72   void setScrollBarsEnabled(bool enable = true);
  73   void setSpellCheckEnabled(bool enable = true);
  74   void setPasteProtectionEnabled(bool enable = true, QWidget *msgBoxParent = 0);
  75
  76   // Note: Enabling wrap will make isSingleLine() not work correctly, so only use this if minHeight() > 1!
  77   void setWordWrapEnabled(bool enable = true);
  78
  79 signals:
  80   void textEntered(const QString &text);
  81   void noTextEntered();
  82
  83 protected:
  84   virtual void keyPressEvent(QKeyEvent * event);
  85   virtual void resizeEvent(QResizeEvent *event);
  86
  87 private slots:
  88   void on_returnPressed();
  89   void on_returnPressed(const QString &text);
  90   void on_textChanged();
  91   void on_documentHeightChanged(qreal height);
  92
  93   bool addToHistory(const QString &text, bool temporary = false);
  94   void historyMoveForward();
  95   void historyMoveBack();
  96
  97 private:
  98   QStringList history;
  99   QHash<int, QString> tempHistory;
 100   qint32 idx;
 101   Mode _mode;
 102   bool _singleLine;
 103   int _minHeight;
 104   int _maxHeight;
 105   bool _scrollBarsEnabled;
 106   bool _pasteProtectionEnabled;
 107
 108   QSize _sizeHint;
 109   qreal _lastDocumentHeight;
 110
 111   void reset();
 112   void showHistoryEntry();
 113   void updateScrollBars();
 114   void updateSizeHint();
 115 };
 116
 117 #endif