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 ，或独立使用。
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() ，和 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() 函数。
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() 函数。
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() ，和 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 :
另请参阅
PySide.QtGui.QTextCursor PySide.QtGui.QTextEdit 富文本处理 文本对象范例
| 参数： |
|
|---|
构造空 PySide.QtGui.QTextDocument 采用给定 parent .
构造 PySide.QtGui.QTextDocument containing the plain (unformatted) text specified, and with the given parent .
This enum describes the types of resources that can be loaded by PySide.QtGui.QTextDocument ‘s PySide.QtGui.QTextDocument.loadResource() 函数。
| 常量 | 描述 |
|---|---|
| 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. |
| 常量 | 描述 |
|---|---|
| QTextDocument.UndoStack | 撤消堆栈。 |
| QTextDocument.RedoStack | 重做堆栈。 |
| QTextDocument.UndoAndRedoStacks | 撤消和重做堆栈。 |
注意
This enum was introduced or modified in Qt 4.7
This enum describes the options available to PySide.QtGui.QTextDocument ‘s find function. The options can be OR-ed together from the following list:
| 常量 | 描述 |
|---|---|
| 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. |
This enum describes the different types of meta information that can be added to a document.
| 常量 | 描述 |
|---|---|
| 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. |
| 参数： |
|
|---|
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\" />")
把文档调整到合理大小。
| 返回类型： |
|---|
Returns a vector of text formats for all the formats used in the document.
| 返回类型： | PySide.QtCore.int |
|---|
返回可用的重做步骤数。
| 返回类型： | PySide.QtCore.int |
|---|
返回可用的撤消步骤数。
| 返回类型： | PySide.QtGui.QTextBlock |
|---|
返回文档的第一文本块。
| 返回类型： | PySide.QtCore.int |
|---|
返回文档的文本块数。
此特性的值在具有表 (或框架) 的文档中未定义。
默认情况下，若已定义，此特性包含 1 值。
| 参数： | newBlockCount – PySide.QtCore.int |
|---|
| 参数： | pos – PySide.QtCore.int |
|---|---|
| 返回类型： | PySide.QtCore.QChar |
返回字符位于位置 pos ，或 null 字符若位置超出范围。
| 返回类型： | PySide.QtCore.int |
|---|
返回此文档的字符数。
清理文档。
| 参数： | historyToClear – PySide.QtGui.QTextDocument.Stacks |
|---|
清零堆栈，指定通过 stacksToClear .
此方法清零撤消堆栈、重做堆栈或两者 (默认) 中的所有命令。若命令被清零，适当信号被发射， QTextDocument.undoAvailable() or QTextDocument.redoAvailable() .
| 参数： | parent – PySide.QtCore.QObject |
|---|---|
| 返回类型： | PySide.QtGui.QTextDocument |
创建新 PySide.QtGui.QTextDocument that is a copy of this text document. parent is the parent of the returned text document.
| 参数： |
|
|---|
| 参数： | f – PySide.QtGui.QTextFormat |
|---|---|
| 返回类型： | 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.
| 参数： | cursor – PySide.QtGui.QTextCursor |
|---|
| 返回类型： | PySide.QtCore.Qt.CursorMoveStyle |
|---|
The default cursor movement style is used by all PySide.QtGui.QTextCursor objects created from the document. The default is Qt.LogicalMoveStyle .
| 返回类型： | PySide.QtGui.QFont |
|---|
This property holds the default font used to display the document's text.
| 返回类型： | 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() .
样式表需要遵从 CSS 2.1 句法。
注意
Changing the default style sheet does not have any effect to the existing content of the document.
另请参阅
支持的 HTML 子集
| 返回类型： | 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.QAbstractTextDocumentLayout |
|---|
返回此文档的文档布局。
| 返回类型： | PySide.QtCore.qreal |
|---|
围绕文档的边距。默认为 4。
| 参数： |
|
|---|
Draws the content of the document with painter p , clipped to rect 。若 rect is a null rectangle (default) then the document is painted unclipped.
| 返回类型： | PySide.QtGui.QTextBlock |
|---|
此函数返回当遍历时，测试文档结尾的块。
it = doc.begin()
while it != doc.end():
print it.text()
it = it.next()
返回的块无效，表示文档最后块之后的块。可以使用 PySide.QtGui.QTextDocument.lastBlock() to retrieve the last valid block of the document.
| 参数： |
|
|---|---|
| 返回类型： |
| 参数： |
|
|---|---|
| 返回类型： |
| 参数： |
|
|---|---|
| 返回类型： |
| 参数： |
|
|---|---|
| 返回类型： |
| 参数： | pos – PySide.QtCore.int |
|---|---|
| 返回类型： | PySide.QtGui.QTextBlock |
返回文本块包含 pos -th character.
| 参数： | blockNumber – PySide.QtCore.int |
|---|---|
| 返回类型： | PySide.QtGui.QTextBlock |
返回文本块包含指定 lineNumber .
| 参数： | blockNumber – PySide.QtCore.int |
|---|---|
| 返回类型： | PySide.QtGui.QTextBlock |
返回文本块采用指定 blockNumber .
| 返回类型： | PySide.QtGui.QTextBlock |
|---|
返回文档的第一文本块。
| 参数： | pos – PySide.QtCore.int |
|---|---|
| 返回类型： | PySide.QtGui.QTextFrame |
Returns the frame that contains the text cursor position pos .
| 返回类型： | 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.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.QtCore.bool |
|---|
Returns true if the document is empty; otherwise returns false.
| 返回类型： | PySide.QtCore.bool |
|---|
This property holds whether the document has been modified by the user.
默认情况下，此特性为 false。
| 返回类型： | PySide.QtCore.bool |
|---|
Returns true if redo is available; otherwise returns false.
| 返回类型： | PySide.QtCore.bool |
|---|
Returns true if undo is available; otherwise returns false.
| 返回类型： | 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.QTextBlock |
|---|
返回文档的最后 (有效) 文本块。
| 返回类型： | 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.
| 参数： |
|
|---|---|
| 返回类型： |
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 对象。
When called by Qt, type is one of the values of QTextDocument.ResourceType .
若 PySide.QtGui.QTextDocument is a child object of a PySide.QtGui.QTextEdit , PySide.QtGui.QTextBrowser ，或 PySide.QtGui.QTextDocument itself then the default implementation tries to retrieve the data from the parent.
| 参数： |
|
|---|
Marks the contents specified by the given position and length as “dirty”, informing the document that it needs to be laid out again.
| 返回类型： | PySide.QtCore.int |
|---|
This property Specifies the limit for blocks in the document..
指定文档可能拥有的最大块数。若采用此特性的指定文档有更多块，则块被移除从文档开头。
文档的负值 (或零值) 指定可能包含无限数量的块。
默认值为 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.
| 参数： | info – PySide.QtGui.QTextDocument.MetaInformation |
|---|---|
| 返回类型： | unicode |
Returns meta information about the document of the type specified by info .
| 参数： | m – PySide.QtCore.bool |
|---|
| 参数： | objectIndex – PySide.QtCore.int |
|---|---|
| 返回类型： | PySide.QtGui.QTextObject |
Returns the text object associated with the given objectIndex .
| 参数： | arg__1 – PySide.QtGui.QTextFormat |
|---|---|
| 返回类型： | PySide.QtGui.QTextObject |
Returns the text object associated with the format f .
| 返回类型： | PySide.QtCore.int |
|---|
返回此文档中的页数。
| 返回类型： | 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.
| 参数： | printer – PySide.QtGui.QPrinter |
|---|
Prints the document to the given printer 。 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.
注意： 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.
另请参阅
QTextEdit.print()
这是重载函数。
Redoes the last editing operation on the document if redo is available .
| 参数： | 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.
| 参数： | arg__1 – PySide.QtCore.bool |
|---|
| 参数： |
|
|---|---|
| 返回类型： |
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 对象。
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.
另请参阅
QTextDocument.ResourceType
| 返回类型： | 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.QTextFrame |
|---|
Returns the document's root frame.
| 参数： | style – PySide.QtCore.Qt.CursorMoveStyle |
|---|
| 参数： | font – PySide.QtGui.QFont |
|---|
This property holds the default font used to display the document's text.
| 参数： | 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() .
样式表需要遵从 CSS 2.1 句法。
注意
Changing the default style sheet does not have any effect to the existing content of the document.
另请参阅
支持的 HTML 子集
| 参数： | option – PySide.QtGui.QTextOption |
|---|
Sets the default text option.
| 参数： | layout – PySide.QtGui.QAbstractTextDocumentLayout |
|---|
Sets the document to use the given layout . The previous layout is deleted.
| 参数： | margin – PySide.QtCore.qreal |
|---|
围绕文档的边距。默认为 4。
| 参数： | 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”.
注意
调用者有责任确保正确解码文本当 PySide.QtCore.QString containing HTML is created and passed to PySide.QtGui.QTextDocument.setHtml() .
另请参阅
PySide.QtGui.QTextDocument.setPlainText() 支持的 HTML 子集
| 参数： | 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.
| 参数： | maximum – PySide.QtCore.int |
|---|
This property Specifies the limit for blocks in the document..
指定文档可能拥有的最大块数。若采用此特性的指定文档有更多块，则块被移除从文档开头。
文档的负值 (或零值) 指定可能包含无限数量的块。
默认值为 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.
| 参数： |
|
|---|
Sets the document's meta information of the type specified by info 到给定 string .
| 参数： | m – PySide.QtCore.bool |
|---|
This property holds whether the document has been modified by the user.
默认情况下，此特性为 false。
| 参数： | 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.
| 参数： | text – unicode |
|---|
Replaces the entire contents of the document with the given plain text .
| 参数： | 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() 和 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.
默认值为 -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() 特性代替。
| 参数： | 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.
| 参数： | 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() 会被使用。
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.
默认情况下，此特性为 false。
| 返回类型： | 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.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() 和 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.
默认值为 -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() 特性代替。
| 参数： | encoding – PySide.QtCore.QByteArray |
|---|---|
| 返回类型： | unicode |
Returns a string containing an HTML representation of the document.
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.
另请参阅
支持的 HTML 子集
| 返回类型： | unicode |
|---|
Returns the plain text contained in the document. If you want formatting information use a PySide.QtGui.QTextCursor 代替。
| 参数： | 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.
见 Qt Undo Framework 文档编制了解细节。
这是重载函数。
| 参数： | arg__1 – PySide.QtCore.bool |
|---|
| 返回类型： | 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() 会被使用。
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.
默认情况下，此特性为 false。