qtextdocument.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:8k
源码类别:

系统编程

开发平台:

Unix_Linux

  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
  4. ** Contact: Qt Software Information (qt-info@nokia.com)
  5. **
  6. ** This file is part of the QtGui module of the Qt Toolkit.
  7. **
  8. ** Commercial Usage
  9. ** Licensees holding valid Qt Commercial licenses may use this file in
  10. ** accordance with the Qt Commercial License Agreement provided with the
  11. ** Software or, alternatively, in accordance with the terms contained in
  12. ** a written agreement between you and Nokia.
  13. **
  14. **
  15. ** GNU General Public License Usage
  16. ** Alternatively, this file may be used under the terms of the GNU
  17. ** General Public License versions 2.0 or 3.0 as published by the Free
  18. ** Software Foundation and appearing in the file LICENSE.GPL included in
  19. ** the packaging of this file.  Please review the following information
  20. ** to ensure GNU General Public Licensing requirements will be met:
  21. ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
  22. ** http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
  23. ** exception, Nokia gives you certain additional rights. These rights
  24. ** are described in the Nokia Qt GPL Exception version 1.3, included in
  25. ** the file GPL_EXCEPTION.txt in this package.
  26. **
  27. ** Qt for Windows(R) Licensees
  28. ** As a special exception, Nokia, as the sole copyright holder for Qt
  29. ** Designer, grants users of the Qt/Eclipse Integration plug-in the
  30. ** right for the Qt/Eclipse Integration to link to functionality
  31. ** provided by Qt Designer and its related libraries.
  32. **
  33. ** If you are unsure which license is appropriate for your use, please
  34. ** contact the sales department at qt-sales@nokia.com.
  35. **
  36. ****************************************************************************/
  37. #ifndef QTEXTDOCUMENT_H
  38. #define QTEXTDOCUMENT_H
  39. #include <QtCore/qobject.h>
  40. #include <QtCore/qsize.h>
  41. #include <QtCore/qrect.h>
  42. #include <QtGui/qfont.h>
  43. QT_BEGIN_HEADER
  44. QT_BEGIN_NAMESPACE
  45. QT_MODULE(Gui)
  46. class QTextFormatCollection;
  47. class QTextListFormat;
  48. class QRect;
  49. class QPainter;
  50. class QPrinter;
  51. class QAbstractTextDocumentLayout;
  52. class QPoint;
  53. class QTextCursor;
  54. class QTextObject;
  55. class QTextFormat;
  56. class QTextFrame;
  57. class QTextBlock;
  58. class QTextCodec;
  59. class QUrl;
  60. class QVariant;
  61. class QRectF;
  62. class QTextOption;
  63. template<typename T> class QVector;
  64. namespace Qt
  65. {
  66.     enum HitTestAccuracy { ExactHit, FuzzyHit };
  67.     enum WhiteSpaceMode {
  68.         WhiteSpaceNormal,
  69.         WhiteSpacePre,
  70.         WhiteSpaceNoWrap,
  71.         WhiteSpaceModeUndefined = -1
  72.     };
  73.     Q_GUI_EXPORT bool mightBeRichText(const QString&);
  74.     Q_GUI_EXPORT QString escape(const QString& plain);
  75.     Q_GUI_EXPORT QString convertFromPlainText(const QString &plain, WhiteSpaceMode mode = WhiteSpacePre);
  76. #ifndef QT_NO_TEXTCODEC
  77.     Q_GUI_EXPORT QTextCodec *codecForHtml(const QByteArray &ba);
  78. #endif
  79. }
  80. class Q_GUI_EXPORT QAbstractUndoItem
  81. {
  82. public:
  83.     virtual ~QAbstractUndoItem() = 0;
  84.     virtual void undo() = 0;
  85.     virtual void redo() = 0;
  86. };
  87. inline QAbstractUndoItem::~QAbstractUndoItem()
  88. {
  89. }
  90. class QTextDocumentPrivate;
  91. class Q_GUI_EXPORT QTextDocument : public QObject
  92. {
  93.     Q_OBJECT
  94.     Q_PROPERTY(bool undoRedoEnabled READ isUndoRedoEnabled WRITE setUndoRedoEnabled)
  95.     Q_PROPERTY(bool modified READ isModified WRITE setModified DESIGNABLE false)
  96.     Q_PROPERTY(QSizeF pageSize READ pageSize WRITE setPageSize)
  97.     Q_PROPERTY(QFont defaultFont READ defaultFont WRITE setDefaultFont)
  98.     Q_PROPERTY(bool useDesignMetrics READ useDesignMetrics WRITE setUseDesignMetrics)
  99.     Q_PROPERTY(QSizeF size READ size)
  100.     Q_PROPERTY(qreal textWidth READ textWidth WRITE setTextWidth)
  101.     Q_PROPERTY(int blockCount READ blockCount)
  102.     Q_PROPERTY(qreal indentWidth READ indentWidth WRITE setIndentWidth)
  103. #ifndef QT_NO_CSSPARSER
  104.     Q_PROPERTY(QString defaultStyleSheet READ defaultStyleSheet WRITE setDefaultStyleSheet)
  105. #endif
  106.     Q_PROPERTY(int maximumBlockCount READ maximumBlockCount WRITE setMaximumBlockCount)
  107.     QDOC_PROPERTY(QTextOption defaultTextOption READ defaultTextOption WRITE setDefaultTextOption)
  108. public:
  109.     explicit QTextDocument(QObject *parent = 0);
  110.     explicit QTextDocument(const QString &text, QObject *parent = 0);
  111.     ~QTextDocument();
  112.     QTextDocument *clone(QObject *parent = 0) const;
  113.     bool isEmpty() const;
  114.     virtual void clear();
  115.     void setUndoRedoEnabled(bool enable);
  116.     bool isUndoRedoEnabled() const;
  117.     bool isUndoAvailable() const;
  118.     bool isRedoAvailable() const;
  119.     int revision() const;
  120.     void setDocumentLayout(QAbstractTextDocumentLayout *layout);
  121.     QAbstractTextDocumentLayout *documentLayout() const;
  122.     enum MetaInformation {
  123.         DocumentTitle,
  124.         DocumentUrl
  125.     };
  126.     void setMetaInformation(MetaInformation info, const QString &);
  127.     QString metaInformation(MetaInformation info) const;
  128. #ifndef QT_NO_TEXTHTMLPARSER
  129.     QString toHtml(const QByteArray &encoding = QByteArray()) const;
  130.     void setHtml(const QString &html);
  131. #endif
  132.     QString toPlainText() const;
  133.     void setPlainText(const QString &text);
  134.     enum FindFlag
  135.     {
  136.         FindBackward        = 0x00001,
  137.         FindCaseSensitively = 0x00002,
  138.         FindWholeWords      = 0x00004
  139.     };
  140.     Q_DECLARE_FLAGS(FindFlags, FindFlag)
  141.     QTextCursor find(const QString &subString, int from = 0, FindFlags options = 0) const;
  142.     QTextCursor find(const QString &subString, const QTextCursor &from, FindFlags options = 0) const;
  143.     QTextCursor find(const QRegExp &expr, int from = 0, FindFlags options = 0) const;
  144.     QTextCursor find(const QRegExp &expr, const QTextCursor &from, FindFlags options = 0) const;
  145.     QTextFrame *frameAt(int pos) const;
  146.     QTextFrame *rootFrame() const;
  147.     QTextObject *object(int objectIndex) const;
  148.     QTextObject *objectForFormat(const QTextFormat &) const;
  149.     QTextBlock findBlock(int pos) const;
  150.     QTextBlock findBlockByNumber(int blockNumber) const;
  151.     QTextBlock begin() const;
  152.     QTextBlock end() const;
  153.     QTextBlock firstBlock() const;
  154.     QTextBlock lastBlock() const;
  155.     void setPageSize(const QSizeF &size);
  156.     QSizeF pageSize() const;
  157.     void setDefaultFont(const QFont &font);
  158.     QFont defaultFont() const;
  159.     int pageCount() const;
  160.     bool isModified() const;
  161. #ifndef QT_NO_PRINTER
  162.     void print(QPrinter *printer) const;
  163. #endif
  164.     enum ResourceType {
  165.         HtmlResource  = 1,
  166.         ImageResource = 2,
  167.         StyleSheetResource = 3,
  168.         UserResource  = 100
  169.     };
  170.     QVariant resource(int type, const QUrl &name) const;
  171.     void addResource(int type, const QUrl &name, const QVariant &resource);
  172.     QVector<QTextFormat> allFormats() const;
  173.     void markContentsDirty(int from, int length);
  174.     void setUseDesignMetrics(bool b);
  175.     bool useDesignMetrics() const;
  176.     void drawContents(QPainter *painter, const QRectF &rect = QRectF());
  177.     void setTextWidth(qreal width);
  178.     qreal textWidth() const;
  179.     qreal idealWidth() const;
  180.     qreal indentWidth() const;
  181.     void setIndentWidth(qreal width);
  182.     void adjustSize();
  183.     QSizeF size() const;
  184.     int blockCount() const;
  185. #ifndef QT_NO_CSSPARSER
  186.     void setDefaultStyleSheet(const QString &sheet);
  187.     QString defaultStyleSheet() const;
  188. #endif
  189.     void undo(QTextCursor *cursor);
  190.     void redo(QTextCursor *cursor);
  191.     int maximumBlockCount() const;
  192.     void setMaximumBlockCount(int maximum);
  193.     QTextOption defaultTextOption() const;
  194.     void setDefaultTextOption(const QTextOption &option);
  195. Q_SIGNALS:
  196.     void contentsChange(int from, int charsRemoves, int charsAdded);
  197.     void contentsChanged();
  198.     void undoAvailable(bool);
  199.     void redoAvailable(bool);
  200.     void undoCommandAdded();
  201.     void modificationChanged(bool m);
  202.     void cursorPositionChanged(const QTextCursor &cursor);
  203.     void blockCountChanged(int newBlockCount);
  204.     void documentLayoutChanged();
  205. public Q_SLOTS:
  206.     void undo();
  207.     void redo();
  208.     void appendUndoItem(QAbstractUndoItem *);
  209.     void setModified(bool m = true);
  210. protected:
  211.     virtual QTextObject *createObject(const QTextFormat &f);
  212.     virtual QVariant loadResource(int type, const QUrl &name);
  213.     QTextDocument(QTextDocumentPrivate &dd, QObject *parent);
  214. public:
  215.     QTextDocumentPrivate *docHandle() const;
  216. private:
  217.     Q_DISABLE_COPY(QTextDocument)
  218.     Q_DECLARE_PRIVATE(QTextDocument)
  219. };
  220. Q_DECLARE_OPERATORS_FOR_FLAGS(QTextDocument::FindFlags)
  221. QT_END_NAMESPACE
  222. QT_END_HEADER
  223. #endif // QTEXTDOCUMENT_H