qtextedit.sip 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. // qtextedit.sip generated by MetaSIP
  2. //
  3. // This file is part of the QtWidgets Python extension module.
  4. //
  5. // Copyright (c) 2026 Riverbank Computing Limited <info@riverbankcomputing.com>
  6. //
  7. // This file is part of PyQt6.
  8. //
  9. // This file may be used under the terms of the GNU General Public License
  10. // version 3.0 as published by the Free Software Foundation and appearing in
  11. // the file LICENSE included in the packaging of this file. Please review the
  12. // following information to ensure the GNU General Public License version 3.0
  13. // requirements will be met: http://www.gnu.org/copyleft/gpl.html.
  14. //
  15. // If you do not wish to use this file under the terms of the GPL version 3.0
  16. // then you may purchase a commercial license. For more information contact
  17. // info@riverbankcomputing.com.
  18. //
  19. // This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  20. // WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  21. class QTextEdit : public QAbstractScrollArea
  22. {
  23. %TypeHeaderCode
  24. #include <qtextedit.h>
  25. %End
  26. public:
  27. struct ExtraSelection
  28. {
  29. %TypeHeaderCode
  30. #include <qtextedit.h>
  31. %End
  32. QTextCursor cursor;
  33. QTextCharFormat format;
  34. };
  35. enum LineWrapMode
  36. {
  37. NoWrap,
  38. WidgetWidth,
  39. FixedPixelWidth,
  40. FixedColumnWidth,
  41. };
  42. enum AutoFormattingFlag /BaseType=Flag/
  43. {
  44. AutoNone,
  45. AutoBulletList,
  46. AutoAll,
  47. };
  48. typedef QFlags<QTextEdit::AutoFormattingFlag> AutoFormatting;
  49. explicit QTextEdit(QWidget *parent /TransferThis/ = 0);
  50. QTextEdit(const QString &text, QWidget *parent /TransferThis/ = 0);
  51. virtual ~QTextEdit();
  52. void setDocument(QTextDocument *document /KeepReference/);
  53. QTextDocument *document() const;
  54. void setTextCursor(const QTextCursor &cursor);
  55. QTextCursor textCursor() const;
  56. bool isReadOnly() const;
  57. void setReadOnly(bool ro);
  58. qreal fontPointSize() const;
  59. QString fontFamily() const;
  60. int fontWeight() const;
  61. bool fontUnderline() const;
  62. bool fontItalic() const;
  63. QColor textColor() const;
  64. QFont currentFont() const;
  65. Qt::Alignment alignment() const;
  66. void mergeCurrentCharFormat(const QTextCharFormat &modifier);
  67. void setCurrentCharFormat(const QTextCharFormat &format);
  68. QTextCharFormat currentCharFormat() const;
  69. QTextEdit::AutoFormatting autoFormatting() const;
  70. void setAutoFormatting(QTextEdit::AutoFormatting features);
  71. bool tabChangesFocus() const;
  72. void setTabChangesFocus(bool b);
  73. void setDocumentTitle(const QString &title);
  74. QString documentTitle() const;
  75. bool isUndoRedoEnabled() const;
  76. void setUndoRedoEnabled(bool enable);
  77. QTextEdit::LineWrapMode lineWrapMode() const;
  78. void setLineWrapMode(QTextEdit::LineWrapMode mode);
  79. int lineWrapColumnOrWidth() const;
  80. void setLineWrapColumnOrWidth(int w);
  81. QTextOption::WrapMode wordWrapMode() const;
  82. void setWordWrapMode(QTextOption::WrapMode policy);
  83. bool find(const QString &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags());
  84. QString toPlainText() const;
  85. QString toHtml() const;
  86. void append(const QString &text);
  87. void ensureCursorVisible();
  88. virtual QVariant loadResource(int type, const QUrl &name);
  89. // Despite what the docs say ownership is with `this`.
  90. QMenu *createStandardContextMenu() /Transfer/;
  91. // Despite what the docs say ownership is with `this`.
  92. QMenu *createStandardContextMenu(const QPoint &position) /Transfer/;
  93. QTextCursor cursorForPosition(const QPoint &pos) const;
  94. QRect cursorRect(const QTextCursor &cursor) const;
  95. QRect cursorRect() const;
  96. QString anchorAt(const QPoint &pos) const;
  97. bool overwriteMode() const;
  98. void setOverwriteMode(bool overwrite);
  99. bool acceptRichText() const;
  100. void setAcceptRichText(bool accept);
  101. void setTextInteractionFlags(Qt::TextInteractionFlags flags);
  102. Qt::TextInteractionFlags textInteractionFlags() const;
  103. void setCursorWidth(int width);
  104. int cursorWidth() const;
  105. void setExtraSelections(const QList<QTextEdit::ExtraSelection> &selections);
  106. QList<QTextEdit::ExtraSelection> extraSelections() const;
  107. bool canPaste() const;
  108. void moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor);
  109. %If (PyQt_Printer)
  110. void print(QPagedPaintDevice *printer) const;
  111. %End
  112. public slots:
  113. void setFontPointSize(qreal s);
  114. void setFontFamily(const QString &fontFamily);
  115. void setFontWeight(int w);
  116. void setFontUnderline(bool b);
  117. void setFontItalic(bool b);
  118. void setText(const QString &text);
  119. void setTextColor(const QColor &c);
  120. void setCurrentFont(const QFont &f);
  121. void setAlignment(Qt::Alignment a);
  122. void setPlainText(const QString &text);
  123. void setHtml(const QString &text);
  124. void cut();
  125. void copy();
  126. void paste();
  127. void clear();
  128. void selectAll();
  129. void insertPlainText(const QString &text);
  130. void insertHtml(const QString &text);
  131. void scrollToAnchor(const QString &name);
  132. void redo();
  133. void undo();
  134. void zoomIn(int range = 1);
  135. void zoomOut(int range = 1);
  136. signals:
  137. void textChanged();
  138. void undoAvailable(bool b);
  139. void redoAvailable(bool b);
  140. void currentCharFormatChanged(const QTextCharFormat &format);
  141. void copyAvailable(bool b);
  142. void selectionChanged();
  143. void cursorPositionChanged();
  144. protected:
  145. virtual bool event(QEvent *e);
  146. virtual void timerEvent(QTimerEvent *e);
  147. virtual void keyPressEvent(QKeyEvent *e);
  148. virtual void keyReleaseEvent(QKeyEvent *e);
  149. virtual void resizeEvent(QResizeEvent *);
  150. virtual void paintEvent(QPaintEvent *e);
  151. virtual void mousePressEvent(QMouseEvent *e);
  152. virtual void mouseMoveEvent(QMouseEvent *e);
  153. virtual void mouseReleaseEvent(QMouseEvent *e);
  154. virtual void mouseDoubleClickEvent(QMouseEvent *e);
  155. virtual bool focusNextPrevChild(bool next);
  156. virtual void contextMenuEvent(QContextMenuEvent *e);
  157. virtual void dragEnterEvent(QDragEnterEvent *e);
  158. virtual void dragLeaveEvent(QDragLeaveEvent *e);
  159. virtual void dragMoveEvent(QDragMoveEvent *e);
  160. virtual void dropEvent(QDropEvent *e);
  161. virtual void focusInEvent(QFocusEvent *e);
  162. virtual void focusOutEvent(QFocusEvent *e);
  163. virtual void showEvent(QShowEvent *);
  164. virtual void changeEvent(QEvent *e);
  165. virtual void wheelEvent(QWheelEvent *e);
  166. virtual QMimeData *createMimeDataFromSelection() const /Factory/;
  167. virtual bool canInsertFromMimeData(const QMimeData *source) const;
  168. virtual void insertFromMimeData(const QMimeData *source);
  169. virtual void inputMethodEvent(QInputMethodEvent *);
  170. public:
  171. virtual QVariant inputMethodQuery(Qt::InputMethodQuery property) const;
  172. protected:
  173. virtual void scrollContentsBy(int dx, int dy);
  174. public:
  175. QColor textBackgroundColor() const;
  176. public slots:
  177. void setTextBackgroundColor(const QColor &c);
  178. public:
  179. void setPlaceholderText(const QString &placeholderText);
  180. QString placeholderText() const;
  181. bool find(const QRegularExpression &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags());
  182. QVariant inputMethodQuery(Qt::InputMethodQuery query, QVariant argument) const;
  183. qreal tabStopDistance() const;
  184. void setTabStopDistance(qreal distance);
  185. QString toMarkdown(QTextDocument::MarkdownFeatures features = QTextDocument::MarkdownDialectGitHub) const;
  186. public slots:
  187. void setMarkdown(const QString &markdown);
  188. };