QTextDocument¶

Inheritance diagram of QTextDocument

Synopsis¶

Functions¶

def addResource (type, name, resource)
def adjustSize ()
def allFormats ()
def availableRedoSteps ()
def availableUndoSteps ()
def begin ()
def blockCount ()
def characterAt (pos)
def characterCount ()
def clearUndoRedoStacks ([historyToClear=UndoAndRedoStacks])
def clone ([parent=None])
def defaultFont ()
def defaultStyleSheet ()
def defaultTextOption ()
def documentLayout ()
def documentMargin ()
def drawContents (painter[, rect=QRectF()])
def end ()
def find (expr, from[, options=0])
def find (expr[, from=0[, options=0]])
def find (subString, from[, options=0])
def find (subString[, from=0[, options=0]])
def findBlock (pos)
def findBlockByLineNumber (blockNumber)
def findBlockByNumber (blockNumber)
def firstBlock ()
def frameAt (pos)
def idealWidth ()
def indentWidth ()
def isEmpty ()
def isModified ()
def isRedoAvailable ()
def isUndoAvailable ()
def isUndoRedoEnabled ()
def lastBlock ()
def lineCount ()
def markContentsDirty (from, length)
def maximumBlockCount ()
def metaInformation (info)
def object (objectIndex)
def objectForFormat (arg__1)
def pageCount ()
def pageSize ()
def print_ (printer)
def redo (cursor)
def resource (type, name)
def revision ()
def rootFrame ()
def setDefaultFont (font)
def setDefaultStyleSheet (sheet)
def setDefaultTextOption (option)
def setDocumentLayout (layout)
def setDocumentMargin (margin)
def setHtml (html)
def setIndentWidth (width)
def setMaximumBlockCount (maximum)
def setMetaInformation (info, arg__2)
def setPageSize (size)
def setPlainText (text)
def setTextWidth (width)
def setUndoRedoEnabled (enable)
def setUseDesignMetrics (b)
def size ()
def textWidth ()
def toHtml ([encoding=QByteArray()])
def toPlainText ()
def undo (cursor)
def useDesignMetrics ()

Virtual functions¶

def clear ()
def createObject (f)
def loadResource (type, name)

Slots¶

def redo ()
def setModified ([m=true])
def undo ()

Signals¶

def blockCountChanged (newBlockCount)
def contentsChange (from, charsRemoves, charsAdded)
def contentsChanged ()
def cursorPositionChanged (cursor)
def documentLayoutChanged ()
def modificationChanged (m)
def redoAvailable (arg__1)
def undoAvailable (arg__1)
def undoCommandAdded ()

Detailed Description¶

The PySide.QtGui.QTextDocument class holds formatted text that can be viewed and edited using a PySide.QtGui.QTextEdit .

PySide.QtGui.QTextDocument is a container for structured rich text documents, providing support for styled text and various types of document elements, such as lists, tables, frames, and images. They can be created for use in a PySide.QtGui.QTextEdit , or used independently.

Each document element is described by an associated format object. Each format object is treated as a unique object by QTextDocuments, and can be passed to PySide.QtGui.QTextDocument.objectForFormat() to obtain the document element that it is applied to.

A PySide.QtGui.QTextDocument can be edited programmatically using a PySide.QtGui.QTextCursor , and its contents can be examined by traversing the document structure. The entire document structure is stored as a hierarchy of document elements beneath the root frame, found with the PySide.QtGui.QTextDocument.rootFrame() function. Alternatively, if you just want to iterate over the textual contents of the document you can use PySide.QtGui.QTextDocument.begin() , PySide.QtGui.QTextDocument.end() , and PySide.QtGui.QTextDocument.findBlock() to retrieve text blocks that you can examine and iterate over.

