QTextBlock Class Reference · PyQt4 中文文檔

# QTextBlock Class Reference ## [[QtGui](index.htm) module] 該QTextBlock類提供一個容器，用于文本片段中[QTextDocument](qtextdocument.html)。[More...](#details) ### Types * `class **[iterator](index.htm)**` ### Methods * `__init__ (self)` * `__init__ (self, QTextBlock?o)` * `iterator begin (self)` * `QTextBlockFormat blockFormat (self)` * `int blockFormatIndex (self)` * `int blockNumber (self)` * `QTextCharFormat charFormat (self)` * `int charFormatIndex (self)` * `clearLayout (self)` * `bool contains (self, int?position)` * `QTextDocument document (self)` * `iterator end (self)` * `int firstLineNumber (self)` * `bool isValid (self)` * `bool isVisible (self)` * `QTextLayout layout (self)` * `int length (self)` * `int lineCount (self)` * `QTextBlock next (self)` * `int position (self)` * `QTextBlock previous (self)` * `int revision (self)` * `setLineCount (self, int?count)` * `setRevision (self, int?rev)` * `setUserData (self, QTextBlockUserData?data)` * `setUserState (self, int?state)` * `setVisible (self, bool?visible)` * `QString text (self)` * `Qt.LayoutDirection textDirection (self)` * `QTextList textList (self)` * `QTextBlockUserData userData (self)` * `int userState (self)` ### Special Methods * `bool __eq__ (self, QTextBlock?o)` * `bool __ge__ (self, QTextBlock?o)` * `bool __lt__ (self, QTextBlock?o)` * `bool __ne__ (self, QTextBlock?o)` * * * ## Detailed Description 該QTextBlock類提供一個容器，用于文本片段中[QTextDocument](qtextdocument.html)。文字塊封裝在一個塊或一段文字[QTextDocument](qtextdocument.html)。 QTextBlock提供QTextDocuments塊/段落結構進行只讀訪問。主要的是使用，如果你想實現自己的布局的可視化表示形式[QTextDocument](qtextdocument.html)，或者如果您想遍歷一個文件，寫出來的內容在自己的自定義格式。文本塊通過它們的父文件創建的。如果你需要創建一個新的文本塊，或修改文件的內容，同時檢查其內容，使用所提供的基于指針的接口[QTextCursor](qtextcursor.html)代替。每個文本塊位于一個特定的[position](qtextblock.html#position)在（）[document](qtextblock.html#document)（）。該塊的內容可以通過使用所獲得的[text](qtextblock.html#text)（）函數。該[length](qtextblock.html#length)（）函數確定文件（包括格式化字符）中的塊的大小。塊的可視屬性是由它的文本確定[layout](qtextblock.html#layout)（），其[charFormat](qtextblock.html#charFormat)（），和其[blockFormat](qtextblock.html#blockFormat)（）。該[next](qtextblock.html#next)（）和[previous](qtextblock.html#previous)（）函數使迭代連續有效塊一份文件，該文件是由其他途徑在迭代過程中不被修改的情況下。需要注意的是，雖然塊序列中返回，相鄰塊可能來自于文件結構不同的地方。塊的有效性可以通過調用確定[isValid](qtextblock.html#isValid)（）。 QTextBlock提供了比較操作符，使其更容易與塊工作：[operator==](qtextblock.html#operator-eq-eq)（）比較兩個塊是否相等，[operator!=](qtextblock.html#operator-not-eq)（）比較兩個街區的不平等，[operator<](qtextblock.html#operator-lt)（）確定數據塊是否先于在同一文檔中的另一個。 ![](https://img.kancloud.cn/3c/03/3c037dd95d1321b40b15df9fa125f80c_239x256.png) * * * ## Method Documentation ``` QTextBlock.__init__ (self) ``` 副本_other_文本塊的屬性到這個文本塊。 ``` QTextBlock.__init__ (self, QTextBlock?o) ``` ``` iterator QTextBlock.begin (self) ``` [ 返回一個文本塊迭代器，指向文本塊的開始。 ](index.htm) [**See also**](index.htm) [end](qtextblock.html#end)（）。 ``` QTextBlockFormat QTextBlock.blockFormat (self) ``` [](qtextblockformat.html) [返回](qtextblockformat.html)[QTextBlockFormat](qtextblockformat.html)描述塊特定的屬性。 **See also** [charFormat](qtextblock.html#charFormat)（）。 ``` int QTextBlock.blockFormatIndex (self) ``` 返回一個索引到文檔內部的塊格式的文本塊的格式列表。 **See also** [QTextDocument.allFormats](qtextdocument.html#allFormats)（）。 ``` int QTextBlock.blockNumber (self) ``` 返回此塊的數量，或-1，如果塊是無效的。此功能被引入Qt的4.4 。 **See also** [QTextCursor.blockNumber](qtextcursor.html#blockNumber)（）。 ``` QTextCharFormat QTextBlock.charFormat (self) ``` [](qtextcharformat.html) [返回](qtextcharformat.html)[QTextCharFormat](qtextcharformat.html)描述塊的字符格式。插入文本到一個空的塊時，塊的字符格式。 **See also** [blockFormat](qtextblock.html#blockFormat)（）。 ``` int QTextBlock.charFormatIndex (self) ``` 返回一個索引到文檔內部的字符格式的文本塊的字符格式列表。 **See also** [QTextDocument.allFormats](qtextdocument.html#allFormats)（）。 ``` QTextBlock.clearLayout (self) ``` 清除[QTextLayout](qtextlayout.html)用來布局和顯示模塊的內容。此功能被引入Qt的4.4 。 **See also** [layout](qtextblock.html#layout)（）。 ``` bool QTextBlock.contains (self, int?position) ``` 返回True如果給定的_position_位于文本塊中，否則返回False 。 ``` QTextDocument QTextBlock.document (self) ``` [ 返回該文本塊屬于文本文件，或者0，如果該文本塊不屬于任何文件。 ](qtextdocument.html) ``` iterator QTextBlock.end (self) ``` [ 返回一個文本塊迭代器，指向文本塊的結尾。 ](index.htm) [**See also**](index.htm) [begin](qtextblock.html#begin)（）[next](qtextblock.html#next)（）和[previous](qtextblock.html#previous)（）。 ``` int QTextBlock.firstLineNumber (self) ``` 返回該塊的第一行號，或-1，如果該塊是無效的。除非布局支持它，行號是相同的塊數。此功能被引入Qt的4.5 。 **See also** [QTextBlock.blockNumber](qtextblock.html#blockNumber)（）。 ``` bool QTextBlock.isValid (self) ``` 返回True如果該文本塊是有效的，否則返回False 。 ``` bool QTextBlock.isVisible (self) ``` 返回True如果該塊是可見的，否則返回False 。此功能被引入Qt的4.4 。 **See also** [setVisible](qtextblock.html#setVisible)（）。 ``` QTextLayout QTextBlock.layout (self) ``` [](qtextlayout.html) [返回](qtextlayout.html)[QTextLayout](qtextlayout.html)用來布局和顯示模塊的內容。注意，返回[QTextLayout](qtextlayout.html)對象只能從documentChanged實現的一種變型[QAbstractTextDocumentLayout](qabstracttextdocumentlayout.html)子類。從外部原因未定義的行為施加的任何更改。 **See also** [clearLayout](qtextblock.html#clearLayout)（）。 ``` int QTextBlock.length (self) ``` 返回字符的塊的長度。 **Note:**返回的長度包括所有格式的字符，例如，換行符。 **See also** [text](qtextblock.html#text)（）[charFormat](qtextblock.html#charFormat)（）和[blockFormat](qtextblock.html#blockFormat)（）。 ``` int QTextBlock.lineCount (self) ``` 返回的行數。不是所有的文件布局支持此功能。此功能被引入Qt的4.5 。 **See also** [setLineCount](qtextblock.html#setLineCount)（）。 ``` QTextBlock QTextBlock.next (self) ``` [ 返回文檔中的文本塊這個塊后，或者一個空的文本塊，如果這是最后一個。注意，下一個塊可以是在不同的幀或表本塊。 ](qtextblock.html) [**See also**](qtextblock.html) [previous](qtextblock.html#previous)（）[begin](qtextblock.html#begin)（）和[end](qtextblock.html#end)（）。 ``` int QTextBlock.position (self) ``` 返回的文檔內的塊的第一個字符的索引。 ``` QTextBlock QTextBlock.previous (self) ``` [ 返回文檔中的文本塊這個塊之前，或者一個空的文本塊，如果這是第一個。注意，下一個塊可以是在不同的幀或表本塊。 ](qtextblock.html) [**See also**](qtextblock.html) [next](qtextblock.html#next)（）[begin](qtextblock.html#begin)（）和[end](qtextblock.html#end)（）。 ``` int QTextBlock.revision (self) ``` 返回的塊版本。此功能被引入Qt的4.4 。 **See also** [setRevision](qtextblock.html#setRevision)（）和[QTextDocument.revision](qtextdocument.html#revision)（）。 ``` QTextBlock.setLineCount (self, int?count) ``` 設置行計數_count_。此功能被引入Qt的4.5 。 **See also** [lineCount](qtextblock.html#lineCount)（）。 ``` QTextBlock.setRevision (self, int?rev) ``` 設置一個塊修訂_rev_。此功能被引入Qt的4.4 。 **See also** [revision](qtextblock.html#revision)（）和[QTextDocument.revision](qtextdocument.html#revision)（）。 ``` QTextBlock.setUserData (self, QTextBlockUserData?data) ``` 重視給定的_data_反對的文本塊。 [QTextBlockUserData](qtextblockuserdata.html)可以用來存儲自定義設置。所有權被傳遞到下面的文本文件，即提供[QTextBlockUserData](qtextblockuserdata.html)如果相應的文本塊被刪除的對象將被刪除。用戶數據對象未存儲在還原歷史，所以撤消刪除的文本塊后，將無法使用。例如，如果你寫了一個程序編輯器中的IDE ，你可能想讓你的用戶設置斷點視覺代碼中的一個集成的調試器。在程序編輯器的文本行通常對應于一個[QTextBlock](qtextblock.html)。該[QTextBlockUserData](qtextblockuserdata.html)接口允許開發者存儲數據的每個[QTextBlock](qtextblock.html)一樣，例如在其中的源代碼行的用戶有一個斷點集。當然，這也可以被存儲在外部，但是通過將其存儲在內部[QTextDocument](qtextdocument.html)，將例如自動當用戶刪除與其相關的行刪除。這真的只是一種方法，在存儲自定義信息[QTextDocument](qtextdocument.html)在不使用自定義屬性[QTextFormat](qtextformat.html)這會影響撤銷/重做堆棧。這個函數是Qt 4.1中引入。 **See also** [userData](qtextblock.html#userData)（）。 ``` QTextBlock.setUserState (self, int?state) ``` 在指定的商店_state_在文本塊的整數值。這可能是有用的，例如在一個語法高亮顯示來存儲文本解析狀態。這個函數是Qt 4.1中引入。 **See also** [userState](qtextblock.html#userState)（）。 ``` QTextBlock.setVisible (self, bool?visible) ``` 設置塊的可見性_visible_。此功能被引入Qt的4.4 。 **See also** [isVisible](qtextblock.html#isVisible)（）。 ``` QString QTextBlock.text (self) ``` 返回塊的內容為純文本。 **See also** [length](qtextblock.html#length)（）[charFormat](qtextblock.html#charFormat)（）和[blockFormat](qtextblock.html#blockFormat)（）。 ``` Qt.LayoutDirection QTextBlock.textDirection (self) ``` [ 返回解析文字方向。 ](qt.html#LayoutDirection-enum) [如果塊沒有明確的方向設置，它會從塊內容解決的方向。要么返回](qt.html#LayoutDirection-enum)[Qt.LeftToRight](qt.html#LayoutDirection-enum) or [Qt.RightToLeft](qt.html#LayoutDirection-enum)。此功能被引入Qt的4.7 。 **See also** [QTextFormat.layoutDirection](qtextformat.html#layoutDirection)（）[QString.isRightToLeft](qstring.html#isRightToLeft)（）和[Qt.LayoutDirection](qt.html#LayoutDirection-enum)。 ``` QTextList QTextBlock.textList (self) ``` [ 如果塊代表一個列表項，則返回該項目所屬的列表，否則返回0 。 ](qtextlist.html) ``` QTextBlockUserData QTextBlock.userData (self) ``` [](qtextblockuserdata.html) [返回一個指針，指向一個](qtextblockuserdata.html)[QTextBlockUserData](qtextblockuserdata.html)如果以前設置與對象[setUserData](qtextblock.html#setUserData)（）或一個空指針。這個函數是Qt 4.1中引入。 **See also** [setUserData](qtextblock.html#setUserData)（）。 ``` int QTextBlock.userState (self) ``` 返回以前設置的整數值[setUserState](qtextblock.html#setUserState)（）或-1。這個函數是Qt 4.1中引入。 **See also** [setUserState](qtextblock.html#setUserState)（）。 ``` bool QTextBlock.__eq__ (self, QTextBlock?o) ``` ``` bool QTextBlock.__ge__ (self, QTextBlock?o) ``` ``` bool QTextBlock.__lt__ (self, QTextBlock?o) ``` ``` bool QTextBlock.__ne__ (self, QTextBlock?o) ```