QTextBlock ¶

概要 ¶

详细描述 ¶

文本块将块或文本段落封装在 QTextDocument . QTextBlock provides read-only access to the block/paragraph structure of QTextDocuments. It is mainly of use if you want to implement your own layouts for the visual representation of a QTextDocument , or if you want to iterate over a document and write out the contents in your own custom format.

Text blocks are created by their parent documents. If you need to create a new text block, or modify the contents of a document while examining its contents, use the cursor-based interface provided by QTextCursor 代替。

各文本块位于特定 position() 在 document() . The contents of the block can be obtained by using the text() function. The length() function determines the block’s size within the document (including formatting characters). The visual properties of the block are determined by its text layout() , its charFormat() , and its blockFormat() .

next() and previous() functions enable iteration over consecutive valid blocks in a document under the condition that the document is not modified by other means during the iteration process. Note that, although blocks are returned in sequence, adjacent blocks may come from different places in the document structure. The validity of a block can be determined by calling isValid() .

QTextBlock provides comparison operators to make it easier to work with blocks: operator==() compares two block for equality, operator!=() compares two blocks for inequality, and operator determines whether a block precedes another in the same document.

另请参阅

QTextBlockFormat QTextCharFormat QTextFragment

class QTextBlock ¶

QTextBlock(o)

param o

QTextBlock

拷贝 other text block’s attributes to this text block.

PySide2.QtGui.QTextBlock. __iter__ ( ) ¶

返回类型

PyObject

PySide2.QtGui.QTextBlock. begin ( ) ¶

返回类型

iterator

Returns a text block iterator pointing to the beginning of the text block.

另请参阅

end()

PySide2.QtGui.QTextBlock. blockFormat ( ) ¶

返回类型

QTextBlockFormat

返回 QTextBlockFormat that describes block-specific properties.

另请参阅

charFormat()

PySide2.QtGui.QTextBlock. blockFormatIndex ( ) ¶

返回类型

int

Returns an index into the document’s internal list of block formats for the text block’s format.

另请参阅

allFormats()

PySide2.QtGui.QTextBlock. blockNumber ( ) ¶

返回类型

int

返回此块的编号，或 -1 若块无效。

另请参阅

blockNumber()

PySide2.QtGui.QTextBlock. charFormat ( ) ¶

返回类型

QTextCharFormat

返回 QTextCharFormat that describes the block’s character format. The block’s character format is used when inserting text into an empty block.

另请参阅

blockFormat()

PySide2.QtGui.QTextBlock. charFormatIndex ( ) ¶

返回类型

int

Returns an index into the document’s internal list of character formats for the text block’s character format.

另请参阅

allFormats()

PySide2.QtGui.QTextBlock. clearLayout ( ) ¶

清零 QTextLayout that is used to lay out and display the block’s contents.

另请参阅

layout()

PySide2.QtGui.QTextBlock. contains ( position ) ¶

参数

position – int

返回类型

bool

返回 true 若给定 position 位于文本块内；否则返回 false .

PySide2.QtGui.QTextBlock. document ( ) ¶

返回类型

QTextDocument

返回此文本块所属的文本文档，或 None 若文本块不属于任何文档。

PySide2.QtGui.QTextBlock. end ( ) ¶

返回类型

iterator

返回指向文本块末尾的文本块迭代器。

另请参阅

begin() next() previous()

PySide2.QtGui.QTextBlock. firstLineNumber ( ) ¶

返回类型

int

Returns the first line number of this block, or -1 if the block is invalid. Unless the layout supports it, the line number is identical to the block number.

另请参阅

blockNumber()

PySide2.QtGui.QTextBlock. fragmentIndex ( ) ¶

返回类型

int

PySide2.QtGui.QTextBlock. isValid ( ) ¶

返回类型

bool

返回 true 若此文本块有效；否则返回 false .

PySide2.QtGui.QTextBlock. isVisible ( ) ¶

返回类型

bool

返回 true 若块可见；否则返回 false .

另请参阅

setVisible()

PySide2.QtGui.QTextBlock. layout ( ) ¶

返回类型

QTextLayout

返回 QTextLayout that is used to lay out and display the block’s contents.

注意：返回的 QTextLayout object can only be modified from the documentChanged implementation of a QAbstractTextDocumentLayout subclass. Any changes applied from the outside cause undefined behavior.

另请参阅

clearLayout()

PySide2.QtGui.QTextBlock. length ( ) ¶

返回类型

int

返回块的长度 (以字符为单位)。

注意

The length returned includes all formatting characters, for example, newline.

