Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions | ![]() |
The QTextBlock class provides a container for text fragments in a QTextDocument. More...
#include <QTextBlock>
The QTextBlock class provides a container for text fragments in a QTextDocument.
A QTextBlock is an object that 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 the contents in your own custom format.
Text blocks are created by their parent documents. If you need to create a new text block, use the cursor-based interface provided by QTextCursor.
Each text block is located at a specific position() in a 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().
The next() and previous() functions allow navigation between blocks within the document. Note that blocks are returned in sequence, so adjacent blocks may come from different places in the document structure.
See also QTextBlockFormat, QTextCharFormat, and QTextFragment.
Qt-style synonym for QTextBlock::iterator.
Copies the other text block's attributes to this text block.
Returns a text block iterator pointing to the beginning of the text block.
See also end().
Returns the QTextBlockFormat that describes block-specific properties.
See also charFormat().
Returns the QTextCharFormat that describes the block's character format. This is mainly used to draw block-specific additions such as e.g. list markers.
See also blockFormat().
Returns true if the given position is located within the text block; otherwise returns false.
Returns the text document this text block belongs to, or 0 if the text block does not belong to any document.
Returns a text block iterator pointing to the end of the text block.
See also begin(), next(), and previous().
Returns true if this text block is valid; otherwise returns false.
Returns the QTextLayout that is used to lay out and display the block's contents.
Returns the length of the block in characters.
See also text(), charFormat(), and blockFormat().
Returns the text block in the document after this block, or an empty text block if this is the last one.
Note that the next block may be in a different frame or table to this block.
See also previous(), begin(), and end().
Returns the starting position of the block within the document.
Returns the text block in the document before this block, or an empty text block if this is the first one.
Note that the next block may be in a different frame or table to this block.
See also next(), begin(), and end().
Returns the block's contents as plain text.
See also length(), charFormat(), and blockFormat().
Returns true if this text block is different from the other text block.
Returns true if this text block occurs before the other text block in the document.
Assigns the other text block to this text block.
Returns true if this text block is the same as the other text block.
Copyright © 2004 Trolltech. | Trademarks | Qt 4.0.0-tp2 |