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   setWordWrapEnabled(false);
  59   reset();
  60
  61   connect(this, SIGNAL(textChanged()), this, SLOT(on_textChanged()));
  62 }
  63
  64 MultiLineEdit::~MultiLineEdit() {
  65 }
  66
  67 void MultiLineEdit::setCustomFont(const QFont &font) {
  68   setFont(font);
  69   updateSizeHint();
  70 }
  71
  72 void MultiLineEdit::setMode(Mode mode) {
  73   if(mode == _mode)
  74     return;
  75
  76   _mode = mode;
  77 }
  78
  79 void MultiLineEdit::setMinHeight(int lines) {
  80   if(lines == _minHeight)
  81     return;
  82
  83   _minHeight = lines;
  84   updateSizeHint();
  85 }
  86
  87 void MultiLineEdit::setMaxHeight(int lines) {
  88   if(lines == _maxHeight)
  89     return;
  90
  91   _maxHeight = lines;
  92   updateSizeHint();
  93 }
  94
  95 void MultiLineEdit::setScrollBarsEnabled(bool enable) {
  96   if(_scrollBarsEnabled == enable)
  97     return;
  98
  99   _scrollBarsEnabled = enable;
 100   updateScrollBars();
 101 }
 102
 103 void MultiLineEdit::updateScrollBars() {
 104   QFontMetrics fm(font());
 105   int _maxPixelHeight = fm.lineSpacing() * _maxHeight;
 106   if(_scrollBarsEnabled && document()->size().height() > _maxPixelHeight)
 107     setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
 108   else
 109     setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 110
 111   if(!_scrollBarsEnabled || isSingleLine())
 112     setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 113   else
 114     setHorizontalScrollBarPolicy(Qt::ScrollBarAsNeeded);
 115 }
 116
 117 void MultiLineEdit::resizeEvent(QResizeEvent *event) {
 118   QTextEdit::resizeEvent(event);
 119   updateSizeHint();
 120   updateScrollBars();
 121 }
 122
 123 void MultiLineEdit::updateSizeHint() {
 124   QFontMetrics fm(font());
 125   int minPixelHeight = fm.lineSpacing() * _minHeight;
 126   int maxPixelHeight = fm.lineSpacing() * _maxHeight;
 127   int scrollBarHeight = horizontalScrollBar()->isVisible() ? horizontalScrollBar()->height() : 0;
 128
 129   // use the style to determine a decent size
 130   int h = qMin(qMax((int)document()->size().height() + scrollBarHeight, minPixelHeight), maxPixelHeight) + 2 * frameWidth();
 131   QStyleOptionFrameV2 opt;
 132   opt.initFrom(this);
 133   opt.rect = QRect(0, 0, 100, h);
 134   opt.lineWidth = lineWidth();
 135   opt.midLineWidth = midLineWidth();
 136   opt.state |= QStyle::State_Sunken;
 137   QSize s = style()->sizeFromContents(QStyle::CT_LineEdit, &opt, QSize(100, h).expandedTo(QApplication::globalStrut()), this);
 138   if(s != _sizeHint) {
 139     _sizeHint = s;
 140     updateGeometry();
 141   }
 142 }
 143
 144 QSize MultiLineEdit::sizeHint() const {
 145   if(!_sizeHint.isValid()) {
 146     MultiLineEdit *that = const_cast<MultiLineEdit *>(this);
 147     that->updateSizeHint();
 148   }
 149   return _sizeHint;
 150 }
 151
 152 QSize MultiLineEdit::minimumSizeHint() const {
 153   return sizeHint();
 154 }
 155
 156 void MultiLineEdit::setSpellCheckEnabled(bool enable) {
 157 #ifdef HAVE_KDE
 158   setCheckSpellingEnabled(enable);
 159 #else
 160   Q_UNUSED(enable)
 161 #endif
 162 }
 163
 164 void MultiLineEdit::setWordWrapEnabled(bool enable) {
 165   setLineWrapMode(enable? WidgetWidth : NoWrap);
 166   updateSizeHint();
 167 }
 168
 169 void MultiLineEdit::setPasteProtectionEnabled(bool enable, QWidget *) {
 170   _pasteProtectionEnabled = enable;
 171 }
 172
 173 void MultiLineEdit::historyMoveBack() {
 174   addToHistory(text(), true);
 175
 176   if(idx > 0) {
 177     idx--;
 178     showHistoryEntry();
 179   }
 180 }
 181
 182 void MultiLineEdit::historyMoveForward() {
 183   addToHistory(text(), true);
 184
 185   if(idx < history.count()) {
 186     idx++;
 187     if(idx < history.count() || tempHistory.contains(idx)) // tempHistory might have an entry for idx == history.count() + 1
 188       showHistoryEntry();
 189     else
 190       reset();              // equals clear() in this case
 191   } else {
 192     addToHistory(text());
 193     reset();
 194   }
 195 }
 196
 197 bool MultiLineEdit::addToHistory(const QString &text, bool temporary) {
 198   if(text.isEmpty())
 199     return false;
 200
 201   Q_ASSERT(0 <= idx && idx <= history.count());
 202
 203   if(temporary) {
 204     // if an entry of the history is changed, we remember it and show it again at this
 205     // position until a line was actually sent
 206     // sent lines get appended to the history
 207     if(history.isEmpty() || text != history[idx - (int)(idx == history.count())]) {
 208       tempHistory[idx] = text;
 209       return true;
 210     }
 211   } else {
 212     if(history.isEmpty() || text != history.last()) {
 213       history << text;
 214       tempHistory.clear();
 215       return true;
 216     }
 217   }
 218   return false;
 219 }
 220
 221 void MultiLineEdit::keyPressEvent(QKeyEvent *event) {
 222   // Workaround the fact that Qt < 4.5 doesn't know InsertLineSeparator yet
 223 #if QT_VERSION >= 0x040500
 224   if(event == QKeySequence::InsertLineSeparator) {
 225 #else
 226
 227 # ifdef Q_WS_MAC
 228   if((event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter) && event->modifiers() & Qt::META) {
 229 # else
 230   if((event->key() == Qt::Key_Return || event->key() == Qt::Key_Enter) && event->modifiers() & Qt::SHIFT) {
 231 # endif
 232 #endif
 233
 234     if(_mode == SingleLine)
 235       return;
 236 #ifdef HAVE_KDE
 237     KTextEdit::keyPressEvent(event);
 238 #else
 239     QTextEdit::keyPressEvent(event);
 240 #endif
 241     return;
 242   }
 243
 244   switch(event->key()) {
 245   case Qt::Key_Up:
 246     if(event->modifiers() & Qt::ShiftModifier)
 247       break;
 248     {
 249       event->accept();
 250       if(!(event->modifiers() & Qt::ControlModifier)) {
 251         int pos = textCursor().position();
 252         moveCursor(QTextCursor::Up);
 253         if(pos == textCursor().position()) // already on top line -> history
 254           historyMoveBack();
 255       } else
 256         historyMoveBack();
 257       return;
 258     }
 259
 260   case Qt::Key_Down:
 261     if(event->modifiers() & Qt::ShiftModifier)
 262       break;
 263     {
 264       event->accept();
 265       if(!(event->modifiers() & Qt::ControlModifier)) {
 266         int pos = textCursor().position();
 267         moveCursor(QTextCursor::Down);
 268         if(pos == textCursor().position()) // already on bottom line -> history
 269           historyMoveForward();
 270       } else
 271         historyMoveForward();
 272       return;
 273     }
 274
 275   case Qt::Key_Return:
 276   case Qt::Key_Enter:
 277   case Qt::Key_Select:
 278     event->accept();
 279     on_returnPressed();
 280     return;
 281
 282   // We don't want to have the tab key react even if no completer is installed
 283   case Qt::Key_Tab:
 284     event->accept();
 285     return;
 286
 287   default:
 288     ;
 289   }
 290
 291
 292 #ifdef HAVE_KDE
 293   KTextEdit::keyPressEvent(event);
 294 #else
 295   QTextEdit::keyPressEvent(event);
 296 #endif
 297 }
 298
 299 void MultiLineEdit::on_returnPressed() {
 300   on_returnPressed(text());
 301 }
 302
 303 void MultiLineEdit::on_returnPressed(const QString & text) {
 304   if(!text.isEmpty()) {
 305     foreach(const QString &line, text.split('\n', QString::SkipEmptyParts)) {
 306       if(line.isEmpty())
 307         continue;
 308       addToHistory(line);
 309       emit textEntered(line);
 310     }
 311     reset();
 312     tempHistory.clear();
 313   }
 314 }
 315
 316 void MultiLineEdit::on_textChanged() {
 317   QString newText = text();
 318   newText.replace("\r\n", "\n");
 319   newText.replace('\r', '\n');
 320   if(_mode == SingleLine) {
 321     if(!pasteProtectionEnabled())
 322       newText.replace('\n', ' ');
 323     else if(newText.contains('\n')) {
 324       QStringList lines = newText.split('\n', QString::SkipEmptyParts);
 325       clear();
 326
 327       if(lines.count() >= 4) {
 328         QString msg = tr("Do you really want to paste %n lines?", "", lines.count());
 329         msg += "<p>";
 330         for(int i = 0; i < 4; i++) {
 331           msg += Qt::escape(lines[i].left(40));
 332           if(lines[i].count() > 40)
 333             msg += "...";
 334           msg += "<br />";
 335         }
 336         msg += "...</p>";
 337         QMessageBox question(QMessageBox::NoIcon, tr("Paste Protection"), msg, QMessageBox::Yes|QMessageBox::No);
 338         question.setDefaultButton(QMessageBox::No);
 339 #ifdef Q_WS_MAC
 340         question.setWindowFlags(question.windowFlags() | Qt::Sheet);
 341 #endif
 342         if(question.exec() != QMessageBox::Yes)
 343           return;
 344       }
 345
 346       foreach(QString line, lines) {
 347         clear();
 348         insert(line);
 349         on_returnPressed();
 350       }
 351     }
 352   }
 353
 354   _singleLine = (newText.indexOf('\n') < 0);
 355
 356   if(document()->size().height() != _lastDocumentHeight) {
 357     _lastDocumentHeight = document()->size().height();
 358     on_documentHeightChanged(_lastDocumentHeight);
 359   }
 360   updateSizeHint();
 361 }
 362
 363 void MultiLineEdit::on_documentHeightChanged(qreal) {
 364   updateScrollBars();
 365 }
 366
 367 void MultiLineEdit::reset() {
 368   // every time the MultiLineEdit is cleared we also reset history index
 369   idx = history.count();
 370   clear();
 371   QTextBlockFormat format = textCursor().blockFormat();
 372   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 373   textCursor().setBlockFormat(format);
 374   updateScrollBars();
 375 }
 376
 377 void MultiLineEdit::showHistoryEntry() {
 378   // if the user changed the history, display the changed line
 379   setPlainText(tempHistory.contains(idx) ? tempHistory[idx] : history[idx]);
 380   QTextCursor cursor = textCursor();
 381   QTextBlockFormat format = cursor.blockFormat();
 382   format.setLeftMargin(leftMargin); // we want a little space between the frame and the contents
 383   cursor.setBlockFormat(format);
 384   cursor.movePosition(QTextCursor::End);
 385   setTextCursor(cursor);
 386   updateScrollBars();
 387 }