/**************************************************************************** ** ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** ** This file is part of the QtGui module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** Commercial Usage ** Licensees holding valid Qt Commercial licenses may use this file in ** accordance with the Qt Commercial License Agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and Nokia. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 2.1 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 2.1 requirements ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Nokia gives you certain additional ** rights. These rights are described in the Nokia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 3.0 as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL included in the ** packaging of this file. Please review the following information to ** ensure the GNU General Public License version 3.0 requirements will be ** met: http://www.gnu.org/copyleft/gpl.html. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. ** $QT_END_LICENSE$ ** ****************************************************************************/ #ifndef QTEXTDOCUMENT_H #define QTEXTDOCUMENT_H #include <QtCore/qobject.h> #include <QtCore/qsize.h> #include <QtCore/qrect.h> #include <QtGui/qfont.h> QT_BEGIN_HEADER QT_BEGIN_NAMESPACE QT_MODULE(Gui) class QTextFormatCollection; class QTextListFormat; class QRect; class QPainter; class QPrinter; class QAbstractTextDocumentLayout; class QPoint; class QTextCursor; class QTextObject; class QTextFormat; class QTextFrame; class QTextBlock; class QTextCodec; class QUrl; class QVariant; class QRectF; class QTextOption; template<typename T> class QVector; namespace Qt { enum HitTestAccuracy { ExactHit, FuzzyHit }; enum WhiteSpaceMode { WhiteSpaceNormal, WhiteSpacePre, WhiteSpaceNoWrap, WhiteSpaceModeUndefined = -1 }; Q_GUI_EXPORT bool mightBeRichText(const QString&); Q_GUI_EXPORT QString escape(const QString& plain); Q_GUI_EXPORT QString convertFromPlainText(const QString &plain, WhiteSpaceMode mode = WhiteSpacePre); #ifndef QT_NO_TEXTCODEC Q_GUI_EXPORT QTextCodec *codecForHtml(const QByteArray &ba); #endif } class Q_GUI_EXPORT QAbstractUndoItem { public: virtual ~QAbstractUndoItem() = 0; virtual void undo() = 0; virtual void redo() = 0; }; inline QAbstractUndoItem::~QAbstractUndoItem() { } class QTextDocumentPrivate; class Q_GUI_EXPORT QTextDocument : public QObject { Q_OBJECT Q_PROPERTY(bool undoRedoEnabled READ isUndoRedoEnabled WRITE setUndoRedoEnabled) Q_PROPERTY(bool modified READ isModified WRITE setModified DESIGNABLE false) Q_PROPERTY(QSizeF pageSize READ pageSize WRITE setPageSize) Q_PROPERTY(QFont defaultFont READ defaultFont WRITE setDefaultFont) Q_PROPERTY(bool useDesignMetrics READ useDesignMetrics WRITE setUseDesignMetrics) Q_PROPERTY(QSizeF size READ size) Q_PROPERTY(qreal textWidth READ textWidth WRITE setTextWidth) Q_PROPERTY(int blockCount READ blockCount) Q_PROPERTY(qreal indentWidth READ indentWidth WRITE setIndentWidth) #ifndef QT_NO_CSSPARSER Q_PROPERTY(QString defaultStyleSheet READ defaultStyleSheet WRITE setDefaultStyleSheet) #endif Q_PROPERTY(int maximumBlockCount READ maximumBlockCount WRITE setMaximumBlockCount) Q_PROPERTY(qreal documentMargin READ documentMargin WRITE setDocumentMargin) QDOC_PROPERTY(QTextOption defaultTextOption READ defaultTextOption WRITE setDefaultTextOption) public: explicit QTextDocument(QObject *parent = 0); explicit QTextDocument(const QString &text, QObject *parent = 0); ~QTextDocument(); QTextDocument *clone(QObject *parent = 0) const; bool isEmpty() const; virtual void clear(); void setUndoRedoEnabled(bool enable); bool isUndoRedoEnabled() const; bool isUndoAvailable() const; bool isRedoAvailable() const; int availableUndoSteps() const; int availableRedoSteps() const; int revision() const; void setDocumentLayout(QAbstractTextDocumentLayout *layout); QAbstractTextDocumentLayout *documentLayout() const; enum MetaInformation { DocumentTitle, DocumentUrl }; void setMetaInformation(MetaInformation info, const QString &); QString metaInformation(MetaInformation info) const; #ifndef QT_NO_TEXTHTMLPARSER QString toHtml(const QByteArray &encoding = QByteArray()) const; void setHtml(const QString &html); #endif QString toPlainText() const; void setPlainText(const QString &text); QChar characterAt(int pos) const; enum FindFlag { FindBackward = 0x00001, FindCaseSensitively = 0x00002, FindWholeWords = 0x00004 }; Q_DECLARE_FLAGS(FindFlags, FindFlag) QTextCursor find(const QString &subString, int from = 0, FindFlags options = 0) const; QTextCursor find(const QString &subString, const QTextCursor &from, FindFlags options = 0) const; QTextCursor find(const QRegExp &expr, int from = 0, FindFlags options = 0) const; QTextCursor find(const QRegExp &expr, const QTextCursor &from, FindFlags options = 0) const; QTextFrame *frameAt(int pos) const; QTextFrame *rootFrame() const; QTextObject *object(int objectIndex) const; QTextObject *objectForFormat(const QTextFormat &) const; QTextBlock findBlock(int pos) const; QTextBlock findBlockByNumber(int blockNumber) const; QTextBlock findBlockByLineNumber(int blockNumber) const; QTextBlock begin() const; QTextBlock end() const; QTextBlock firstBlock() const; QTextBlock lastBlock() const; void setPageSize(const QSizeF &size); QSizeF pageSize() const; void setDefaultFont(const QFont &font); QFont defaultFont() const; int pageCount() const; bool isModified() const; #ifndef QT_NO_PRINTER void print(QPrinter *printer) const; #endif enum ResourceType { HtmlResource = 1, ImageResource = 2, StyleSheetResource = 3, UserResource = 100 }; QVariant resource(int type, const QUrl &name) const; void addResource(int type, const QUrl &name, const QVariant &resource); QVector<QTextFormat> allFormats() const; void markContentsDirty(int from, int length); void setUseDesignMetrics(bool b); bool useDesignMetrics() const; void drawContents(QPainter *painter, const QRectF &rect = QRectF()); void setTextWidth(qreal width); qreal textWidth() const; qreal idealWidth() const; qreal indentWidth() const; void setIndentWidth(qreal width); qreal documentMargin() const; void setDocumentMargin(qreal margin); void adjustSize(); QSizeF size() const; int blockCount() const; int lineCount() const; int characterCount() const; #ifndef QT_NO_CSSPARSER void setDefaultStyleSheet(const QString &sheet); QString defaultStyleSheet() const; #endif void undo(QTextCursor *cursor); void redo(QTextCursor *cursor); int maximumBlockCount() const; void setMaximumBlockCount(int maximum); QTextOption defaultTextOption() const; void setDefaultTextOption(const QTextOption &option); Q_SIGNALS: void contentsChange(int from, int charsRemoves, int charsAdded); void contentsChanged(); void undoAvailable(bool); void redoAvailable(bool); void undoCommandAdded(); void modificationChanged(bool m); void cursorPositionChanged(const QTextCursor &cursor); void blockCountChanged(int newBlockCount); void documentLayoutChanged(); public Q_SLOTS: void undo(); void redo(); void appendUndoItem(QAbstractUndoItem *); void setModified(bool m = true); protected: virtual QTextObject *createObject(const QTextFormat &f); virtual QVariant loadResource(int type, const QUrl &name); QTextDocument(QTextDocumentPrivate &dd, QObject *parent); public: QTextDocumentPrivate *docHandle() const; private: Q_DISABLE_COPY(QTextDocument) Q_DECLARE_PRIVATE(QTextDocument) friend class QTextObjectPrivate; }; Q_DECLARE_OPERATORS_FOR_FLAGS(QTextDocument::FindFlags) QT_END_NAMESPACE QT_END_HEADER #endif // QTEXTDOCUMENT_H