The layout of a document is determined by the PySide.QtGui.QTextDocument.documentLayout() ; you can create your own PySide.QtGui.QAbstractTextDocumentLayout subclass and set it using PySide.QtGui.QTextDocument.setDocumentLayout() if you want to use your own layout logic. The document’s title and other meta-information can be obtained by calling the PySide.QtGui.QTextDocument.metaInformation() function. For documents that are exposed to users through the PySide.QtGui.QTextEdit class, the document title is also available via the QTextEdit.documentTitle() function.

The PySide.QtGui.QTextDocument.toPlainText() and PySide.QtGui.QTextDocument.toHtml() convenience functions allow you to retrieve the contents of the document as plain text and HTML. The document’s text can be searched using the PySide.QtGui.QTextDocument.find() functions.

Undo/redo of operations performed on the document can be controlled using the PySide.QtGui.QTextDocument.setUndoRedoEnabled() function. The undo/redo system can be controlled by an editor widget through the PySide.QtGui.QTextDocument.undo() and PySide.QtGui.QTextDocument.redo() slots; the document also provides PySide.QtGui.QTextDocument.contentsChanged() , PySide.QtGui.QTextDocument.undoAvailable() , and PySide.QtGui.QTextDocument.redoAvailable() signals that inform connected editor widgets about the state of the undo/redo system. The following are the undo/redo operations of a PySide.QtGui.QTextDocument :

Insertion or removal of characters. A sequence of insertions or removals within the same text block are regarded as a single undo/redo operation.

Insertion or removal of text blocks. Sequences of insertion or removals in a single operation (e.g., by selecting and then deleting text) are regarded as a single undo/redo operation.

Text character format changes.

Text block format changes.

Text block group format changes.

See also

PySide.QtGui.QTextCursor PySide.QtGui.QTextEdit Rich Text Processing Text Object Example

class PySide.QtGui.QTextDocument([parent=None])¶

class PySide.QtGui.QTextDocument(text[, parent=None])

Parameters:	parent – `PySide.QtCore.QObject` text – unicode

Constructs an empty PySide.QtGui.QTextDocument with the given parent .

Constructs a PySide.QtGui.QTextDocument containing the plain (unformatted) text specified, and with the given parent .

PySide.QtGui.QTextDocument.ResourceType¶

This enum describes the types of resources that can be loaded by PySide.QtGui.QTextDocument ‘s PySide.QtGui.QTextDocument.loadResource() function.

Constant	Description
QTextDocument.HtmlResource	The resource contains HTML.
QTextDocument.ImageResource	The resource contains image data. Currently supported data types are `QVariant.Pixmap` and `QVariant.Image` . If the corresponding variant is of type `QVariant.ByteArray` then Qt attempts to load the image using QImage::loadFromData. `QVariant.Icon` is currently not supported. The icon needs to be converted to one of the supported types first, for example using QIcon::pixmap.
QTextDocument.StyleSheetResource	The resource contains CSS.
QTextDocument.UserResource	The first available value for user defined resource types.

PySide.QtGui.QTextDocument.Stacks¶

Constant	Description
QTextDocument.UndoStack	The undo stack.
QTextDocument.RedoStack	The redo stack.
QTextDocument.UndoAndRedoStacks	Both the undo and redo stacks.

Note

This enum was introduced or modified in Qt 4.7

PySide.QtGui.QTextDocument.FindFlag¶

This enum describes the options available to PySide.QtGui.QTextDocument ‘s find function. The options can be OR-ed together from the following list:

Constant	Description
QTextDocument.FindBackward	Search backwards instead of forwards.
QTextDocument.FindCaseSensitively	By default find works case insensitive. Specifying this option changes the behaviour to a case sensitive find operation.
QTextDocument.FindWholeWords	Makes find match only complete words.

PySide.QtGui.QTextDocument.MetaInformation¶

This enum describes the different types of meta information that can be added to a document.

Constant	Description
QTextDocument.DocumentTitle	The title of the document.
QTextDocument.DocumentUrl	The url of the document. The `PySide.QtGui.QTextDocument.loadResource()` function uses this url as the base when loading relative resources.

