1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtGui module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef QTEXTDOCUMENT_H
43 #define QTEXTDOCUMENT_H
45 #include <QtCore/qobject.h>
46 #include <QtCore/qsize.h>
47 #include <QtCore/qrect.h>
48 #include <QtCore/qvariant.h>
49 #include <QtGui/qfont.h>
56 class QTextFormatCollection;
57 class QTextListFormat;
60 class QPagedPaintDevice;
61 class QAbstractTextDocumentLayout;
74 template<typename T> class QVector;
78 enum HitTestAccuracy { ExactHit, FuzzyHit };
83 WhiteSpaceModeUndefined = -1
86 Q_GUI_EXPORT bool mightBeRichText(const QString&);
87 Q_GUI_EXPORT QString convertFromPlainText(const QString &plain, WhiteSpaceMode mode = WhiteSpacePre);
89 #ifndef QT_NO_TEXTCODEC
90 Q_GUI_EXPORT QTextCodec *codecForHtml(const QByteArray &ba);
94 class Q_GUI_EXPORT QAbstractUndoItem
97 virtual ~QAbstractUndoItem() = 0;
98 virtual void undo() = 0;
99 virtual void redo() = 0;
102 inline QAbstractUndoItem::~QAbstractUndoItem()
106 class QTextDocumentPrivate;
108 class Q_GUI_EXPORT QTextDocument : public QObject
112 Q_PROPERTY(bool undoRedoEnabled READ isUndoRedoEnabled WRITE setUndoRedoEnabled)
113 Q_PROPERTY(bool modified READ isModified WRITE setModified DESIGNABLE false)
114 Q_PROPERTY(QSizeF pageSize READ pageSize WRITE setPageSize)
115 Q_PROPERTY(QFont defaultFont READ defaultFont WRITE setDefaultFont)
116 Q_PROPERTY(bool useDesignMetrics READ useDesignMetrics WRITE setUseDesignMetrics)
117 Q_PROPERTY(QSizeF size READ size)
118 Q_PROPERTY(qreal textWidth READ textWidth WRITE setTextWidth)
119 Q_PROPERTY(int blockCount READ blockCount)
120 Q_PROPERTY(qreal indentWidth READ indentWidth WRITE setIndentWidth)
121 #ifndef QT_NO_CSSPARSER
122 Q_PROPERTY(QString defaultStyleSheet READ defaultStyleSheet WRITE setDefaultStyleSheet)
124 Q_PROPERTY(int maximumBlockCount READ maximumBlockCount WRITE setMaximumBlockCount)
125 Q_PROPERTY(qreal documentMargin READ documentMargin WRITE setDocumentMargin)
126 QDOC_PROPERTY(QTextOption defaultTextOption READ defaultTextOption WRITE setDefaultTextOption)
129 explicit QTextDocument(QObject *parent = 0);
130 explicit QTextDocument(const QString &text, QObject *parent = 0);
133 QTextDocument *clone(QObject *parent = 0) const;
135 bool isEmpty() const;
136 virtual void clear();
138 void setUndoRedoEnabled(bool enable);
139 bool isUndoRedoEnabled() const;
141 bool isUndoAvailable() const;
142 bool isRedoAvailable() const;
144 int availableUndoSteps() const;
145 int availableRedoSteps() const;
147 int revision() const;
149 void setDocumentLayout(QAbstractTextDocumentLayout *layout);
150 QAbstractTextDocumentLayout *documentLayout() const;
152 enum MetaInformation {
156 void setMetaInformation(MetaInformation info, const QString &);
157 QString metaInformation(MetaInformation info) const;
159 #ifndef QT_NO_TEXTHTMLPARSER
160 QString toHtml(const QByteArray &encoding = QByteArray()) const;
161 void setHtml(const QString &html);
164 QString toPlainText() const;
165 void setPlainText(const QString &text);
167 QChar characterAt(int pos) const;
171 FindBackward = 0x00001,
172 FindCaseSensitively = 0x00002,
173 FindWholeWords = 0x00004
175 Q_DECLARE_FLAGS(FindFlags, FindFlag)
177 QTextCursor find(const QString &subString, int from = 0, FindFlags options = 0) const;
178 QTextCursor find(const QString &subString, const QTextCursor &from, FindFlags options = 0) const;
180 QTextCursor find(const QRegExp &expr, int from = 0, FindFlags options = 0) const;
181 QTextCursor find(const QRegExp &expr, const QTextCursor &from, FindFlags options = 0) const;
183 QTextFrame *frameAt(int pos) const;
184 QTextFrame *rootFrame() const;
186 QTextObject *object(int objectIndex) const;
187 QTextObject *objectForFormat(const QTextFormat &) const;
189 QTextBlock findBlock(int pos) const;
190 QTextBlock findBlockByNumber(int blockNumber) const;
191 QTextBlock findBlockByLineNumber(int blockNumber) const;
192 QTextBlock begin() const;
193 QTextBlock end() const;
195 QTextBlock firstBlock() const;
196 QTextBlock lastBlock() const;
198 void setPageSize(const QSizeF &size);
199 QSizeF pageSize() const;
201 void setDefaultFont(const QFont &font);
202 QFont defaultFont() const;
204 int pageCount() const;
206 bool isModified() const;
208 void print(QPagedPaintDevice *printer) const;
213 StyleSheetResource = 3,
218 QVariant resource(int type, const QUrl &name) const;
219 void addResource(int type, const QUrl &name, const QVariant &resource);
221 QVector<QTextFormat> allFormats() const;
223 void markContentsDirty(int from, int length);
225 void setUseDesignMetrics(bool b);
226 bool useDesignMetrics() const;
228 void drawContents(QPainter *painter, const QRectF &rect = QRectF());
230 void setTextWidth(qreal width);
231 qreal textWidth() const;
233 qreal idealWidth() const;
235 qreal indentWidth() const;
236 void setIndentWidth(qreal width);
238 qreal documentMargin() const;
239 void setDocumentMargin(qreal margin);
244 int blockCount() const;
245 int lineCount() const;
246 int characterCount() const;
248 #ifndef QT_NO_CSSPARSER
249 void setDefaultStyleSheet(const QString &sheet);
250 QString defaultStyleSheet() const;
253 void undo(QTextCursor *cursor);
254 void redo(QTextCursor *cursor);
259 UndoAndRedoStacks = UndoStack | RedoStack
261 void clearUndoRedoStacks(Stacks historyToClear = UndoAndRedoStacks);
263 int maximumBlockCount() const;
264 void setMaximumBlockCount(int maximum);
266 QTextOption defaultTextOption() const;
267 void setDefaultTextOption(const QTextOption &option);
269 Qt::CursorMoveStyle defaultCursorMoveStyle() const;
270 void setDefaultCursorMoveStyle(Qt::CursorMoveStyle style);
273 void contentsChange(int from, int charsRemoves, int charsAdded);
274 void contentsChanged();
275 void undoAvailable(bool);
276 void redoAvailable(bool);
277 void undoCommandAdded();
278 void modificationChanged(bool m);
279 void cursorPositionChanged(const QTextCursor &cursor);
280 void blockCountChanged(int newBlockCount);
282 void documentLayoutChanged();
287 void appendUndoItem(QAbstractUndoItem *);
288 void setModified(bool m = true);
291 virtual QTextObject *createObject(const QTextFormat &f);
292 Q_INVOKABLE virtual QVariant loadResource(int type, const QUrl &name);
294 QTextDocument(QTextDocumentPrivate &dd, QObject *parent);
296 QTextDocumentPrivate *docHandle() const;
298 Q_DISABLE_COPY(QTextDocument)
299 Q_DECLARE_PRIVATE(QTextDocument)
300 friend class QTextObjectPrivate;
303 Q_DECLARE_OPERATORS_FOR_FLAGS(QTextDocument::FindFlags)
309 #endif // QTEXTDOCUMENT_H