另请参阅

text() charFormat() blockFormat()

PySide2.QtGui.QTextBlock. lineCount ( ) ¶

返回类型

int

Returns the line count. Not all document layouts support this feature.

另请参阅

setLineCount()

PySide2.QtGui.QTextBlock. next ( ) ¶

返回类型

QTextBlock

返回此块之后的文档文本块；或空文本块若这是最后一个。

注意：下一个块可能与此块位于不同的框架 (或表格) 中。

另请参阅

previous() begin() end()

PySide2.QtGui.QTextBlock. __ne__ ( o ) ¶

参数

o – QTextBlock

返回类型

bool

返回 true 若此文本块不同于 other 文本块。

PySide2.QtGui.QTextBlock. __lt__ ( o ) ¶

参数

o – QTextBlock

返回类型

bool

PySide2.QtGui.QTextBlock. __eq__ ( o ) ¶

参数

o – QTextBlock

返回类型

bool

返回 true 若此文本块相同如 other 文本块。

PySide2.QtGui.QTextBlock. position ( ) ¶

返回类型

int

Returns the index of the block’s first character within the document.

PySide2.QtGui.QTextBlock. 上一 ( ) ¶

返回类型

QTextBlock

Returns the text block in the document before this block, or an empty text block if this is the first one.

Note that the previous block may be in a different frame or table to this block.

另请参阅

next() begin() end()

PySide2.QtGui.QTextBlock. revision ( ) ¶

返回类型

int

返回块修订。

另请参阅

setRevision() revision()

PySide2.QtGui.QTextBlock. setLineCount ( count ) ¶

参数

count – int

把行数设为 count .

另请参阅

lineCount()

PySide2.QtGui.QTextBlock. setRevision ( rev ) ¶

参数

rev – int

把块修订设为 rev .

另请参阅

revision() revision()

PySide2.QtGui.QTextBlock. setUserData ( data ) ¶

参数

data – QTextBlockUserData

附加给定 data 对象到文本块。

QTextBlockUserData can be used to store custom settings. The ownership is passed to the underlying text document, i.e. the provided QTextBlockUserData object will be deleted if the corresponding text block gets deleted. The user data object is not stored in the undo history, so it will not be available after undoing the deletion of a text block.

For example, if you write a programming editor in an IDE, you may want to let your user set breakpoints visually in your code for an integrated debugger. In a programming editor a line of text usually corresponds to one QTextBlock 。 QTextBlockUserData interface allows the developer to store data for each QTextBlock , like for example in which lines of the source code the user has a breakpoint set. Of course this could also be stored externally, but by storing it inside the QTextDocument , it will for example be automatically deleted when the user deletes the associated line. It’s really just a way to store custom information in the QTextDocument without using custom properties in QTextFormat which would affect the undo/redo stack.

另请参阅

userData()

PySide2.QtGui.QTextBlock. setUserState ( state ) ¶

参数

state – int

存储指定 state integer value in the text block. This may be useful for example in a syntax highlighter to store a text parsing state.

另请参阅

userState()

PySide2.QtGui.QTextBlock. setVisible ( visible ) ¶

参数

visible – bool

Sets the block’s visibility to visible .

另请参阅

isVisible()

PySide2.QtGui.QTextBlock. text ( ) ¶

返回类型

unicode

Returns the block’s contents as plain text.

另请参阅

length() charFormat() blockFormat()

PySide2.QtGui.QTextBlock. textDirection ( ) ¶

返回类型

LayoutDirection

返回解析文本方向。

If the block has no explicit direction set, it will resolve the direction from the blocks content. Returns either LeftToRight or RightToLeft .

另请参阅

layoutDirection() isRightToLeft() LayoutDirection

PySide2.QtGui.QTextBlock. textFormats ( ) ¶

返回类型

Returns the block’s text format options as a list of continuous ranges of QTextCharFormat . The range’s character format is used when inserting text within the range boundaries.

另请参阅

charFormat() blockFormat()

PySide2.QtGui.QTextBlock. textList ( ) ¶

返回类型

QTextList

若块表示列表项，返回该项所属的列表；否则返回 None .

PySide2.QtGui.QTextBlock. userData ( ) ¶

返回类型

QTextBlockUserData

返回指针指向 QTextBlockUserData 对象，若有设置采用 setUserData() ，或 None .

另请参阅

setUserData()

PySide2.QtGui.QTextBlock. userState ( ) ¶

返回类型

int

返回先前设置的整数值采用 setUserState() or -1.

另请参阅

setUserState()