PySide.QtGui.QTextDocument.addResource(type, name, resource)¶

Parameters:	type – `PySide.QtCore.int` name – `PySide.QtCore.QUrl` resource – object

Adds the resource resource to the resource cache, using type and name as identifiers. type should be a value from QTextDocument.ResourceType .

For example, you can add an image as a resource in order to reference it from within the document:

document.addResource(QTextDocument.ImageResource,
    QUrl("mydata://image.png"), image)

The image can be inserted into the document using the PySide.QtGui.QTextCursor API:

imageFormat = QTextImageFormat()
imageFormat.setName("mydata://image.png")
cursor.insertImage(imageFormat)

Alternatively, you can insert images using the HTML img tag:

editor.append("<img src=\"mydata://image.png\" />")

PySide.QtGui.QTextDocument.adjustSize()¶: Adjusts the document to a reasonable size.

See also

PySide.QtGui.QTextDocument.idealWidth() PySide.QtGui.QTextDocument.textWidth() PySide.QtGui.QTextDocument.size()

PySide.QtGui.QTextDocument.allFormats()¶

Return type:

Returns a vector of text formats for all the formats used in the document.

PySide.QtGui.QTextDocument.availableRedoSteps()¶

Return type:	`PySide.QtCore.int`

Returns the number of available redo steps.

PySide.QtGui.QTextDocument.availableUndoSteps()¶

Return type:	`PySide.QtCore.int`

Returns the number of available undo steps.

PySide.QtGui.QTextDocument.begin()¶

Return type:	`PySide.QtGui.QTextBlock`

Returns the document’s first text block.

PySide.QtGui.QTextDocument.blockCount()¶

Return type:	`PySide.QtCore.int`

Returns the number of text blocks in the document.

The value of this property is undefined in documents with tables or frames.

By default, if defined, this property contains a value of 1.

PySide.QtGui.QTextDocument.blockCountChanged(newBlockCount)¶

Parameters:	newBlockCount – `PySide.QtCore.int`

PySide.QtGui.QTextDocument.characterAt(pos)¶

Parameters:	pos – `PySide.QtCore.int`
Return type:	`PySide.QtCore.QChar`

Returns the character at position pos , or a null character if the position is out of range.

PySide.QtGui.QTextDocument.characterCount()¶

Return type:	`PySide.QtCore.int`

Returns the number of characters of this document.

PySide.QtGui.QTextDocument.clear()¶: Clears the document.

PySide.QtGui.QTextDocument.clearUndoRedoStacks([historyToClear=UndoAndRedoStacks])¶

Parameters:	historyToClear – `PySide.QtGui.QTextDocument.Stacks`

Clears the stacks specified by stacksToClear .

This method clears any commands on the undo stack, the redo stack, or both (the default). If commands are cleared, the appropriate signals are emitted, QTextDocument.undoAvailable() or QTextDocument.redoAvailable() .

PySide.QtGui.QTextDocument.clone([parent=None])¶

Parameters:	parent – `PySide.QtCore.QObject`
Return type:	`PySide.QtGui.QTextDocument`

Creates a new PySide.QtGui.QTextDocument that is a copy of this text document. parent is the parent of the returned text document.

PySide.QtGui.QTextDocument.contentsChange(from, charsRemoves, charsAdded)¶

Parameters:	from – `PySide.QtCore.int` charsRemoves – `PySide.QtCore.int` charsAdded – `PySide.QtCore.int`

PySide.QtGui.QTextDocument.contentsChanged()¶

PySide.QtGui.QTextDocument.createObject(f)¶

Parameters:	f – `PySide.QtGui.QTextFormat`
Return type:	`PySide.QtGui.QTextObject`

Creates and returns a new document object (a PySide.QtGui.QTextObject ), based on the given format .

QTextObjects will always get created through this method, so you must reimplement it if you use custom text objects inside your document.

PySide.QtGui.QTextDocument.cursorPositionChanged(cursor)¶

