The QTextBlockFormat class provides formatting information for blocks of text in a QTextDocument. More...
| Header: | #include <QTextBlockFormat> |
| qmake: | QT += gui |
| Inherits: | QTextFormat |
Note: All functions in this class are reentrant.
| enum | LineHeightTypes { SingleHeight, ProportionalHeight, FixedHeight, MinimumHeight, LineDistanceHeight } |
| QTextBlockFormat() | |
| Qt::Alignment | alignment() const |
| qreal | bottomMargin() const |
| int | indent() const |
| bool | isValid() const |
| qreal | leftMargin() const |
| qreal | lineHeight(qreal scriptLineHeight, qreal scaling = 1.0) const |
| qreal | lineHeight() const |
| int | lineHeightType() const |
| bool | nonBreakableLines() const |
| QTextFormat::PageBreakFlags | pageBreakPolicy() const |
| qreal | rightMargin() const |
| void | setAlignment(Qt::Alignment alignment) |
| void | setBottomMargin(qreal margin) |
| void | setIndent(int indentation) |
| void | setLeftMargin(qreal margin) |
| void | setLineHeight(qreal height, int heightType) |
| void | setNonBreakableLines(bool b) |
| void | setPageBreakPolicy(QTextFormat::PageBreakFlags policy) |
| void | setRightMargin(qreal margin) |
| void | setTabPositions(const QList<QTextOption::Tab> &tabs) |
| void | setTextIndent(qreal indent) |
| void | setTopMargin(qreal margin) |
| QList<QTextOption::Tab> | tabPositions() const |
| qreal | textIndent() const |
| qreal | topMargin() const |
The QTextBlockFormat class provides formatting information for blocks of text in a QTextDocument.
A document is composed of a list of blocks, represented by QTextBlock objects. Each block can contain an item of some kind, such as a paragraph of text, a table, a list, or an image. Every block has an associated QTextBlockFormat that specifies its characteristics.
To cater for left-to-right and right-to-left languages you can set a block's direction with setDirection(). Paragraph alignment is set with setAlignment(). Margins are controlled by setTopMargin(), setBottomMargin(), setLeftMargin(), setRightMargin(). Overall indentation is set with setIndent(), the indentation of the first line with setTextIndent().
Line spacing is set with setLineHeight() and retrieved via lineHeight() and lineHeightType(). The types of line spacing available are in the LineHeightTypes enum.
Line breaking can be enabled and disabled with setNonBreakableLines().
The brush used to paint the paragraph's background is set with setBackground(), and other aspects of the text's appearance can be customized by using the setProperty() function with the OutlinePen, ForegroundBrush, and BackgroundBrush QTextFormat::Property values.
If a text block is part of a list, it can also have a list format that is accessible with the listFormat() function.
See also QTextBlock and QTextCharFormat.
This enum describes the various types of line spacing support paragraphs can have.
| Constant | Value | Description |
|---|---|---|
QTextBlockFormat::SingleHeight |
0 |
This is the default line height: single spacing. |
QTextBlockFormat::ProportionalHeight |
1 |
This sets the spacing proportional to the line (in percentage). For example, set to 200 for double spacing. |
QTextBlockFormat::FixedHeight |
2 |
This sets the line height to a fixed line height (in pixels). |
QTextBlockFormat::MinimumHeight |
3 |
This sets the minimum line height (in pixels). |
QTextBlockFormat::LineDistanceHeight |
4 |
This adds the specified height between lines (in pixels). |
This enum was introduced or modified in Qt 4.8.
See also lineHeight(), lineHeightType(), and setLineHeight().
Constructs a new QTextBlockFormat.
Returns the paragraph's alignment.
See also setAlignment().
Returns the paragraph's bottom margin.
See also setBottomMargin() and topMargin().
Returns the paragraph's indent.
See also setIndent().
Returns true if this block format is valid; otherwise returns false.
Returns the paragraph's left margin.
See also setLeftMargin(), rightMargin(), and indent().
Returns the height of the lines in the paragraph based on the height of the script line given by scriptLineHeight and the specified scaling factor.
The value that is returned is also dependent on the given LineHeightType of the paragraph as well as the LineHeight setting that has been set for the paragraph.
The scaling is needed for heights that include a fixed number of pixels, to scale them appropriately for printing.
This function was introduced in Qt 4.8.
See also LineHeightTypes, setLineHeight(), and lineHeightType().
This returns the LineHeight property for the paragraph.
This function was introduced in Qt 4.8.
See also LineHeightTypes, setLineHeight(), and lineHeightType().
This returns the LineHeightType property of the paragraph.
This function was introduced in Qt 4.8.
See also LineHeightTypes, setLineHeight(), and lineHeight().
Returns true if the lines in the paragraph are non-breakable; otherwise returns false.
See also setNonBreakableLines().
Returns the currently set page break policy for the paragraph. The default is QTextFormat::PageBreak_Auto.
This function was introduced in Qt 4.2.
See also setPageBreakPolicy().
Returns the paragraph's right margin.
See also setRightMargin() and leftMargin().
Sets the paragraph's alignment.
See also alignment().
Sets the paragraph's bottom margin.
See also bottomMargin(), setTopMargin(), setLeftMargin(), and setRightMargin().
Sets the paragraph's indentation. Margins are set independently of indentation with setLeftMargin() and setTextIndent(). The indentation is an integer that is multiplied with the document-wide standard indent, resulting in the actual indent of the paragraph.
See also indent() and QTextDocument::indentWidth().
Sets the paragraph's left margin. Indentation can be applied separately with setIndent().
See also leftMargin(), setRightMargin(), setTopMargin(), and setBottomMargin().
Sets the line height for the paragraph to the value given by height which is dependent on heightType in the way described by the LineHeightTypes enum.
This function was introduced in Qt 4.8.
See also LineHeightTypes, lineHeight(), and lineHeightType().
If b is true, the lines in the paragraph are treated as non-breakable; otherwise they are breakable.
See also nonBreakableLines().
Sets the page break policy for the paragraph to policy.
This function was introduced in Qt 4.2.
See also pageBreakPolicy().
Sets the paragraph's right margin.
See also rightMargin(), setLeftMargin(), setTopMargin(), and setBottomMargin().
Sets the tab positions for the text block to those specified by tabs.
This function was introduced in Qt 4.4.
See also tabPositions().
Sets the indent for the first line in the block. This allows the first line of a paragraph to be indented differently to the other lines, enhancing the readability of the text.
See also textIndent(), setLeftMargin(), setRightMargin(), setTopMargin(), and setBottomMargin().
Sets the paragraph's top margin.
See also topMargin(), setBottomMargin(), setLeftMargin(), and setRightMargin().
Returns a list of tab positions defined for the text block.
This function was introduced in Qt 4.4.
See also setTabPositions().
Returns the paragraph's text indent.
See also setTextIndent().
Returns the paragraph's top margin.
See also setTopMargin() and bottomMargin().
