src/plugins/qmldesigner/designercore/include/textmodifier.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  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 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef TEXTMODIFIER_H
  35 #define TEXTMODIFIER_H
  36
  37 #include "corelib_global.h"
  38
  39 #include <qmljs/qmljsdocument.h>
  40
  41 #include <QtCore/QByteArray>
  42 #include <QtCore/QObject>
  43 #include <QtGui/QTextCursor>
  44 #include <QtGui/QTextDocument>
  45
  46 namespace QmlDesigner {
  47
  48 class CORESHARED_EXPORT TextModifier: public QObject
  49 {
  50     Q_OBJECT
  51
  52 private:
  53     TextModifier(const TextModifier &);
  54     TextModifier &operator=(const TextModifier &);
  55
  56 public:
  57     struct MoveInfo {
  58         int objectStart;
  59         int objectEnd;
  60         int leadingCharsToRemove;
  61         int trailingCharsToRemove;
  62
  63         int destination;
  64         QString prefixToInsert;
  65         QString suffixToInsert;
  66
  67         MoveInfo(): objectStart(-1), objectEnd(-1), leadingCharsToRemove(0), trailingCharsToRemove(0), destination(-1) {}
  68     };
  69
  70 public:
  71     TextModifier() {}
  72     virtual ~TextModifier() = 0;
  73
  74     virtual void replace(int offset, int length, const QString& replacement) = 0;
  75     virtual void move(const MoveInfo &moveInfo) = 0;
  76     virtual void indent(int offset, int length) = 0;
  77
  78     virtual int indentDepth() const = 0;
  79
  80     virtual void startGroup() = 0;
  81     virtual void flushGroup() = 0;
  82     virtual void commitGroup() = 0;
  83
  84     virtual QTextDocument *textDocument() const = 0;
  85     virtual QString text() const = 0;
  86     virtual QTextCursor textCursor() const = 0;
  87
  88     virtual void deactivateChangeSignals() = 0;
  89     virtual void reactivateChangeSignals() = 0;
  90
  91     virtual QmlJS::Snapshot getSnapshot() const = 0;
  92     virtual QStringList importPaths() const = 0;
  93
  94     virtual bool renameId(const QString &oldId, const QString &newId) = 0;
  95
  96 signals:
  97     void textChanged();
  98
  99     void replaced(int offset, int oldLength, int newLength);
 100     void moved(const TextModifier::MoveInfo &moveInfo);
 101 };
 102
 103 }
 104
 105 #endif // TEXTMODIFIER_H