Skip to content

PythonQt.QtGui.QPlainTextEdit · declarations 003

Back to PythonQt.QtGui.QPlainTextEdit

setCenterOnScroll

setCenterOnScroll(enabled: bool) -> None

X.setCenterOnScroll(enabled)

Upstream PySide2 reference signatures (binding differences may apply):

setCenterOnScroll(self, enabled: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setCenterOnScroll

setCurrentCharFormat

setCurrentCharFormat(format: Any) -> None

X.setCurrentCharFormat(format)

Supplemental documentation: Qt 5 reference:

void QPlainTextEdit::setCurrentCharFormat(const QTextCharFormat \&format)

Sets the char format that is be used when inserting new text to format by calling QTextCursor::setCharFormat() on the editor's cursor. If the editor has a selection then the char format is directly applied to the selection.

See also currentCharFormat().

Upstream PySide2 reference signatures (binding differences may apply):

setCurrentCharFormat(self, format: PySide2.QtGui.QTextCharFormat) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setCurrentCharFormat

setCursorWidth

setCursorWidth(width: int) -> None

X.setCursorWidth(width)

Upstream PySide2 reference signatures (binding differences may apply):

setCursorWidth(self, width: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setCursorWidth

setDocument

setDocument(document: Any) -> None

X.setDocument(document)

Supplemental documentation: Qt 5 reference:

void QPlainTextEdit::setDocument(QTextDocument *document)

Makes document the new document of the text editor.

The parent QObject of the provided document remains the owner of the object. If the current document is a child of the text editor, then it is deleted.

The document must have a document layout that inherits QPlainTextDocumentLayout (see QTextDocument::setDocumentLayout()).

See also document().

Upstream PySide2 reference signatures (binding differences may apply):

setDocument(self, document: PySide2.QtGui.QTextDocument) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setDocument

setDocumentTitle

setDocumentTitle(title: str) -> None

X.setDocumentTitle(title)

Upstream PySide2 reference signatures (binding differences may apply):

setDocumentTitle(self, title: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setDocumentTitle

setExtraSelections

setExtraSelections(selections: Any) -> None

X.setExtraSelections(selections)

Supplemental documentation: Qt 5 reference:

void QPlainTextEdit::setExtraSelections(const QList\<QTextEdit::ExtraSelection> \&selections)

This function allows temporarily marking certain regions in the document with a given color, specified as selections. This can be useful for example in a programming editor to mark a whole line of text with a given background color to indicate the existence of a breakpoint.

See also QTextEdit::ExtraSelection and extraSelections().

Upstream PySide2 reference signatures (binding differences may apply):

setExtraSelections(self, selections: typing.Sequence[PySide2.QtWidgets.QTextEdit.ExtraSelection]) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setExtraSelections

setLineWrapMode

setLineWrapMode(mode: Any) -> None

X.setLineWrapMode(mode)

Upstream PySide2 reference signatures (binding differences may apply):

setLineWrapMode(self, mode: PySide2.QtWidgets.QPlainTextEdit.LineWrapMode) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setLineWrapMode

setMaximumBlockCount

setMaximumBlockCount(maximum: int) -> None

X.setMaximumBlockCount(maximum)

Upstream PySide2 reference signatures (binding differences may apply):

setMaximumBlockCount(self, maximum: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setMaximumBlockCount

setOverwriteMode

setOverwriteMode(overwrite: bool) -> None

X.setOverwriteMode(overwrite)

Upstream PySide2 reference signatures (binding differences may apply):

setOverwriteMode(self, overwrite: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setOverwriteMode

setPlaceholderText

setPlaceholderText(placeholderText: str) -> None

X.setPlaceholderText(placeholderText)

Upstream PySide2 reference signatures (binding differences may apply):

setPlaceholderText(self, placeholderText: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setPlaceholderText

setPlainText

setPlainText(text: str) -> None

X.setPlainText(text)

Supplemental documentation: Qt 5 reference:

[slot] void QPlainTextEdit::setPlainText(const QString \&text)

Changes the text of the text edit to the string text. Any previous text is removed.

text is interpreted as plain text.

Notes:

  • The undo/redo history is also cleared.
  • currentCharFormat() is reset, unless textCursor() is already at the beginning of the document.

Note: Setter function for property plainText.

See also toPlainText().

Upstream PySide2 reference signatures (binding differences may apply):

setPlainText(self, text: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setPlainText

setReadOnly

setReadOnly(ro: bool) -> None

X.setReadOnly(ro)

Upstream PySide2 reference signatures (binding differences may apply):

setReadOnly(self, ro: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setReadOnly

setTabChangesFocus

setTabChangesFocus(b: bool) -> None

X.setTabChangesFocus(b)

Upstream PySide2 reference signatures (binding differences may apply):

setTabChangesFocus(self, b: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setTabChangesFocus

setTabStopWidth

setTabStopWidth(width: int) -> None

X.setTabStopWidth(width)

Upstream PySide2 reference signatures (binding differences may apply):

setTabStopWidth(self, width: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setTabStopWidth

setTextCursor

setTextCursor(cursor: Any) -> None

X.setTextCursor(cursor)

Supplemental documentation: Qt 5 reference:

void QPlainTextEdit::setTextCursor(const QTextCursor \&cursor)

Sets the visible cursor.

See also textCursor().

Upstream PySide2 reference signatures (binding differences may apply):

setTextCursor(self, cursor: PySide2.QtGui.QTextCursor) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setTextCursor

setTextInteractionFlags

setTextInteractionFlags(arg0: flags) -> None

X.setTextInteractionFlags(flags)

Upstream PySide2 reference signatures (binding differences may apply):

setTextInteractionFlags(self, flags: PySide2.QtCore.Qt.TextInteractionFlags) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setTextInteractionFlags

setUndoRedoEnabled

setUndoRedoEnabled(enable: bool) -> None

X.setUndoRedoEnabled(enable)

Upstream PySide2 reference signatures (binding differences may apply):

setUndoRedoEnabled(self, enable: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setUndoRedoEnabled

setWordWrapMode

setWordWrapMode(policy: Any) -> None

X.setWordWrapMode(policy)

Upstream PySide2 reference signatures (binding differences may apply):

setWordWrapMode(self, policy: PySide2.QtGui.QTextOption.WrapMode) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#setWordWrapMode

showEvent

showEvent(arg__1: Any) -> None

X.showEvent(arg__1)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QPlainTextEdit::showEvent(QShowEvent *)

Reimplements: QWidget::showEvent(QShowEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

showEvent(self, arg__1: PySide2.QtGui.QShowEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#showEvent

tabChangesFocus instance-attribute

tabChangesFocus: bool

Qt 5 reference:

tabChangesFocus : bool

This property holds whether Tab changes focus or is accepted as input

In some occasions text edits should not allow the user to input tabulators or change indentation using the Tab key, as this breaks the focus chain. The default is false.

Access functions:

bool tabChangesFocus() const
void setTabChangesFocus(bool b)

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#tabChangesFocus

tabStopDistance instance-attribute

tabStopDistance: float

Qt 5 reference:

tabStopDistance : qreal

This property holds the tab stop distance in pixels

By default, this property contains a value of 80.

This property was introduced in Qt 5.10.

Access functions:

qreal tabStopDistance() const
void setTabStopDistance(qreal distance)

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#tabStopDistance

tabStopWidth instance-attribute

tabStopWidth: int

textChanged

textChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QPlainTextEdit.textChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QPlainTextEdit::textChanged()

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

Note: Notifier signal for property plainText.

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#textChanged

textCursor

textCursor() -> Any

X.textCursor() -> PythonQt.QtGui.QTextCursor

Supplemental documentation: Qt 5 reference:

QTextCursor QPlainTextEdit::textCursor() const

Returns a copy of the QTextCursor that represents the currently visible cursor. Note that changes on the returned cursor do not affect QPlainTextEdit's cursor; use setTextCursor() to update the visible cursor.

See also setTextCursor().

Upstream PySide2 reference signatures (binding differences may apply):

textCursor(self) -> PySide2.QtGui.QTextCursor

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#textCursor

textInteractionFlags instance-attribute

textInteractionFlags: Any

Qt 5 reference:

textInteractionFlags : Qt::TextInteractionFlags

Specifies how the label should interact with user input if it displays text.

If the flags contain either Qt::LinksAccessibleByKeyboard or Qt::TextSelectableByKeyboard then the focus policy is also automatically set to Qt::ClickFocus.

The default value depends on whether the QPlainTextEdit is read-only or editable.

Access functions:

Qt::TextInteractionFlags textInteractionFlags() const
void setTextInteractionFlags(Qt::TextInteractionFlags flags)

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#textInteractionFlags

timerEvent

timerEvent(e: Any) -> None

X.timerEvent(e)

Upstream PySide2 reference signatures (binding differences may apply):

timerEvent(self, e: PySide2.QtCore.QTimerEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#timerEvent

toPlainText

toPlainText() -> str

X.toPlainText() -> str

Supplemental documentation: Qt 5 reference:

QString QPlainTextEdit::toPlainText() const

Returns the text of the text edit as plain text.

Note: Getter function for property plainText.

See also QPlainTextEdit::setPlainText().

Upstream PySide2 reference signatures (binding differences may apply):

toPlainText(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#toPlainText

undo

undo() -> None

X.undo()

Supplemental documentation: Qt 5 reference:

[slot] void QPlainTextEdit::undo()

Undoes the last operation.

If there is no operation to undo, i.e. there is no undo step in the undo/redo history, nothing happens.

See also redo().

Upstream PySide2 reference signatures (binding differences may apply):

undo(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#undo

undoAvailable

undoAvailable(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QPlainTextEdit.undoAvailable; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QPlainTextEdit::undoAvailable(bool available)

This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#undoAvailable

undoRedoEnabled instance-attribute

undoRedoEnabled: Any

Qt 5 reference:

undoRedoEnabled : bool

This property holds whether undo and redo are enabled

Users are only able to undo or redo actions if this property is true, and if there is an action that can be undone (or redone).

By default, this property is true.

Access functions:

bool isUndoRedoEnabled() const
void setUndoRedoEnabled(bool enable)

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#undoRedoEnabled

updateRequest

updateRequest(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QPlainTextEdit.updateRequest; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QPlainTextEdit::updateRequest(const QRect \&rect, int dy)

This signal is emitted when the text document needs an update of the specified rect. If the text is scrolled, rect will cover the entire viewport area. If the text is scrolled vertically, dy carries the amount of pixels the viewport was scrolled.

The purpose of the signal is to support extra widgets in plain text edit subclasses that e.g. show line numbers, breakpoints, or other extra information.

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#updateRequest

viewportEvent

viewportEvent(arg__1: Any) -> bool

X.viewportEvent(arg__1) -> bool

wheelEvent

wheelEvent(e: Any) -> None

X.wheelEvent(e)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QPlainTextEdit::wheelEvent(QWheelEvent *e)

Reimplements: QAbstractScrollArea::wheelEvent(QWheelEvent *e).

Upstream PySide2 reference signatures (binding differences may apply):

wheelEvent(self, e: PySide2.QtGui.QWheelEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#wheelEvent

windowIconChanged

windowIconChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QPlainTextEdit.windowIconChanged; argument details are not documented.

windowIconTextChanged

windowIconTextChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QPlainTextEdit.windowIconTextChanged; argument details are not documented.

windowTitleChanged

windowTitleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QPlainTextEdit.windowTitleChanged; argument details are not documented.

wordWrapMode

wordWrapMode() -> Any

X.wordWrapMode()

Supplemental documentation: Qt 5 reference:

wordWrapMode : QTextOption::WrapMode

This property holds the mode QPlainTextEdit will use when wrapping text by words

By default, this property is set to QTextOption::WrapAtWordBoundaryOrAnywhere.

Access functions:

QTextOption::WrapMode wordWrapMode() const
void setWordWrapMode(QTextOption::WrapMode policy)

See also QTextOption::WrapMode.

Upstream PySide2 reference signatures (binding differences may apply):

wordWrapMode(self) -> PySide2.QtGui.QTextOption.WrapMode

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#wordWrapMode

zoomIn

zoomIn(range: int) -> None

X.zoomIn(range)

Supplemental documentation: Qt 5 reference:

[slot] void QPlainTextEdit::zoomIn(int range \= 1)

Zooms in on the text by making the base font size range points larger and recalculating all font sizes to be the new size. This does not change the size of any images.

See also zoomOut().

Upstream PySide2 reference signatures (binding differences may apply):

zoomIn(self, range: int=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#zoomIn

zoomInF

zoomInF(range: float) -> None

X.zoomInF(range)

Upstream PySide2 reference signatures (binding differences may apply):

zoomInF(self, range: float) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#zoomInF

zoomOut

zoomOut(range: int) -> None

X.zoomOut(range)

Supplemental documentation: Qt 5 reference:

[slot] void QPlainTextEdit::zoomOut(int range \= 1)

Zooms out on the text by making the base font size range points smaller and recalculating all font sizes to be the new size. This does not change the size of any images.

See also zoomIn().

Upstream PySide2 reference signatures (binding differences may apply):

zoomOut(self, range: int=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qplaintextedit.html#zoomOut