Skip to content

PythonQt.QtGui.QPlainTextDocumentLayout

QPlainTextDocumentLayout

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

A QPlainTextDocumentLayout is required for text documents that can be display or edited in a QPlainTextEdit. See QTextDocument::setDocumentLayout().

QPlainTextDocumentLayout uses the QAbstractTextDocumentLayout API that QTextDocument requires, but redefines it partially in order to support plain text better. For instances, it does not operate on vertical pixels, but on paragraphs (called blocks) instead. The height of a document is identical to the number of paragraphs it contains. The layout also doesn't support tables or nested frames, or any sort of advanced text layout that goes beyond a list of paragraphs with syntax highlighting.

Source: https://doc.qt.io/archives/qt-5.15/qplaintextdocumentlayout.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
anchorAt function (self, pos: Any) -> str X.anchorAt(pos) -> str
blockBoundingRect function (self, block: Any) -> Any X.blockBoundingRect(block) -> PythonQt.QtCore.QRectF
blockSignals function (self, b: Any) -> bool X.blockSignals(b) -> bool (shared captured text)
childEvent function (self, event: Any) -> Any (shared captured text)
children function (self) -> tuple X.children() -> tuple (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
connect function (self, signal: Any, receiver: Any, slot: Any, type: Any) -> bool X.connect(signal, receiver, slot, type) -> bool (shared captured text)
cursorWidth attribute int This property specifies the width of the cursor in pixels.
customEvent function (self, event: Any) -> Any (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
deleteLater function (self) -> Any (shared captured text)
destroyed function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QPlainTextDocumentLayout.destroyed; argument details are not documented.
disconnect function (self, signal: Any, receiver: Any, slot: Any) -> bool X.disconnect(signal, receiver, slot) -> bool (shared captured text)
document function (self) -> Any X.document() -> PythonQt.QtGui.QTextDocument
documentChanged function (self, *args: Any, **kwargs: Any) -> None X.documentChanged(from, arg__2, charsAdded)
documentSize function (self) -> Any X.documentSize() -> PythonQt.QtCore.QSizeF
documentSizeChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QPlainTextDocumentLayout.documentSizeChanged; argument details are not documented.
draw function (self, arg__1: Any, arg__2: Any) -> None X.draw(arg__1, arg__2)
drawInlineObject function (self, painter: Any, rect: Any, object: Any, posInDocument: Any, format: Any) -> Any X.drawInlineObject(painter, rect, object, posInDocument, format)
dumpObjectInfo function (self) -> Any (shared captured text)
dumpObjectTree function (self) -> Any (shared captured text)
dynamicPropertyNames function (self) -> Any (shared captured text)
ensureBlockLayout function (self, block: Any) -> None Ensures that block has a valid layout
event function (self, event: Any) -> bool X.event(event) -> bool (shared captured text)
eventFilter function (self, watched: Any, event: Any) -> bool X.eventFilter(watched, event) -> bool (shared captured text)
findChild function (self, type: Any, name: Any) -> Any X.findChild(type, name) -> PythonQt.private.QObject (shared captured text)
findChildren function (self, type: Any, name: Any) -> tuple X.findChildren(type, name) -> tuple (shared captured text)
format function (self, pos: Any) -> Any X.format(pos) -> PythonQt.QtGui.QTextCharFormat
formatIndex function (self, pos: Any) -> int X.formatIndex(pos) -> int
frameBoundingRect function (self, arg__1: Any) -> Any X.frameBoundingRect(arg__1) -> PythonQt.QtCore.QRectF
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
hitTest function (self, arg__1: Any, arg__2: Any) -> int X.hitTest(arg__1, arg__2) -> int
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
installEventFilter function (self, filterObj: Any) -> Any (shared captured text)
isSignalConnected function (self, signal: Any) -> bool X.isSignalConnected(signal) -> bool (shared captured text)
isWidgetType function (self) -> bool X.isWidgetType() -> bool (shared captured text)
isWindowType function (self) -> bool X.isWindowType() -> bool (shared captured text)
killTimer function (self, id: Any) -> Any (shared captured text)
metaObject function (self) -> Any X.metaObject() -> PythonQt.QtCore.QMetaObject (shared captured text)
moveToThread function (self, thread: Any) -> Any (shared captured text)
objectName attribute Any (shared captured text)
objectNameChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QPlainTextDocumentLayout.objectNameChanged; argument details are not documented.
pageCount function (self) -> int X.pageCount() -> int
pageCountChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QPlainTextDocumentLayout.pageCountChanged; argument details are not documented.
paintDevice function (self) -> Any X.paintDevice() -> PythonQt.QtGui.QPaintDevice
parent function (self) -> Any X.parent() -> PythonQt.private.QObject (shared captured text)
positionInlineObject function (self, item: Any, posInDocument: Any, format: Any) -> Any X.positionInlineObject(item, posInDocument, format)
property function (self, name: Any) -> Any X.property(name) -> object (shared captured text)
registerHandler function (self, objectType: Any, component: Any) -> Any X.registerHandler(objectType, component)
removeEventFilter function (self, obj: Any) -> Any (shared captured text)
requestUpdate function (self) -> None Requests a complete update on all views.
resizeInlineObject function (self, item: Any, posInDocument: Any, format: Any) -> Any X.resizeInlineObject(item, posInDocument, format)
sender function (self) -> Any X.sender() -> PythonQt.private.QObject (shared captured text)
senderSignalIndex function (self) -> int X.senderSignalIndex() -> int (shared captured text)
setCursorWidth function (self, width: int) -> None
setObjectName function (self, name: Any) -> Any (shared captured text)
setPaintDevice function (self, device: Any) -> Any
setParent function (self, parent: Any) -> Any (shared captured text)
setProperty function (self, name: Any, value: Any) -> bool X.setProperty(name, value) -> bool (shared captured text)
signalsBlocked function (self) -> bool X.signalsBlocked() -> bool (shared captured text)
startTimer function (self, interval: Any, timerType: Any) -> int X.startTimer(interval, timerType) -> int (shared captured text)
thread function (self) -> Any (shared captured text)
timerEvent function (self, event: Any) -> Any (shared captured text)
tr function (self, text: Any, ambig: Any, n: Any) -> str X.tr(text, ambig, n) -> str (shared captured text)
unregisterHandler function (self, objectType: Any, component: Any) -> Any X.unregisterHandler(objectType, component)
update function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QPlainTextDocumentLayout.update; argument details are not documented.
updateBlock function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QPlainTextDocumentLayout.updateBlock; argument details are not documented.