Parameters:	cursor – `PySide.QtGui.QTextCursor`

PySide.QtGui.QTextDocument.defaultFont()¶

Return type:	`PySide.QtGui.QFont`

This property holds the default font used to display the document’s text.

PySide.QtGui.QTextDocument.defaultStyleSheet()¶

Return type:	unicode

The default style sheet is applied to all newly HTML formatted text that is inserted into the document, for example using PySide.QtGui.QTextDocument.setHtml() or QTextCursor.insertHtml() .

The style sheet needs to be compliant to CSS 2.1 syntax.

Note

Changing the default style sheet does not have any effect to the existing content of the document.

See also

Supported HTML Subset

PySide.QtGui.QTextDocument.defaultTextOption()¶

Return type:	`PySide.QtGui.QTextOption`

The default text option is used on all PySide.QtGui.QTextLayout objects in the document. This allows setting global properties for the document such as the default word wrap mode.

PySide.QtGui.QTextDocument.documentLayout()¶

Return type:	`PySide.QtGui.QAbstractTextDocumentLayout`

Returns the document layout for this document.

PySide.QtGui.QTextDocument.documentLayoutChanged()¶

PySide.QtGui.QTextDocument.documentMargin()¶

Return type:	`PySide.QtCore.qreal`

The margin around the document. The default is 4.

PySide.QtGui.QTextDocument.drawContents(painter[, rect=QRectF()])¶

Parameters:	painter – `PySide.QtGui.QPainter` rect – `PySide.QtCore.QRectF`

Draws the content of the document with painter p , clipped to rect . If rect is a null rectangle (default) then the document is painted unclipped.

PySide.QtGui.QTextDocument.end()¶

Return type:	`PySide.QtGui.QTextBlock`

This function returns a block to test for the end of the document while iterating over it.

it = doc.begin()
while it != doc.end():
    print it.text()
    it = it.next()

The block returned is invalid and represents the block after the last block in the document. You can use PySide.QtGui.QTextDocument.lastBlock() to retrieve the last valid block of the document.

PySide.QtGui.QTextDocument.find(subString[, from=0[, options=0]])¶

Parameters:	subString – unicode from – `PySide.QtCore.int` options – `PySide.QtGui.QTextDocument.FindFlags`
Return type:	`PySide.QtGui.QTextCursor`

PySide.QtGui.QTextDocument.find(subString, from[, options=0])

Parameters:	subString – unicode from – `PySide.QtGui.QTextCursor` options – `PySide.QtGui.QTextDocument.FindFlags`
Return type:	`PySide.QtGui.QTextCursor`

PySide.QtGui.QTextDocument.find(expr[, from=0[, options=0]])

Parameters:	expr – `PySide.QtCore.QRegExp` from – `PySide.QtCore.int` options – `PySide.QtGui.QTextDocument.FindFlags`
Return type:	`PySide.QtGui.QTextCursor`

PySide.QtGui.QTextDocument.find(expr, from[, options=0])

Parameters:	expr – `PySide.QtCore.QRegExp` from – `PySide.QtGui.QTextCursor` options – `PySide.QtGui.QTextDocument.FindFlags`
Return type:	`PySide.QtGui.QTextCursor`

PySide.QtGui.QTextDocument.findBlock(pos)¶

Parameters:	pos – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTextBlock`

Returns the text block that contains the pos -th character.

PySide.QtGui.QTextDocument.findBlockByLineNumber(blockNumber)¶

Parameters:	blockNumber – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTextBlock`

Returns the text block that contains the specified lineNumber .

See also

QTextBlock.firstLineNumber()

PySide.QtGui.QTextDocument.findBlockByNumber(blockNumber)¶

Parameters:	blockNumber – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTextBlock`

Returns the text block with the specified blockNumber .

See also

QTextBlock.blockNumber()

PySide.QtGui.QTextDocument.firstBlock()¶

Return type:	`PySide.QtGui.QTextBlock`

Returns the document’s first text block.

PySide.QtGui.QTextDocument.frameAt(pos)¶

Parameters:	pos – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTextFrame`

