QAbstractTextDocumentLayout Class Reference · PyQt4 中文文檔

# QAbstractTextDocumentLayout Class Reference ## [[QtGui](index.htm) module] 該QAbstractTextDocumentLayout類是用于實現自定義布局QTextDocuments的抽象基類。[More...](#details) 繼承[QObject](qobject.html)。通過繼承[QPlainTextDocumentLayout](qplaintextdocumentlayout.html)。 ### Types * `class **[PaintContext](index.htm)**` * `class **[Selection](index.htm)**` ### Methods * `__init__ (self, QTextDocument?doc)` * `QString anchorAt (self, QPointF?pos)` * `QRectF blockBoundingRect (self, QTextBlock?block)` * `QTextDocument document (self)` * `documentChanged (self, int?from, int?charsRemoved, int?charsAdded)` * `QSizeF documentSize (self)` * `draw (self, QPainter?painter, PaintContext?context)` * `drawInlineObject (self, QPainter?painter, QRectF?rect, QTextInlineObject?object, int?posInDocument, QTextFormat?format)` * `QTextCharFormat format (self, int?pos)` * `QRectF frameBoundingRect (self, QTextFrame?frame)` * `QTextObjectInterface handlerForObject (self, int?objectType)` * `int hitTest (self, QPointF?point, Qt.HitTestAccuracy?accuracy)` * `int pageCount (self)` * `QPaintDevice paintDevice (self)` * `positionInlineObject (self, QTextInlineObject?item, int?posInDocument, QTextFormat?format)` * `registerHandler (self, int?objectType, QObject?component)` * `resizeInlineObject (self, QTextInlineObject?item, int?posInDocument, QTextFormat?format)` * `setPaintDevice (self, QPaintDevice?device)` ### Qt Signals * `void documentSizeChanged (const QSizeF&)` * `void pageCountChanged (int)` * `void update (const QRectF& = QRectF(0,0,1e+09,1e+09))` * `void updateBlock (const QTextBlock&)` * * * ## Detailed Description 該QAbstractTextDocumentLayout類是用于實現自定義布局QTextDocuments的抽象基類。 Qt提供了標準布局可以處理簡單的文字處理，包括內嵌圖片，列表和表格。有些應用程序，如文字處理器或DTP應用程序可能需要比Qt的布局引擎提供的，那些更多的功能，在這種情況下，你可以繼承QAbstractTextDocumentLayout為您的文本文檔提供自定義布局行為。該QAbstractTextDocumentLayout子類的實例可以在安裝[QTextDocument](qtextdocument.html)與對象[setDocumentLayout()](qtextdocument.html#setDocumentLayout)功能。您可以將自定義對象成[QTextDocument](qtextdocument.html)，見[QTextObjectInterface](qtextobjectinterface.html)類描述的細節。 * * * ## Method Documentation ``` QAbstractTextDocumentLayout.__init__ (self, QTextDocument?doc) ``` 創建用于指定一個新的文本文檔布局_document_。 ``` QString QAbstractTextDocumentLayout.anchorAt (self, QPointF?pos) ``` 返回錨的參考給定的_position_，或者如果沒有錨存在于該點一個空字符串。 ``` QRectF QAbstractTextDocumentLayout.blockBoundingRect (self, QTextBlock?block) ``` [ 這種方法是抽象的，應在任何子類中重新實現。返回的邊框_block_。 ](qrectf.html) ``` QTextDocument QAbstractTextDocumentLayout.document (self) ``` [ 返回此布局工作于文本文檔。 ``` QAbstractTextDocumentLayout.documentChanged (self, int?from, int?charsRemoved, int?charsAdded) ``` 這種方法是抽象的，應在任何子類中重新實現。此功能被稱為文檔變化時的內容。當文本被插入，刪除時，會發生變化，或這兩種的組合。這種變化是通過指定_position_，_charsRemoved_和_charsAdded_對應于該變化的開始字符的位置，從文檔中刪除的字符數，和字符的數量加入。例如，進入一個空文檔中插入文本“Hello ”時，_charsRemoved_將0和_charsAdded_將5（該字符串的長度）。替換文本是刪除和插入的組合。例如，如果文本“Hello ”被替換為“Hi” ，_charsRemoved_將是5和_charsAdded_將2 。 ](qtextdocument.html) [對于子類](qtextdocument.html)[QAbstractTextDocumentLayout](qabstracttextdocumentlayout.html)，這是中央函數所在的工作的很大一部分來布置和位置文件的內容已經完成。例如，在一個子類，只安排文本塊，這個功能的實現就必須做到以下幾點： * Determine the list of changed [QTextBlock](qtextblock.html)(s) using the parameters provided. * Each [QTextBlock](qtextblock.html) object's corresponding [QTextLayout](qtextlayout.html) object needs to be processed. You can access the [QTextBlock](qtextblock.html)'s layout using the [QTextBlock.layout](qtextblock.html#layout)() function. This processing should take the document's page size into consideration. * If the total number of pages changed, the [pageCountChanged](qabstracttextdocumentlayout.html#pageCountChanged)() signal should be emitted. * If the total size changed, the [documentSizeChanged](qabstracttextdocumentlayout.html#documentSizeChanged)() signal should be emitted. * The [update](qabstracttextdocumentlayout.html#update)() signal should be emitted to schedule a repaint of areas in the layout that require repainting. **See also** [QTextLayout](qtextlayout.html)。 ``` QSizeF QAbstractTextDocumentLayout.documentSize (self) ``` [ 這種方法是抽象的，應在任何子類中重新實現。返回文檔的布局的總大小。這些信息可用于顯示部件來正確地更新自己的滾動條。 ](qsizef.html) [**See also**](qsizef.html) [documentSizeChanged](qabstracttextdocumentlayout.html#documentSizeChanged)（）和[QTextDocument.pageSize](qtextdocument.html#pageSize-prop)。 ``` QAbstractTextDocumentLayout.draw (self, QPainter?painter, PaintContext?context) ``` 這種方法是抽象的，應在任何子類中重新實現。繪制布局與給定的_painter_使用給定的_context_。 ``` QAbstractTextDocumentLayout.drawInlineObject (self, QPainter?painter, QRectF?rect, QTextInlineObject?object, int?posInDocument, QTextFormat?format) ``` 調用此函數繪制內嵌的對象，_object_用給定的_painter_由指定的矩形內_rect_使用指定的文本_format_。 _posInDocument_指定文件內的對象的位置。默認實現調用drawObject （）上的對象處理程序。這個函數被調用只在Qt的。子類可以重新實現此功能自定義內聯對象的繪制。 **See also** [draw](qabstracttextdocumentlayout.html#draw)（）。 ``` QTextCharFormat QAbstractTextDocumentLayout.format (self, int?pos) ``` [ 返回字符格式，適用于給定的_position_。 ](qtextcharformat.html) ``` QRectF QAbstractTextDocumentLayout.frameBoundingRect (self, QTextFrame?frame) ``` [ 這種方法是抽象的，應在任何子類中重新實現。返回的邊框_frame_。 ](qrectf.html) ``` QTextObjectInterface QAbstractTextDocumentLayout.handlerForObject (self, int?objectType) ``` [ 返回一個處理程序的特定對象_objectType_。 ``` int QAbstractTextDocumentLayout.hitTest (self, QPointF?point, Qt.HitTestAccuracy?accuracy) ``` 這種方法是抽象的，應在任何子類中重新實現。返回光標當前位置為給定的_point_用指定的_accuracy_。返回-1，如果沒有有效的光標位置被發現。 ``` int QAbstractTextDocumentLayout.pageCount (self) ``` 這種方法是抽象的，應在任何子類中重新實現。返回中所包含的布局的頁面數。 ](qtextobjectinterface.html) [**See also**](qtextobjectinterface.html) [pageCountChanged](qabstracttextdocumentlayout.html#pageCountChanged)（）。 ``` QPaintDevice QAbstractTextDocumentLayout.paintDevice (self) ``` [ 返回用于呈現文檔的布局繪制設備。 ](qpaintdevice.html) [**See also**](qpaintdevice.html) [setPaintDevice](qabstracttextdocumentlayout.html#setPaintDevice)（）。 ``` QAbstractTextDocumentLayout.positionInlineObject (self, QTextInlineObject?item, int?posInDocument, QTextFormat?format) ``` 勾畫出嵌入對象_item_使用給定的文本_format_。 _posInDocument_指定文件內的對象的位置。默認實現不執行任何操作。這個函數被調用只在Qt的。子類可以重新實現此功能自定義內聯對象的位置。 **See also** [drawInlineObject](qabstracttextdocumentlayout.html#drawInlineObject)（）。 ``` QAbstractTextDocumentLayout.registerHandler (self, int?objectType, QObject?component) ``` 注冊給定的_component_作為一個處理程序的特定項目_objectType_。 **Note:**registerHandler （）為每個對象類型被調用一次。這意味著，只有一個對相同的對象類型的多個字符替換處理程序。 ``` QAbstractTextDocumentLayout.resizeInlineObject (self, QTextInlineObject?item, int?posInDocument, QTextFormat?format) ``` 設置內嵌對象的大小_item_對應于文本_format_。 _posInDocument_指定文件內的對象的位置。默認實現調整大小的_item_由對象處理程序的intrinsicSize （）函數返回的大小。這個函數被調用只在Qt的。子類可以重新實現此功能自定義內聯對象的大小調整。 ``` QAbstractTextDocumentLayout.setPaintDevice (self, QPaintDevice?device) ``` 獲取用于渲染文檔的布局，以給定的涂料設備_device_。 **See also** [paintDevice](qabstracttextdocumentlayout.html#paintDevice)（）。 * * * ## Qt Signal Documentation ``` void documentSizeChanged (const QSizeF&) ``` 這是該信號的默認超載。當文檔布局的大小變更為這個信號被發射_newSize_。的子類[QAbstractTextDocumentLayout](qabstracttextdocumentlayout.html)應該發出這個信號，當文檔的整個版面大小的變化。這個信號是顯示文本文件，因為它使他們能夠正確地更新自己的滾動條小工具非常有用。 **See also** [documentSize](qabstracttextdocumentlayout.html#documentSize)（）。 ``` void pageCountChanged (int) ``` 這是該信號的默認超載。這個信號被發射時的布局變化的頁數;_newPages_是更新頁面計數。的子類[QAbstractTextDocumentLayout](qabstracttextdocumentlayout.html)應該發出這個信號時的布局中的頁面的數量發生了變化。被改變的頁面數通過改變布局或文件內容本身引起的。 **See also** [pageCount](qabstracttextdocumentlayout.html#pageCount)（）。 ``` void update (const QRectF& = QRectF (0,0,1e+09,1e+09)) ``` 這是該信號的默認超載。這個信號被發射時，矩形_rect_已被更新。的子類[QAbstractTextDocumentLayout](qabstracttextdocumentlayout.html)應該發出這個信號，當內容的布局改變，以重新繪制。 ``` void updateBlock (const QTextBlock&) ``` 這是該信號的默認超載。指定時，這個信號被發射_block_已被更新。的子類[QAbstractTextDocumentLayout](qabstracttextdocumentlayout.html)應該發出這個信號時的布局_block_為了重新繪制了變化。此功能被引入Qt的4.4 。