src/uisupport/multilineedit.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005/06 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 #include <QApplication>
  22 #include <QMenu>
  23 #include <QMessageBox>
  24 #include <QScrollBar>
  25
  26 #include "bufferview.h"
  27 #include "graphicalui.h"
  28 #include "multilineedit.h"
  29 #include "tabcompleter.h"
  30
  31 const int leftMargin = 3;
  32
  33 MultiLineEdit::MultiLineEdit(QWidget *parent)
  34   :
  35 #ifdef HAVE_KDE
  36     KTextEdit(parent),
  37 #else
  38     QTextEdit(parent),
  39 #endif
  40     idx(0),
  41     _mode(SingleLine),
  42     _singleLine(true),
  43     _minHeight(1),
  44     _maxHeight(5),
  45     _scrollBarsEnabled(true),
  46     _lastDocumentHeight(-1)
  47 {
  48 #if QT_VERSION >= 0x040500
  49   document()->setDocumentMargin(0); // new in Qt 4.5 and we really don't want it here
  50 #endif
  51
  52   setAcceptRichText(false);
  53 #ifdef HAVE_KDE
  54   enableFindReplace(false);
  55 #endif
  56
  57   setMode(SingleLine);
  58   reset();
  59
  60   connect(this, SIGNAL(textChanged()), this, SLOT(on_textChanged()));
  61 }
  62
  63 MultiLineEdit::~MultiLineEdit() {
  64 }
  65
  66 void MultiLineEdit::setCustomFont(const QFont &font) {
  67   setFont(font);
  68   computeSizeHint();
  69 }
  70
  71 void MultiLineEdit::setMode(Mode mode) {
  72   if(mode == _mode)
  73     return;
  74
  75   _mode = mode;
  76 }
  77
  78 void MultiLineEdit::setMinHeight(int lines) {
  79   if(lines == _minHeight)
  80     return;
  81
  82   _minHeight = lines;
  83   computeSizeHint();
  84 }
  85
  86 void MultiLineEdit::setMaxHeight(int lines) {
  87   if(lines == _maxHeight)
  88     return;
  89
  90   _maxHeight = lines;
  91   computeSizeHint();
  92 }
  93
  94 void MultiLineEdit::enableScrollBars(bool enable) {
  95   if(_scrollBarsEnabled == enable)
  96     return;
  97
  98   _scrollBarsEnabled = enable;
  99   updateScrollBars();
 100 }
 101
 102 void MultiLineEdit::updateScrollBars() {
 103   QFontMetrics fm(font());
 104   int _maxPixelHeight = fm.lineSpacing() * _maxHeight;
 105   if(_scrollBarsEnabled && document()->size().height() > _maxPixelHeight)
 106     setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
 107   else
 108     setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 109
 110   if(!_scrollBarsEnabled || isSingleLine())
 111     setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 112   else
 113     setHorizontalScrollBarPolicy(Qt::ScrollBarAsNeeded);
 114 }
 115
 116 void MultiLineEdit::resizeEvent(QResizeEvent *event) {
 117   updateScrollBars();
 118   QTextEdit::resizeEvent(event);
 119 }
 120
 121 void MultiLineEdit::computeSizeHint() {
 122   QFontMetrics fm(font());
 123   int minPixelHeight = fm.lineSpacing() * _minHeight;
 124   int maxPixelHeight = fm.lineSpacing() * _maxHeight;
 125   int scrollBarHeight = horizontalScrollBar()->isVisible() ? horizontalScrollBar()->height() : 0;
 126
 127   // use the style to determine a decent size
 128   int h = qMin(qMax((int)document()->size().height() + scrollBarHeight, minPixelHeight), maxPixelHeight) + 2 * frameWidth();
 129   QStyleOptionFrameV2 opt;
 130   opt.initFrom(this);
 131   opt.rect = QRect(0, 0, 100, h);
 132   opt.lineWidth = lineWidth();
 133   opt.midLineWidth = midLineWidth();
 134   opt.state |= QStyle::State_Sunken;
 135   QSize s = style()->sizeFromContents(QStyle::CT_LineEdit, &opt, QSize(100, h).expandedTo(QApplication::globalStrut()), this);
 136   if(s != _sizeHint) {
 137     _sizeHint = s;
 138     updateGeometry();
 139   }
 140 }
 141
 142 QSize MultiLineEdit::sizeHint() const {
 143   if(!_sizeHint.isValid()) {
 144     MultiLineEdit *that = const_cast<MultiLineEdit *>(this);
 145     that->computeSizeHint();
 146   }
 147   return _sizeHint;
 148 }
 149
 150 QSize MultiLineEdit::minimumSizeHint() const {
 151   return sizeHint();
 152 }
 153
 154 void MultiLineEdit::historyMoveBack() {
 155   addToHistory(text(), true);
 156
 157   if(idx > 0) {
 158     idx--;
 159     showHistoryEntry();
 160   }
 161 }
 162
 163 void MultiLineEdit::historyMoveForward() {
 164   addToHistory(text(), true);
 165
 166   if(idx < history.count()) {
 167     idx++;
 168     if(idx < history.count() || tempHistory.contains(idx)) // tempHistory might have an entry for idx == history.count() + 1
 169       showHistoryEntry();
 170     else
 171       reset();              // equals clear() in this case
 172   }
 173 }
 174
 175 bool MultiLineEdit::addToHistory(const QString &text, bool temporary) {
 176   if(text.isEmpty())
 177     return false;
 178
 179   Q_ASSERT(0 <= idx && idx <= history.count());
 180
 181   if(temporary) {
 182     // if an entry of the history is changed, we remember it and show it again at this
 183     // position until a line was actually sent
 184     // sent lines get appended to the history
 185     if(history.isEmpty() || text != history[idx - (int)(idx == history.count())]) {
 186       tempHistory[idx] = text;
 187       return true;
 188     }
 189   } else {
 190     if(history.isEmpty() || text != history.last()) {
 191       history << text;
 192       tempHistory.clear();
 193       return true;
 194     }
 195   }
 196   return false;
 197 }
 198
 199 void MultiLineEdit::keyPressEvent(QKeyEvent *event) {
 200   // Workaround the fact that Qt < 4.5 doesn't know InsertLineSeparator yet
 201 #if QT_VERSION >= 0x040500
 202   if(event == QKeySequence::InsertLineSeparator) {
 203 #else
 204
 205 # ifdef Q_WS_MAC
 206   if((event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter) && event->modifiers() & Qt::META) {
 207 # else
 208   if((event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter) && event->modifiers() & Qt::SHIFT) {
 209 # endif
 210 #endif
 211
 212     if(_mode == SingleLine)
 213       return;
 214 #ifdef HAVE_KDE
 215     KTextEdit::keyPressEvent(event);
 216 #else
 217     QTextEdit::keyPressEvent(event);
 218 #endif
 219     return;
 220   }
 221
 222   switch(event->key()) {
 223   case Qt::Key_Up:
 224     if(event->modifiers() & Qt::ShiftModifier)
 225       break;
 226     {
 227       event->accept();
 228       if(!(event->modifiers() & Qt::ControlModifier)) {
 229         int pos = textCursor().position();
 230         moveCursor(QTextCursor::Up);
 231         if(pos == textCursor().position()) // already on top line -> history
 232           historyMoveBack();
 233       } else
 234         historyMoveBack();
 235       return;
 236     }
 237
 238   case Qt::Key_Down:
 239     if(event->modifiers() & Qt::ShiftModifier)
 240       break;
 241     {
 242       event->accept();
 243       if(!(event->modifiers() & Qt::ControlModifier)) {
 244         int pos = textCursor().position();
 245         moveCursor(QTextCursor::Down);
 246         if(pos == textCursor().position()) // already on bottom line -> history
 247           historyMoveForward();
 248       } else
 249         historyMoveForward();
 250       return;
 251     }
 252
 253   case Qt::Key_Return:
 254   case Qt::Key_Enter:
 255   case Qt::Key_Select:
 256     event->accept();
 257     on_returnPressed();
 258     return;
 259
 260   // We don't want to have the tab key react even if no completer is installed
 261   case Qt::Key_Tab:
 262     event->accept();
 263     return;
 264
 265   default:
 266     ;
 267   }
 268
 269
 270 #ifdef HAVE_KDE
 271   KTextEdit::keyPressEvent(event);
 272 #else
 273   QTextEdit::keyPressEvent(event);
 274 #endif
 275 }
 276
 277 void MultiLineEdit::on_returnPressed() {
 278   if(!text().isEmpty()) {
 279     foreach(const QString &line, text().split('\n', QString::SkipEmptyParts)) {
 280       if(line.isEmpty())
 281         continue;
 282       addToHistory(line);
 283       emit textEntered(line);
 284     }
 285     reset();
 286     tempHistory.clear();
 287   }
 288 }
 289
 290 void MultiLineEdit::on_textChanged() {
 291   QString newText = text();
 292   newText.replace("\r\n", "\n");
 293   newText.replace('\r', '\n');
 294   if(_mode == SingleLine)
 295     newText.replace('\n', ' ');
 296
 297   _singleLine = (newText.indexOf('\n') < 0);
 298
 299   if(document()->size().height() != _lastDocumentHeight) {
 300     _lastDocumentHeight = document()->size().height();
 301     on_documentHeightChanged(_lastDocumentHeight);
 302   }
 303   computeSizeHint();
 304 }
 305
 306 void MultiLineEdit::on_documentHeightChanged(qreal) {
 307   updateScrollBars();
 308 }
 309
 310 void MultiLineEdit::reset() {
 311   // every time the MultiLineEdit is cleared we also reset history index
 312   idx = history.count();
 313   clear();
 314   QTextBlockFormat format = textCursor().blockFormat();
 315   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 316   textCursor().setBlockFormat(format);
 317   updateScrollBars();
 318 }
 319
 320 void MultiLineEdit::showHistoryEntry() {
 321   // if the user changed the history, display the changed line
 322   setPlainText(tempHistory.contains(idx) ? tempHistory[idx] : history[idx]);
 323   QTextCursor cursor = textCursor();
 324   QTextBlockFormat format = cursor.blockFormat();
 325   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 326   cursor.setBlockFormat(format);
 327   cursor.movePosition(QTextCursor::End);
 328   setTextCursor(cursor);
 329   updateScrollBars();
 330 }