Returns the frame that contains the text cursor position pos .

PySide.QtGui.QTextDocument.idealWidth()¶

Return type:	`PySide.QtCore.qreal`

Returns the ideal width of the text document. The ideal width is the actually used width of the document without optional alignments taken into account. It is always <= PySide.QtGui.QTextDocument.size() . width() .

PySide.QtGui.QTextDocument.indentWidth()¶

Return type:	`PySide.QtCore.qreal`

Returns the width used for text list and text block indenting.

The indent properties of PySide.QtGui.QTextListFormat and PySide.QtGui.QTextBlockFormat specify multiples of this value. The default indent width is 40.

PySide.QtGui.QTextDocument.isEmpty()¶

Return type:	`PySide.QtCore.bool`

Returns true if the document is empty; otherwise returns false.

PySide.QtGui.QTextDocument.isModified()¶

Return type:	`PySide.QtCore.bool`

This property holds whether the document has been modified by the user.

By default, this property is false.

PySide.QtGui.QTextDocument.isRedoAvailable()¶

Return type:	`PySide.QtCore.bool`

Returns true if redo is available; otherwise returns false.

PySide.QtGui.QTextDocument.isUndoAvailable()¶

Return type:	`PySide.QtCore.bool`

Returns true if undo is available; otherwise returns false.

PySide.QtGui.QTextDocument.isUndoRedoEnabled()¶

Return type:	`PySide.QtCore.bool`

This property holds whether undo/redo are enabled for this document.

This defaults to true. If disabled, the undo stack is cleared and no items will be added to it.

PySide.QtGui.QTextDocument.lastBlock()¶

Return type:	`PySide.QtGui.QTextBlock`

Returns the document’s last (valid) text block.

PySide.QtGui.QTextDocument.lineCount()¶

Return type:	`PySide.QtCore.int`

Returns the number of lines of this document (if the layout supports this). Otherwise, this is identical to the number of blocks.

PySide.QtGui.QTextDocument.loadResource(type, name)¶

Parameters:	type – `PySide.QtCore.int` name – `PySide.QtCore.QUrl`
Return type:	object

Loads data of the specified type from the resource with the given name .

This function is called by the rich text engine to request data that isn’t directly stored by PySide.QtGui.QTextDocument , but still associated with it. For example, images are referenced indirectly by the name attribute of a PySide.QtGui.QTextImageFormat object.

When called by Qt, type is one of the values of QTextDocument.ResourceType .

If the PySide.QtGui.QTextDocument is a child object of a PySide.QtGui.QTextEdit , PySide.QtGui.QTextBrowser , or a PySide.QtGui.QTextDocument itself then the default implementation tries to retrieve the data from the parent.

PySide.QtGui.QTextDocument.markContentsDirty(from, length)¶

Parameters:	from – `PySide.QtCore.int` length – `PySide.QtCore.int`

Marks the contents specified by the given position and length as “dirty”, informing the document that it needs to be laid out again.

PySide.QtGui.QTextDocument.maximumBlockCount()¶

Return type:	`PySide.QtCore.int`

This property Specifies the limit for blocks in the document..

Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.

A negative or zero value specifies that the document may contain an unlimited amount of blocks.

The default value is 0.

Note that setting this property will apply the limit immediately to the document contents.

Setting this property also disables the undo redo history.

This property is undefined in documents with tables or frames.

PySide.QtGui.QTextDocument.metaInformation(info)¶

Parameters:	info – `PySide.QtGui.QTextDocument.MetaInformation`
Return type:	unicode

Returns meta information about the document of the type specified by info .

PySide.QtGui.QTextDocument.modificationChanged(m)¶

Parameters:	m – `PySide.QtCore.bool`

PySide.QtGui.QTextDocument.object(objectIndex)¶

Parameters:	objectIndex – `PySide.QtCore.int`
Return type:	`PySide.QtGui.QTextObject`

