qtextedit.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2016 The Qt Company Ltd.
  4. ** Contact: https://www.qt.io/licensing/
  5. **
  6. ** This file is part of the QtWidgets module of the Qt Toolkit.
  7. **
  8. ** $QT_BEGIN_LICENSE:LGPL$
  9. ** Commercial License Usage
  10. ** Licensees holding valid commercial Qt licenses may use this file in
  11. ** accordance with the commercial license agreement provided with the
  12. ** Software or, alternatively, in accordance with the terms contained in
  13. ** a written agreement between you and The Qt Company. For licensing terms
  14. ** and conditions see https://www.qt.io/terms-conditions. For further
  15. ** information use the contact form at https://www.qt.io/contact-us.
  16. **
  17. ** GNU Lesser General Public License Usage
  18. ** Alternatively, this file may be used under the terms of the GNU Lesser
  19. ** General Public License version 3 as published by the Free Software
  20. ** Foundation and appearing in the file LICENSE.LGPL3 included in the
  21. ** packaging of this file. Please review the following information to
  22. ** ensure the GNU Lesser General Public License version 3 requirements
  23. ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
  24. **
  25. ** GNU General Public License Usage
  26. ** Alternatively, this file may be used under the terms of the GNU
  27. ** General Public License version 2.0 or (at your option) the GNU General
  28. ** Public license version 3 or any later version approved by the KDE Free
  29. ** Qt Foundation. The licenses are as published by the Free Software
  30. ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
  31. ** included in the packaging of this file. Please review the following
  32. ** information to ensure the GNU General Public License requirements will
  33. ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
  34. ** https://www.gnu.org/licenses/gpl-3.0.html.
  35. **
  36. ** $QT_END_LICENSE$
  37. **
  38. ****************************************************************************/
  39. #ifndef QTEXTEDIT_H
  40. #define QTEXTEDIT_H
  41. #include <QtWidgets/qabstractscrollarea.h>
  42. #include <QtGui/qtextdocument.h>
  43. #include <QtGui/qtextoption.h>
  44. #include <QtGui/qtextcursor.h>
  45. #include <QtGui/qtextformat.h>
  46. #ifndef QT_NO_TEXTEDIT
  47. QT_BEGIN_NAMESPACE
  48. class QStyleSheet;
  49. class QTextDocument;
  50. class QMenu;
  51. class QTextEditPrivate;
  52. class QMimeData;
  53. class QPagedPaintDevice;
  54. class Q_WIDGETS_EXPORT QTextEdit : public QAbstractScrollArea
  55. {
  56. Q_OBJECT
  57. Q_DECLARE_PRIVATE(QTextEdit)
  58. Q_FLAGS(AutoFormatting)
  59. Q_PROPERTY(AutoFormatting autoFormatting READ autoFormatting WRITE setAutoFormatting)
  60. Q_PROPERTY(bool tabChangesFocus READ tabChangesFocus WRITE setTabChangesFocus)
  61. Q_PROPERTY(QString documentTitle READ documentTitle WRITE setDocumentTitle)
  62. Q_PROPERTY(bool undoRedoEnabled READ isUndoRedoEnabled WRITE setUndoRedoEnabled)
  63. Q_PROPERTY(LineWrapMode lineWrapMode READ lineWrapMode WRITE setLineWrapMode)
  64. QDOC_PROPERTY(QTextOption::WrapMode wordWrapMode READ wordWrapMode WRITE setWordWrapMode)
  65. Q_PROPERTY(int lineWrapColumnOrWidth READ lineWrapColumnOrWidth WRITE setLineWrapColumnOrWidth)
  66. Q_PROPERTY(bool readOnly READ isReadOnly WRITE setReadOnly)
  67. #ifndef QT_NO_TEXTHTMLPARSER
  68. Q_PROPERTY(QString html READ toHtml WRITE setHtml NOTIFY textChanged USER true)
  69. #endif
  70. Q_PROPERTY(QString plainText READ toPlainText WRITE setPlainText DESIGNABLE false)
  71. Q_PROPERTY(bool overwriteMode READ overwriteMode WRITE setOverwriteMode)
  72. Q_PROPERTY(int tabStopWidth READ tabStopWidth WRITE setTabStopWidth)
  73. Q_PROPERTY(bool acceptRichText READ acceptRichText WRITE setAcceptRichText)
  74. Q_PROPERTY(int cursorWidth READ cursorWidth WRITE setCursorWidth)
  75. Q_PROPERTY(Qt::TextInteractionFlags textInteractionFlags READ textInteractionFlags WRITE setTextInteractionFlags)
  76. Q_PROPERTY(QTextDocument *document READ document WRITE setDocument DESIGNABLE false)
  77. Q_PROPERTY(QString placeholderText READ placeholderText WRITE setPlaceholderText)
  78. public:
  79. enum LineWrapMode {
  80. NoWrap,
  81. WidgetWidth,
  82. FixedPixelWidth,
  83. FixedColumnWidth
  84. };
  85. Q_ENUM(LineWrapMode)
  86. enum AutoFormattingFlag {
  87. AutoNone = 0,
  88. AutoBulletList = 0x00000001,
  89. AutoAll = 0xffffffff
  90. };
  91. Q_DECLARE_FLAGS(AutoFormatting, AutoFormattingFlag)
  92. explicit QTextEdit(QWidget *parent = Q_NULLPTR);
  93. explicit QTextEdit(const QString &text, QWidget *parent = Q_NULLPTR);
  94. virtual ~QTextEdit();
  95. void setDocument(QTextDocument *document);
  96. QTextDocument *document() const;
  97. void setPlaceholderText(const QString &placeholderText);
  98. QString placeholderText() const;
  99. void setTextCursor(const QTextCursor &cursor);
  100. QTextCursor textCursor() const;
  101. bool isReadOnly() const;
  102. void setReadOnly(bool ro);
  103. void setTextInteractionFlags(Qt::TextInteractionFlags flags);
  104. Qt::TextInteractionFlags textInteractionFlags() const;
  105. qreal fontPointSize() const;
  106. QString fontFamily() const;
  107. int fontWeight() const;
  108. bool fontUnderline() const;
  109. bool fontItalic() const;
  110. QColor textColor() const;
  111. QColor textBackgroundColor() const;
  112. QFont currentFont() const;
  113. Qt::Alignment alignment() const;
  114. void mergeCurrentCharFormat(const QTextCharFormat &modifier);
  115. void setCurrentCharFormat(const QTextCharFormat &format);
  116. QTextCharFormat currentCharFormat() const;
  117. AutoFormatting autoFormatting() const;
  118. void setAutoFormatting(AutoFormatting features);
  119. bool tabChangesFocus() const;
  120. void setTabChangesFocus(bool b);
  121. inline void setDocumentTitle(const QString &title)
  122. { document()->setMetaInformation(QTextDocument::DocumentTitle, title); }
  123. inline QString documentTitle() const
  124. { return document()->metaInformation(QTextDocument::DocumentTitle); }
  125. inline bool isUndoRedoEnabled() const
  126. { return document()->isUndoRedoEnabled(); }
  127. inline void setUndoRedoEnabled(bool enable)
  128. { document()->setUndoRedoEnabled(enable); }
  129. LineWrapMode lineWrapMode() const;
  130. void setLineWrapMode(LineWrapMode mode);
  131. int lineWrapColumnOrWidth() const;
  132. void setLineWrapColumnOrWidth(int w);
  133. QTextOption::WrapMode wordWrapMode() const;
  134. void setWordWrapMode(QTextOption::WrapMode policy);
  135. bool find(const QString &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags());
  136. #ifndef QT_NO_REGEXP
  137. bool find(const QRegExp &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags());
  138. #endif
  139. QString toPlainText() const;
  140. #ifndef QT_NO_TEXTHTMLPARSER
  141. QString toHtml() const;
  142. #endif
  143. void ensureCursorVisible();
  144. Q_INVOKABLE virtual QVariant loadResource(int type, const QUrl &name);
  145. #ifndef QT_NO_CONTEXTMENU
  146. QMenu *createStandardContextMenu();
  147. QMenu *createStandardContextMenu(const QPoint &position);
  148. #endif
  149. QTextCursor cursorForPosition(const QPoint &pos) const;
  150. QRect cursorRect(const QTextCursor &cursor) const;
  151. QRect cursorRect() const;
  152. QString anchorAt(const QPoint& pos) const;
  153. bool overwriteMode() const;
  154. void setOverwriteMode(bool overwrite);
  155. int tabStopWidth() const;
  156. void setTabStopWidth(int width);
  157. int cursorWidth() const;
  158. void setCursorWidth(int width);
  159. bool acceptRichText() const;
  160. void setAcceptRichText(bool accept);
  161. struct ExtraSelection
  162. {
  163. QTextCursor cursor;
  164. QTextCharFormat format;
  165. };
  166. void setExtraSelections(const QList<ExtraSelection> &selections);
  167. QList<ExtraSelection> extraSelections() const;
  168. void moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor);
  169. bool canPaste() const;
  170. void print(QPagedPaintDevice *printer) const;
  171. QVariant inputMethodQuery(Qt::InputMethodQuery property) const Q_DECL_OVERRIDE;
  172. Q_INVOKABLE QVariant inputMethodQuery(Qt::InputMethodQuery query, QVariant argument) const;
  173. public Q_SLOTS:
  174. void setFontPointSize(qreal s);
  175. void setFontFamily(const QString &fontFamily);
  176. void setFontWeight(int w);
  177. void setFontUnderline(bool b);
  178. void setFontItalic(bool b);
  179. void setTextColor(const QColor &c);
  180. void setTextBackgroundColor(const QColor &c);
  181. void setCurrentFont(const QFont &f);
  182. void setAlignment(Qt::Alignment a);
  183. void setPlainText(const QString &text);
  184. #ifndef QT_NO_TEXTHTMLPARSER
  185. void setHtml(const QString &text);
  186. #endif
  187. void setText(const QString &text);
  188. #ifndef QT_NO_CLIPBOARD
  189. void cut();
  190. void copy();
  191. void paste();
  192. #endif
  193. void undo();
  194. void redo();
  195. void clear();
  196. void selectAll();
  197. void insertPlainText(const QString &text);
  198. #ifndef QT_NO_TEXTHTMLPARSER
  199. void insertHtml(const QString &text);
  200. #endif // QT_NO_TEXTHTMLPARSER
  201. void append(const QString &text);
  202. void scrollToAnchor(const QString &name);
  203. void zoomIn(int range = 1);
  204. void zoomOut(int range = 1);
  205. Q_SIGNALS:
  206. void textChanged();
  207. void undoAvailable(bool b);
  208. void redoAvailable(bool b);
  209. void currentCharFormatChanged(const QTextCharFormat &format);
  210. void copyAvailable(bool b);
  211. void selectionChanged();
  212. void cursorPositionChanged();
  213. protected:
  214. virtual bool event(QEvent *e) Q_DECL_OVERRIDE;
  215. virtual void timerEvent(QTimerEvent *e) Q_DECL_OVERRIDE;
  216. virtual void keyPressEvent(QKeyEvent *e) Q_DECL_OVERRIDE;
  217. virtual void keyReleaseEvent(QKeyEvent *e) Q_DECL_OVERRIDE;
  218. virtual void resizeEvent(QResizeEvent *e) Q_DECL_OVERRIDE;
  219. virtual void paintEvent(QPaintEvent *e) Q_DECL_OVERRIDE;
  220. virtual void mousePressEvent(QMouseEvent *e) Q_DECL_OVERRIDE;
  221. virtual void mouseMoveEvent(QMouseEvent *e) Q_DECL_OVERRIDE;
  222. virtual void mouseReleaseEvent(QMouseEvent *e) Q_DECL_OVERRIDE;
  223. virtual void mouseDoubleClickEvent(QMouseEvent *e) Q_DECL_OVERRIDE;
  224. virtual bool focusNextPrevChild(bool next) Q_DECL_OVERRIDE;
  225. #ifndef QT_NO_CONTEXTMENU
  226. virtual void contextMenuEvent(QContextMenuEvent *e) Q_DECL_OVERRIDE;
  227. #endif
  228. #ifndef QT_NO_DRAGANDDROP
  229. virtual void dragEnterEvent(QDragEnterEvent *e) Q_DECL_OVERRIDE;
  230. virtual void dragLeaveEvent(QDragLeaveEvent *e) Q_DECL_OVERRIDE;
  231. virtual void dragMoveEvent(QDragMoveEvent *e) Q_DECL_OVERRIDE;
  232. virtual void dropEvent(QDropEvent *e) Q_DECL_OVERRIDE;
  233. #endif
  234. virtual void focusInEvent(QFocusEvent *e) Q_DECL_OVERRIDE;
  235. virtual void focusOutEvent(QFocusEvent *e) Q_DECL_OVERRIDE;
  236. virtual void showEvent(QShowEvent *) Q_DECL_OVERRIDE;
  237. virtual void changeEvent(QEvent *e) Q_DECL_OVERRIDE;
  238. #ifndef QT_NO_WHEELEVENT
  239. virtual void wheelEvent(QWheelEvent *e) Q_DECL_OVERRIDE;
  240. #endif
  241. virtual QMimeData *createMimeDataFromSelection() const;
  242. virtual bool canInsertFromMimeData(const QMimeData *source) const;
  243. virtual void insertFromMimeData(const QMimeData *source);
  244. virtual void inputMethodEvent(QInputMethodEvent *) Q_DECL_OVERRIDE;
  245. QTextEdit(QTextEditPrivate &dd, QWidget *parent);
  246. virtual void scrollContentsBy(int dx, int dy) Q_DECL_OVERRIDE;
  247. virtual void doSetTextCursor(const QTextCursor &cursor);
  248. void zoomInF(float range);
  249. private:
  250. Q_DISABLE_COPY(QTextEdit)
  251. Q_PRIVATE_SLOT(d_func(), void _q_repaintContents(const QRectF &r))
  252. Q_PRIVATE_SLOT(d_func(), void _q_currentCharFormatChanged(const QTextCharFormat &))
  253. Q_PRIVATE_SLOT(d_func(), void _q_adjustScrollbars())
  254. Q_PRIVATE_SLOT(d_func(), void _q_ensureVisible(const QRectF &))
  255. Q_PRIVATE_SLOT(d_func(), void _q_cursorPositionChanged())
  256. friend class QTextEditControl;
  257. friend class QTextDocument;
  258. friend class QWidgetTextControl;
  259. };
  260. Q_DECLARE_OPERATORS_FOR_FLAGS(QTextEdit::AutoFormatting)
  261. QT_END_NAMESPACE
  262. #endif // QT_NO_TEXTEDIT
  263. #endif // QTEXTEDIT_H