src/gui/widgets/qlinecontrol_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtGui module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QLINECONTROL_P_H
  43 #define QLINECONTROL_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include "QtCore/qglobal.h"
  57
  58 #ifndef QT_NO_LINEEDIT
  59 #include "private/qwidget_p.h"
  60 #include "QtGui/qlineedit.h"
  61 #include "QtGui/qtextlayout.h"
  62 #include "QtGui/qstyleoption.h"
  63 #include "QtCore/qpointer.h"
  64 #include "QtGui/qclipboard.h"
  65 #include "QtCore/qpoint.h"
  66 #include "QtGui/qcompleter.h"
  67 #include "QtGui/qaccessible.h"
  68 #include "QtCore/qthread.h"
  69
  70 #include "qplatformdefs.h"
  71
  72 QT_BEGIN_HEADER
  73
  74 QT_BEGIN_NAMESPACE
  75
  76 QT_MODULE(Gui)
  77
  78 class Q_GUI_EXPORT QLineControl : public QObject
  79 {
  80     Q_OBJECT
  81
  82 public:
  83     QLineControl(const QString &txt = QString())
  84         : m_cursor(0), m_preeditCursor(0), m_cursorWidth(0), m_layoutDirection(Qt::LayoutDirectionAuto),
  85         m_hideCursor(false), m_separator(0), m_readOnly(0),
  86         m_dragEnabled(0), m_echoMode(0), m_textDirty(0), m_selDirty(0),
  87         m_validInput(1), m_blinkStatus(0), m_blinkPeriod(0), m_blinkTimer(0), m_deleteAllTimer(0),
  88         m_ascent(0), m_maxLength(32767), m_lastCursorPos(-1),
  89         m_tripleClickTimer(0), m_maskData(0), m_modifiedState(0), m_undoState(0),
  90         m_selstart(0), m_selend(0), m_passwordEchoEditing(false)
  91 #ifdef QT_GUI_PASSWORD_ECHO_DELAY
  92         , m_passwordEchoTimer(0)
  93 #endif
  94 #if defined(Q_WS_MAC)
  95         , m_threadChecks(false)
  96         , m_textLayoutThread(0)
  97  #endif
  98     {
  99         init(txt);
 100     }
 101
 102     ~QLineControl()
 103     {
 104         delete [] m_maskData;
 105     }
 106
 107     int nextMaskBlank(int pos)
 108     {
 109         int c = findInMask(pos, true, false);
 110         m_separator |= (c != pos);
 111         return (c != -1 ?  c : m_maxLength);
 112     }
 113
 114     int prevMaskBlank(int pos)
 115     {
 116         int c = findInMask(pos, false, false);
 117         m_separator |= (c != pos);
 118         return (c != -1 ? c : 0);
 119     }
 120
 121     bool isUndoAvailable() const { return !m_readOnly && m_undoState; }
 122     bool isRedoAvailable() const { return !m_readOnly && m_undoState < (int)m_history.size(); }
 123     void clearUndo() { m_history.clear(); m_modifiedState = m_undoState = 0; }
 124
 125     bool isModified() const { return m_modifiedState != m_undoState; }
 126     void setModified(bool modified) { m_modifiedState = modified ? -1 : m_undoState; }
 127
 128     bool allSelected() const { return !m_text.isEmpty() && m_selstart == 0 && m_selend == (int)m_text.length(); }
 129     bool hasSelectedText() const { return !m_text.isEmpty() && m_selend > m_selstart; }
 130
 131     int width() const { return qRound(m_textLayout.lineAt(0).width()) + 1; }
 132     int height() const { return qRound(m_textLayout.lineAt(0).height()) + 1; }
 133     int ascent() const { return m_ascent; }
 134     qreal naturalTextWidth() const { return m_textLayout.lineAt(0).naturalTextWidth(); }
 135
 136     void setSelection(int start, int length);
 137
 138     inline QString selectedText() const { return hasSelectedText() ? m_text.mid(m_selstart, m_selend - m_selstart) : QString(); }
 139     QString textBeforeSelection() const { return hasSelectedText() ? m_text.left(m_selstart) : QString(); }
 140     QString textAfterSelection() const { return hasSelectedText() ? m_text.mid(m_selend) : QString(); }
 141
 142     int selectionStart() const { return hasSelectedText() ? m_selstart : -1; }
 143     int selectionEnd() const { return hasSelectedText() ? m_selend : -1; }
 144     bool inSelection(int x) const
 145     {
 146         if (m_selstart >= m_selend)
 147             return false;
 148         int pos = xToPos(x, QTextLine::CursorOnCharacter);
 149         return pos >= m_selstart && pos < m_selend;
 150     }
 151
 152     void removeSelection()
 153     {
 154         int priorState = m_undoState;
 155         removeSelectedText();
 156         finishChange(priorState);
 157     }
 158
 159     int start() const { return 0; }
 160     int end() const { return m_text.length(); }
 161
 162 #ifndef QT_NO_CLIPBOARD
 163     void copy(QClipboard::Mode mode = QClipboard::Clipboard) const;
 164     void paste(QClipboard::Mode mode = QClipboard::Clipboard);
 165 #endif
 166
 167     int cursor() const{ return m_cursor; }
 168     int preeditCursor() const { return m_preeditCursor; }
 169
 170     int cursorWidth() const { return m_cursorWidth; }
 171     void setCursorWidth(int value) { m_cursorWidth = value; }
 172
 173     Qt::CursorMoveStyle cursorMoveStyle() const { return m_textLayout.cursorMoveStyle(); }
 174     void setCursorMoveStyle(Qt::CursorMoveStyle style) { m_textLayout.setCursorMoveStyle(style); }
 175
 176     void moveCursor(int pos, bool mark = false);
 177     void cursorForward(bool mark, int steps)
 178     {
 179         int c = m_cursor;
 180         if (steps > 0) {
 181             while (steps--)
 182                 c = cursorMoveStyle() == Qt::VisualMoveStyle ? m_textLayout.rightCursorPosition(c)
 183                                                              : m_textLayout.nextCursorPosition(c);
 184         } else if (steps < 0) {
 185             while (steps++)
 186                 c = cursorMoveStyle() == Qt::VisualMoveStyle ? m_textLayout.leftCursorPosition(c)
 187                                                              : m_textLayout.previousCursorPosition(c);
 188         }
 189         moveCursor(c, mark);
 190     }
 191
 192     void cursorWordForward(bool mark) { moveCursor(m_textLayout.nextCursorPosition(m_cursor, QTextLayout::SkipWords), mark); }
 193     void cursorWordBackward(bool mark) { moveCursor(m_textLayout.previousCursorPosition(m_cursor, QTextLayout::SkipWords), mark); }
 194
 195     void home(bool mark) { moveCursor(0, mark); }
 196     void end(bool mark) { moveCursor(text().length(), mark); }
 197
 198     int xToPos(int x, QTextLine::CursorPosition = QTextLine::CursorBetweenCharacters) const;
 199     QRect cursorRect() const;
 200
 201     qreal cursorToX(int cursor) const { return m_textLayout.lineAt(0).cursorToX(cursor); }
 202     qreal cursorToX() const
 203     {
 204         int cursor = m_cursor;
 205         if (m_preeditCursor != -1)
 206             cursor += m_preeditCursor;
 207         return cursorToX(cursor);
 208     }
 209
 210     bool isReadOnly() const { return m_readOnly; }
 211     void setReadOnly(bool enable) { m_readOnly = enable; }
 212
 213     QString text() const
 214     {
 215         QString res = m_maskData ? stripString(m_text) : m_text;
 216         return (res.isNull() ? QString::fromLatin1("") : res);
 217     }
 218     void setText(const QString &txt) { internalSetText(txt, -1, false); }
 219     QString displayText() const { return m_textLayout.text(); }
 220
 221     void backspace();
 222     void del();
 223     void deselect() { internalDeselect(); finishChange(); }
 224     void selectAll() { m_selstart = m_selend = m_cursor = 0; moveCursor(m_text.length(), true); }
 225
 226     void insert(const QString &);
 227     void clear();
 228     void undo() { internalUndo(); finishChange(-1, true); }
 229     void redo() { internalRedo(); finishChange(); }
 230     void selectWordAtPos(int);
 231
 232     uint echoMode() const { return m_echoMode; }
 233     void setEchoMode(uint mode)
 234     {
 235         cancelPasswordEchoTimer();
 236         m_echoMode = mode;
 237         m_passwordEchoEditing = false;
 238         updateDisplayText();
 239     }
 240
 241     int maxLength() const { return m_maxLength; }
 242     void setMaxLength(int maxLength)
 243     {
 244         if (m_maskData)
 245             return;
 246         m_maxLength = maxLength;
 247         setText(m_text);
 248     }
 249
 250 #ifndef QT_NO_VALIDATOR
 251     const QValidator *validator() const { return m_validator; }
 252     void setValidator(const QValidator *v) { m_validator = const_cast<QValidator*>(v); }
 253 #endif
 254
 255 #ifndef QT_NO_COMPLETER
 256     QCompleter *completer() const { return m_completer; }
 257     /* Note that you must set the widget for the completer separately */
 258     void setCompleter(const QCompleter *c) { m_completer = const_cast<QCompleter*>(c); }
 259     void complete(int key);
 260 #endif
 261
 262     int cursorPosition() const { return m_cursor; }
 263     void setCursorPosition(int pos) { if (pos <= m_text.length()) moveCursor(qMax(0, pos)); }
 264
 265     bool hasAcceptableInput() const { return hasAcceptableInput(m_text); }
 266     bool fixup();
 267
 268     QString inputMask() const { return m_maskData ? m_inputMask + QLatin1Char(';') + m_blank : QString(); }
 269     void setInputMask(const QString &mask)
 270     {
 271         parseInputMask(mask);
 272         if (m_maskData)
 273             moveCursor(nextMaskBlank(0));
 274     }
 275
 276     // input methods
 277 #ifndef QT_NO_IM
 278     bool composeMode() const { return !m_textLayout.preeditAreaText().isEmpty(); }
 279     void setPreeditArea(int cursor, const QString &text) { m_textLayout.setPreeditArea(cursor, text); }
 280 #endif
 281
 282     QString preeditAreaText() const { return m_textLayout.preeditAreaText(); }
 283
 284     void updatePasswordEchoEditing(bool editing);
 285     bool passwordEchoEditing() const {
 286 #ifdef QT_GUI_PASSWORD_ECHO_DELAY
 287         if (m_passwordEchoTimer != 0)
 288             return true;
 289 #endif
 290         return m_passwordEchoEditing ;
 291     }
 292
 293     QChar passwordCharacter() const { return m_passwordCharacter; }
 294     void setPasswordCharacter(const QChar &character) { m_passwordCharacter = character; updateDisplayText(); }
 295
 296     Qt::LayoutDirection layoutDirection() const {
 297         if (m_layoutDirection == Qt::LayoutDirectionAuto) {
 298             if (m_text.isEmpty())
 299                 return QApplication::keyboardInputDirection();
 300             return m_text.isRightToLeft() ? Qt::RightToLeft : Qt::LeftToRight;
 301         }
 302         return m_layoutDirection;
 303     }
 304     void setLayoutDirection(Qt::LayoutDirection direction)
 305     {
 306         if (direction != m_layoutDirection) {
 307             m_layoutDirection = direction;
 308             updateDisplayText();
 309         }
 310     }
 311
 312     void setFont(const QFont &font) { m_textLayout.setFont(font); updateDisplayText(); }
 313
 314     void processInputMethodEvent(QInputMethodEvent *event);
 315     void processMouseEvent(QMouseEvent* ev);
 316     void processKeyEvent(QKeyEvent* ev);
 317
 318     int cursorBlinkPeriod() const { return m_blinkPeriod; }
 319     void setCursorBlinkPeriod(int msec);
 320     void resetCursorBlinkTimer();
 321
 322     bool cursorBlinkStatus() const { return m_blinkStatus; }
 323
 324     QString cancelText() const { return m_cancelText; }
 325     void setCancelText(const QString &text) { m_cancelText = text; }
 326
 327     const QPalette &palette() const { return m_palette; }
 328     void setPalette(const QPalette &p) { m_palette = p; }
 329
 330     enum DrawFlags {
 331         DrawText = 0x01,
 332         DrawSelections = 0x02,
 333         DrawCursor = 0x04,
 334         DrawAll = DrawText | DrawSelections | DrawCursor
 335     };
 336     void draw(QPainter *, const QPoint &, const QRect &, int flags = DrawAll);
 337
 338     bool processEvent(QEvent *ev);
 339
 340     QTextLayout *textLayout() const
 341     {
 342 #if defined(Q_WS_MAC)
 343         if (m_threadChecks && QThread::currentThread() != m_textLayoutThread)
 344             redoTextLayout();
 345 #endif
 346         return &m_textLayout;
 347     }
 348
 349 #if defined(Q_WS_MAC)
 350     void setThreadChecks(bool threadChecks)
 351     {
 352         m_threadChecks = threadChecks;
 353     }
 354
 355     bool threadChecks() const
 356     {
 357         return m_threadChecks;
 358     }
 359 #endif
 360
 361 private:
 362     void init(const QString &txt);
 363     void removeSelectedText();
 364     void internalSetText(const QString &txt, int pos = -1, bool edited = true);
 365     void updateDisplayText(bool forceUpdate = false);
 366
 367     void internalInsert(const QString &s);
 368     void internalDelete(bool wasBackspace = false);
 369     void internalRemove(int pos);
 370
 371     inline void internalDeselect()
 372     {
 373         m_selDirty |= (m_selend > m_selstart);
 374         m_selstart = m_selend = 0;
 375     }
 376
 377     void internalUndo(int until = -1);
 378     void internalRedo();
 379
 380     QString m_text;
 381     QPalette m_palette;
 382     int m_cursor;
 383     int m_preeditCursor;
 384     int m_cursorWidth;
 385     Qt::LayoutDirection m_layoutDirection;
 386     uint m_hideCursor : 1; // used to hide the m_cursor inside preedit areas
 387     uint m_separator : 1;
 388     uint m_readOnly : 1;
 389     uint m_dragEnabled : 1;
 390     uint m_echoMode : 2;
 391     uint m_textDirty : 1;
 392     uint m_selDirty : 1;
 393     uint m_validInput : 1;
 394     uint m_blinkStatus : 1;
 395     int m_blinkPeriod; // 0 for non-blinking cursor
 396     int m_blinkTimer;
 397     int m_deleteAllTimer;
 398     int m_ascent;
 399     int m_maxLength;
 400     int m_lastCursorPos;
 401     QList<int> m_transactions;
 402     QPoint m_tripleClick;
 403     int m_tripleClickTimer;
 404     QString m_cancelText;
 405
 406     void emitCursorPositionChanged();
 407
 408     bool finishChange(int validateFromState = -1, bool update = false, bool edited = true);
 409
 410 #ifndef QT_NO_VALIDATOR
 411     QPointer<QValidator> m_validator;
 412 #endif
 413     QPointer<QCompleter> m_completer;
 414 #ifndef QT_NO_COMPLETER
 415     bool advanceToEnabledItem(int dir);
 416 #endif
 417
 418     struct MaskInputData {
 419         enum Casemode { NoCaseMode, Upper, Lower };
 420         QChar maskChar; // either the separator char or the inputmask
 421         bool separator;
 422         Casemode caseMode;
 423     };
 424     QString m_inputMask;
 425     QChar m_blank;
 426     MaskInputData *m_maskData;
 427
 428     // undo/redo handling
 429     enum CommandType { Separator, Insert, Remove, Delete, RemoveSelection, DeleteSelection, SetSelection };
 430     struct Command {
 431         inline Command() {}
 432         inline Command(CommandType t, int p, QChar c, int ss, int se) : type(t),uc(c),pos(p),selStart(ss),selEnd(se) {}
 433         uint type : 4;
 434         QChar uc;
 435         int pos, selStart, selEnd;
 436     };
 437     int m_modifiedState;
 438     int m_undoState;
 439     QVector<Command> m_history;
 440     void addCommand(const Command& cmd);
 441
 442     inline void separate() { m_separator = true; }
 443
 444     // selection
 445     int m_selstart;
 446     int m_selend;
 447
 448     // masking
 449     void parseInputMask(const QString &maskFields);
 450     bool isValidInput(QChar key, QChar mask) const;
 451     bool hasAcceptableInput(const QString &text) const;
 452     QString maskString(uint pos, const QString &str, bool clear = false) const;
 453     QString clearString(uint pos, uint len) const;
 454     QString stripString(const QString &str) const;
 455     int findInMask(int pos, bool forward, bool findSeparator, QChar searchChar = QChar()) const;
 456
 457     // complex text layout (must be mutable so it can be reshaped at will)
 458     mutable QTextLayout m_textLayout;
 459
 460     bool m_passwordEchoEditing;
 461     QChar m_passwordCharacter;
 462 #ifdef QT_GUI_PASSWORD_ECHO_DELAY
 463     int m_passwordEchoTimer;
 464 #endif
 465     void cancelPasswordEchoTimer()
 466     {
 467 #ifdef QT_GUI_PASSWORD_ECHO_DELAY
 468         if (m_passwordEchoTimer != 0) {
 469             killTimer(m_passwordEchoTimer);
 470             m_passwordEchoTimer = 0;
 471         }
 472 #endif
 473     }
 474
 475     int redoTextLayout() const;
 476 #if defined(Q_WS_MAC)
 477     bool m_threadChecks;
 478     mutable QThread *m_textLayoutThread;
 479 #endif
 480
 481 Q_SIGNALS:
 482     void cursorPositionChanged(int, int);
 483     void selectionChanged();
 484
 485     void displayTextChanged(const QString &);
 486     void textChanged(const QString &);
 487     void textEdited(const QString &);
 488
 489     void resetInputContext();
 490     void updateMicroFocus();
 491
 492     void accepted();
 493     void editingFinished();
 494     void updateNeeded(const QRect &);
 495
 496 #ifdef QT_KEYPAD_NAVIGATION
 497     void editFocusChange(bool);
 498 #endif
 499 protected:
 500     virtual void timerEvent(QTimerEvent *event);
 501
 502 private Q_SLOTS:
 503     void _q_clipboardChanged();
 504     void _q_deleteSelected();
 505
 506 };
 507
 508 QT_END_NAMESPACE
 509
 510 QT_END_HEADER
 511
 512 #endif // QT_NO_LINEEDIT
 513
 514 #endif // QLINECONTROL_P_H