Returns the text object associated with the given objectIndex .

PySide.QtGui.QTextDocument.objectForFormat(arg__1)¶

Parameters:	arg__1 – `PySide.QtGui.QTextFormat`
Return type:	`PySide.QtGui.QTextObject`

Returns the text object associated with the format f .

PySide.QtGui.QTextDocument.pageCount()¶

Return type:	`PySide.QtCore.int`

returns the number of pages in this document.

PySide.QtGui.QTextDocument.pageSize()¶

Return type:	`PySide.QtCore.QSizeF`

This property holds the page size that should be used for laying out the document.

By default, for a newly-created, empty document, this property contains an undefined size.

PySide.QtGui.QTextDocument.print_(printer)¶

Parameters:	printer – `PySide.QtGui.QPrinter`

Prints the document to the given printer . The PySide.QtGui.QPrinter must be set up before being used with this function.

This is only a convenience method to print the whole document to the printer.

If the document is already paginated through a specified height in the PySide.QtGui.QTextDocument.pageSize() property it is printed as-is.

If the document is not paginated, like for example a document used in a PySide.QtGui.QTextEdit , then a temporary copy of the document is created and the copy is broken into multiple pages according to the size of the PySide.QtGui.QPrinter ‘s paperRect(). By default a 2 cm margin is set around the document contents. In addition the current page number is printed at the bottom of each page.

Note that QPrinter.Selection is not supported as print range with this function since the selection is a property of PySide.QtGui.QTextCursor . If you have a PySide.QtGui.QTextEdit associated with your PySide.QtGui.QTextDocument then you can use PySide.QtGui.QTextEdit ‘s print() function because PySide.QtGui.QTextEdit has access to the user’s selection.

See also

QTextEdit.print()

PySide.QtGui.QTextDocument.redo(cursor)¶

Parameters:	cursor – `PySide.QtGui.QTextCursor`

Redoes the last editing operation on the document if redo is available .

The provided cursor is positioned at the end of the location where the edition operation was redone.

PySide.QtGui.QTextDocument.redo()

This is an overloaded function.

Redoes the last editing operation on the document if redo is available .

