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