Skip to content

TextDocumentFragment

Qt Base Class: QTextDocumentFragment

Signature: QTextDocumentFragment(self) -> None QTextDocumentFragment(self, document: PySide6.QtGui.QTextDocument) -> None QTextDocumentFragment(self, range: PySide6.QtGui.QTextCursor) -> None QTextDocumentFragment(self, rhs: PySide6.QtGui.QTextDocumentFragment) -> None

Base classes

Name Children Inherits
QTextDocumentFragment
PySide6.QtGui
QTextDocumentFragment(self) -> None

⋔ Inheritance diagram

graph TD
  1473245602160["gui.TextDocumentFragment"]
  1473299699856["QtGui.QTextDocumentFragment"]
  1473291690208["Shiboken.Object"]
  140713234304496["builtins.object"]
  1473299699856 --> 1473245602160
  1473291690208 --> 1473299699856
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: QTextDocumentFragment

Source code in prettyqt\gui\textdocumentfragment.py
class TextDocumentFragment(gui.QTextDocumentFragment):
    def __repr__(self):
        return get_repr(self, gui.TextDocument(self.toPlainText()))

    def __str__(self):
        return self.toPlainText()

    def __bool__(self):
        return not self.isEmpty()

    @classmethod
    def from_plain_text(cls, text: str) -> Self:
        return cls(cls.fromPlainText(text))

    def write_to_file(
        self,
        path: datatypes.PathType,
        fmt: gui.textdocumentwriter.FormatStr | bytes | QtCore.QByteArray = "plaintext",
    ):
        writer = gui.TextDocumentWriter()
        writer.set_format(fmt)
        writer.set_file_name(path)
        return writer.write(self)