PySide.QtGui.QTextDocument.redoAvailable(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.bool`

PySide.QtGui.QTextDocument.resource(type, name)¶

Parameters:	type – `PySide.QtCore.int` name – `PySide.QtCore.QUrl`
Return type:	object

Returns data of the specified type from the resource with the given name .

This function is called by the rich text engine to request data that isn’t directly stored by PySide.QtGui.QTextDocument , but still associated with it. For example, images are referenced indirectly by the name attribute of a PySide.QtGui.QTextImageFormat object.

Resources are cached internally in the document. If a resource can not be found in the cache, loadResource is called to try to load the resource. loadResource should then use addResource to add the resource to the cache.

See also

QTextDocument.ResourceType

PySide.QtGui.QTextDocument.revision()¶

Return type:	`PySide.QtCore.int`

Returns the document’s revision (if undo is enabled).

The revision is guaranteed to increase when a document that is not modified is edited.

PySide.QtGui.QTextDocument.rootFrame()¶

Return type:	`PySide.QtGui.QTextFrame`

Returns the document’s root frame.

PySide.QtGui.QTextDocument.setDefaultFont(font)¶

Parameters:	font – `PySide.QtGui.QFont`

This property holds the default font used to display the document’s text.

PySide.QtGui.QTextDocument.setDefaultStyleSheet(sheet)¶

Parameters:	sheet – unicode

The default style sheet is applied to all newly HTML formatted text that is inserted into the document, for example using PySide.QtGui.QTextDocument.setHtml() or QTextCursor.insertHtml() .

The style sheet needs to be compliant to CSS 2.1 syntax.

Note

Changing the default style sheet does not have any effect to the existing content of the document.

See also

Supported HTML Subset

PySide.QtGui.QTextDocument.setDefaultTextOption(option)¶

Parameters:	option – `PySide.QtGui.QTextOption`

Sets the default text option.

PySide.QtGui.QTextDocument.setDocumentLayout(layout)¶

Parameters:	layout – `PySide.QtGui.QAbstractTextDocumentLayout`

Sets the document to use the given layout . The previous layout is deleted.

PySide.QtGui.QTextDocument.setDocumentMargin(margin)¶

Parameters:	margin – `PySide.QtCore.qreal`

The margin around the document. The default is 4.

PySide.QtGui.QTextDocument.setHtml(html)¶

Parameters:	html – unicode

Replaces the entire contents of the document with the given HTML-formatted text in the html string.

The HTML formatting is respected as much as possible; for example, “<b>bold</b> text” will produce text where the first word has a font weight that gives it a bold appearance: “bold text”.

Note

It is the responsibility of the caller to make sure that the text is correctly decoded when a PySide.QtCore.QString containing HTML is created and passed to PySide.QtGui.QTextDocument.setHtml() .

See also

PySide.QtGui.QTextDocument.setPlainText() Supported HTML Subset

PySide.QtGui.QTextDocument.setIndentWidth(width)¶

Parameters:	width – `PySide.QtCore.qreal`

Returns the width used for text list and text block indenting.

The indent properties of PySide.QtGui.QTextListFormat and PySide.QtGui.QTextBlockFormat specify multiples of this value. The default indent width is 40.

PySide.QtGui.QTextDocument.setMaximumBlockCount(maximum)¶

Parameters:	maximum – `PySide.QtCore.int`

This property Specifies the limit for blocks in the document..

Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.

A negative or zero value specifies that the document may contain an unlimited amount of blocks.

The default value is 0.

Note that setting this property will apply the limit immediately to the document contents.

Setting this property also disables the undo redo history.

This property is undefined in documents with tables or frames.

PySide.QtGui.QTextDocument.setMetaInformation(info, arg__2)¶

Parameters:	info – `PySide.QtGui.QTextDocument.MetaInformation` arg__2 – unicode

Sets the document’s meta information of the type specified by info to the given string .

PySide.QtGui.QTextDocument.setModified([m=true])¶

Parameters:	m – `PySide.QtCore.bool`

This property holds whether the document has been modified by the user.

By default, this property is false.

PySide.QtGui.QTextDocument.setPageSize(size)¶

Parameters:	size – `PySide.QtCore.QSizeF`

This property holds the page size that should be used for laying out the document.

By default, for a newly-created, empty document, this property contains an undefined size.

PySide.QtGui.QTextDocument.setPlainText(text)¶

Parameters:	text – unicode

Replaces the entire contents of the document with the given plain text .

See also

PySide.QtGui.QTextDocument.setHtml()

PySide.QtGui.QTextDocument.setTextWidth(width)¶

Parameters:	width – `PySide.QtCore.qreal`

The text width specifies the preferred width for text in the document. If the text (or content in general) is wider than the specified with it is broken into multiple lines and grows vertically. If the text cannot be broken into multiple lines to fit into the specified text width it will be larger and the PySide.QtGui.QTextDocument.size() and the PySide.QtGui.QTextDocument.idealWidth() property will reflect that.

If the text width is set to -1 then the text will not be broken into multiple lines unless it is enforced through an explicit line break or a new paragraph.

The default value is -1.

Setting the text width will also set the page height to -1, causing the document to grow or shrink vertically in a continuous way. If you want the document layout to break the text into multiple pages then you have to set the PySide.QtGui.QTextDocument.pageSize() property instead.

PySide.QtGui.QTextDocument.setUndoRedoEnabled(enable)¶

Parameters:	enable – `PySide.QtCore.bool`

This property holds whether undo/redo are enabled for this document.

This defaults to true. If disabled, the undo stack is cleared and no items will be added to it.

PySide.QtGui.QTextDocument.setUseDesignMetrics(b)¶

Parameters:	b – `PySide.QtCore.bool`

This property holds whether the document uses design metrics of fonts to improve the accuracy of text layout.

If this property is set to true, the layout will use design metrics. Otherwise, the metrics of the paint device as set on QAbstractTextDocumentLayout.setPaintDevice() will be used.

Using design metrics makes a layout have a width that is no longer dependent on hinting and pixel-rounding. This means that WYSIWYG text layout becomes possible because the width scales much more linearly based on paintdevice metrics than it would otherwise.

By default, this property is false.

PySide.QtGui.QTextDocument.size()¶

Return type:	`PySide.QtCore.QSizeF`

Returns the actual size of the document. This is equivalent to PySide.QtGui.QTextDocument.documentLayout() ->documentSize();

The size of the document can be changed either by setting a text width or setting an entire page size.

Note that the width is always >= PySide.QtGui.QTextDocument.pageSize() . width() .

By default, for a newly-created, empty document, this property contains a configuration-dependent size.

PySide.QtGui.QTextDocument.textWidth()¶

Return type:	`PySide.QtCore.qreal`

The text width specifies the preferred width for text in the document. If the text (or content in general) is wider than the specified with it is broken into multiple lines and grows vertically. If the text cannot be broken into multiple lines to fit into the specified text width it will be larger and the PySide.QtGui.QTextDocument.size() and the PySide.QtGui.QTextDocument.idealWidth() property will reflect that.

If the text width is set to -1 then the text will not be broken into multiple lines unless it is enforced through an explicit line break or a new paragraph.

The default value is -1.

Setting the text width will also set the page height to -1, causing the document to grow or shrink vertically in a continuous way. If you want the document layout to break the text into multiple pages then you have to set the PySide.QtGui.QTextDocument.pageSize() property instead.

PySide.QtGui.QTextDocument.toHtml([encoding=QByteArray()])¶

Parameters:	encoding – `PySide.QtCore.QByteArray`
Return type:	unicode

Returns a string containing an HTML representation of the document.

The encoding parameter specifies the value for the charset attribute in the html header. For example if ‘utf-8’ is specified then the beginning of the generated html will look like this:

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body>...

If no encoding is specified then no such meta information is generated.

If you later on convert the returned html string into a byte array for transmission over a network or when saving to disk you should specify the encoding you’re going to use for the conversion to a byte array here.

See also

Supported HTML Subset

PySide.QtGui.QTextDocument.toPlainText()¶

Return type:	unicode

Returns the plain text contained in the document. If you want formatting information use a PySide.QtGui.QTextCursor instead.

See also

PySide.QtGui.QTextDocument.toHtml()

PySide.QtGui.QTextDocument.undo()¶: This is an overloaded function.

PySide.QtGui.QTextDocument.undo(cursor)

Parameters:	cursor – `PySide.QtGui.QTextCursor`

Undoes the last editing operation on the document if undo is available. The provided cursor is positioned at the end of the location where the edition operation was undone.

See the Qt Undo Framework documentation for details.

PySide.QtGui.QTextDocument.undoAvailable(arg__1)¶

Parameters:	arg__1 – `PySide.QtCore.bool`

PySide.QtGui.QTextDocument.undoCommandAdded()¶

PySide.QtGui.QTextDocument.useDesignMetrics()¶

Return type:	`PySide.QtCore.bool`

This property holds whether the document uses design metrics of fonts to improve the accuracy of text layout.

If this property is set to true, the layout will use design metrics. Otherwise, the metrics of the paint device as set on QAbstractTextDocumentLayout.setPaintDevice() will be used.

Using design metrics makes a layout have a width that is no longer dependent on hinting and pixel-rounding. This means that WYSIWYG text layout becomes possible because the width scales much more linearly based on paintdevice metrics than it would otherwise.

By default, this property is false.

Table Of Contents

Previous topic

Next topic

QTextDocument¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶

Table Of Contents

Previous topic

Next topic

Quick search

QTextDocument¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