<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /tmp/qt-4.2.1-harald-1161357942206/qt-x11-opensource-src-4.2.1/src/gui/text/qtextformat.cpp -->
<head>
<title>Qt 4.2: QTextFormat Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QTextFormat Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1>
<p>The QTextFormat class provides formatting information for a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<pre> #include <QTextFormat></pre><p>Inherited by <a href="qtextblockformat.html">QTextBlockFormat</a>, <a href="qtextcharformat.html">QTextCharFormat</a>, <a href="qtextframeformat.html">QTextFrameFormat</a>, and <a href="qtextlistformat.html">QTextListFormat</a>.</p>
<ul>
<li><a href="qtextformat-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h3>Public Types</h3>
<ul>
<li><div class="fn"/>enum <b><a href="qtextformat.html#FormatType-enum">FormatType</a></b> { InvalidFormat, BlockFormat, CharFormat, ListFormat, ..., UserFormat }</li>
<li><div class="fn"/>enum <b><a href="qtextformat.html#ObjectTypes-enum">ObjectTypes</a></b> { NoObject, ImageObject, TableObject, UserObject }</li>
<li><div class="fn"/>enum <b><a href="qtextformat.html#PageBreakFlag-enum">PageBreakFlag</a></b> { PageBreak_Auto, PageBreak_AlwaysBefore, PageBreak_AlwaysAfter }</li>
<li><div class="fn"/>flags <b><a href="qtextformat.html#PageBreakFlag-enum">PageBreakFlags</a></b></li>
<li><div class="fn"/>enum <b><a href="qtextformat.html#Property-enum">Property</a></b> { ObjectIndex, CssFloat, LayoutDirection, OutlinePen, ..., UserProperty }</li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qtextformat.html#QTextFormat">QTextFormat</a></b> ()</li>
<li><div class="fn"/><b><a href="qtextformat.html#QTextFormat-2">QTextFormat</a></b> ( int <i>type</i> )</li>
<li><div class="fn"/><b><a href="qtextformat.html#QTextFormat-3">QTextFormat</a></b> ( const QTextFormat & <i>other</i> )</li>
<li><div class="fn"/><b><a href="qtextformat.html#dtor.QTextFormat">~QTextFormat</a></b> ()</li>
<li><div class="fn"/>QBrush <b><a href="qtextformat.html#background">background</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#boolProperty">boolProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>QBrush <b><a href="qtextformat.html#brushProperty">brushProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#clearBackground">clearBackground</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#clearForeground">clearForeground</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#clearProperty">clearProperty</a></b> ( int <i>propertyId</i> )</li>
<li><div class="fn"/>QColor <b><a href="qtextformat.html#colorProperty">colorProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>qreal <b><a href="qtextformat.html#doubleProperty">doubleProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>QBrush <b><a href="qtextformat.html#foreground">foreground</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#hasProperty">hasProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>int <b><a href="qtextformat.html#intProperty">intProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#isBlockFormat">isBlockFormat</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#isCharFormat">isCharFormat</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#isFrameFormat">isFrameFormat</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#isImageFormat">isImageFormat</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#isListFormat">isListFormat</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#isTableFormat">isTableFormat</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#isValid">isValid</a></b> () const</li>
<li><div class="fn"/>Qt::LayoutDirection <b><a href="qtextformat.html#layoutDirection">layoutDirection</a></b> () const</li>
<li><div class="fn"/>QTextLength <b><a href="qtextformat.html#lengthProperty">lengthProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>QVector<QTextLength> <b><a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#merge">merge</a></b> ( const QTextFormat & <i>other</i> )</li>
<li><div class="fn"/>int <b><a href="qtextformat.html#objectIndex">objectIndex</a></b> () const</li>
<li><div class="fn"/>int <b><a href="qtextformat.html#objectType">objectType</a></b> () const</li>
<li><div class="fn"/>QPen <b><a href="qtextformat.html#penProperty">penProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>QMap<int, QVariant> <b><a href="qtextformat.html#properties">properties</a></b> () const</li>
<li><div class="fn"/>QVariant <b><a href="qtextformat.html#property">property</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#setBackground">setBackground</a></b> ( const QBrush & <i>brush</i> )</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#setForeground">setForeground</a></b> ( const QBrush & <i>brush</i> )</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#setLayoutDirection">setLayoutDirection</a></b> ( Qt::LayoutDirection <i>direction</i> )</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#setObjectIndex">setObjectIndex</a></b> ( int <i>index</i> )</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#setObjectType">setObjectType</a></b> ( int <i>type</i> )</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#setProperty">setProperty</a></b> ( int <i>propertyId</i>, const QVariant & <i>value</i> )</li>
<li><div class="fn"/>void <b><a href="qtextformat.html#setProperty-2">setProperty</a></b> ( int <i>propertyId</i>, const QVector<QTextLength> & <i>value</i> )</li>
<li><div class="fn"/>QString <b><a href="qtextformat.html#stringProperty">stringProperty</a></b> ( int <i>propertyId</i> ) const</li>
<li><div class="fn"/>QTextBlockFormat <b><a href="qtextformat.html#toBlockFormat">toBlockFormat</a></b> () const</li>
<li><div class="fn"/>QTextCharFormat <b><a href="qtextformat.html#toCharFormat">toCharFormat</a></b> () const</li>
<li><div class="fn"/>QTextFrameFormat <b><a href="qtextformat.html#toFrameFormat">toFrameFormat</a></b> () const</li>
<li><div class="fn"/>QTextImageFormat <b><a href="qtextformat.html#toImageFormat">toImageFormat</a></b> () const</li>
<li><div class="fn"/>QTextListFormat <b><a href="qtextformat.html#toListFormat">toListFormat</a></b> () const</li>
<li><div class="fn"/>QTextTableFormat <b><a href="qtextformat.html#toTableFormat">toTableFormat</a></b> () const</li>
<li><div class="fn"/>int <b><a href="qtextformat.html#type">type</a></b> () const</li>
<li><div class="fn"/><b><a href="qtextformat.html#operator-QVariant">operator QVariant</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#operator-not-eq">operator!=</a></b> ( const QTextFormat & <i>other</i> ) const</li>
<li><div class="fn"/>QTextFormat & <b><a href="qtextformat.html#operator-eq">operator=</a></b> ( const QTextFormat & <i>other</i> )</li>
<li><div class="fn"/>bool <b><a href="qtextformat.html#operator-eq-eq">operator==</a></b> ( const QTextFormat & <i>other</i> ) const</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QTextFormat class provides formatting information for a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>A QTextFormat is a generic class used for describing the format of parts of a <a href="qtextdocument.html">QTextDocument</a>. The derived classes <a href="qtextcharformat.html">QTextCharFormat</a>, <a href="qtextblockformat.html">QTextBlockFormat</a>, <a href="qtextlistformat.html">QTextListFormat</a>, and <a href="qtexttableformat.html">QTextTableFormat</a> are usually more useful, and describe the formatting that is applied to specific parts of the document.</p>
<p>A format has a <tt>FormatType</tt> which specifies the kinds of thing it can format; e.g. a block of text, a list, a table, etc. A format also has various properties (some specific to particular format types), as described by the Property enum. Every property has a corresponding Property.</p>
<p>The format type is given by <a href="qtextformat.html#type">type</a>(), and the format can be tested with <a href="qtextformat.html#isCharFormat">isCharFormat</a>(), <a href="qtextformat.html#isBlockFormat">isBlockFormat</a>(), <a href="qtextformat.html#isListFormat">isListFormat</a>(), <a href="qtextformat.html#isTableFormat">isTableFormat</a>(), <a href="qtextformat.html#isFrameFormat">isFrameFormat</a>(), and <a href="qtextformat.html#isImageFormat">isImageFormat</a>(). If the type is determined, it can be retrieved with <a href="qtextformat.html#toCharFormat">toCharFormat</a>(), <a href="qtextformat.html#toBlockFormat">toBlockFormat</a>(), <a href="qtextformat.html#toListFormat">toListFormat</a>(), <a href="qtextformat.html#toTableFormat">toTableFormat</a>(), <a href="qtextformat.html#toFrameFormat">toFrameFormat</a>(), and <a href="qtextformat.html#toImageFormat">toImageFormat</a>().</p>
<p>A format's properties can be set with the <a href="qtextformat.html#setProperty">setProperty</a>() functions, and retrieved with <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), and <a href="qtextformat.html#stringProperty">stringProperty</a>() as appropriate. All the property IDs used in the format can be retrieved with allPropertyIds(). One format can be merged into another using <a href="qtextformat.html#merge">merge</a>().</p>
<p>A format's object index can be set with <a href="qtextformat.html#setObjectIndex">setObjectIndex</a>(), and retrieved with <a href="qtextformat.html#objectIndex">objectIndex</a>(). These methods can be used to associate the format with a <a href="qtextobject.html">QTextObject</a>. It is used to represent lists, frames, and tables inside the document.</p>
<p>See also <a href="text.html">Text Related Classes</a>.</p>
<hr />
<h2>Member Type Documentation</h2>
<h3 class="fn"><a name="FormatType-enum"></a>enum QTextFormat::FormatType</h3>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::InvalidFormat</tt></td><td align="center" valign="top"><tt>-1</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockFormat</tt></td><td align="center" valign="top"><tt>1</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::CharFormat</tt></td><td align="center" valign="top"><tt>2</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::ListFormat</tt></td><td align="center" valign="top"><tt>3</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TableFormat</tt></td><td align="center" valign="top"><tt>4</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FrameFormat</tt></td><td align="center" valign="top"><tt>5</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::UserFormat</tt></td><td align="center" valign="top"><tt>100</tt></td></tr>
</table></p>
<h3 class="fn"><a name="ObjectTypes-enum"></a>enum QTextFormat::ObjectTypes</h3>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QTextFormat::NoObject</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top"> </td></tr>
<tr><td valign="top"><tt>QTextFormat::ImageObject</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top"> </td></tr>
<tr><td valign="top"><tt>QTextFormat::TableObject</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top"> </td></tr>
<tr><td valign="top"><tt>QTextFormat::UserObject</tt></td><td align="center" valign="top"><tt>0x1000</tt></td><td valign="top">The first object that can be used for application-specific purposes.</td></tr>
</table></p>
<h3 class="flags"><a name="PageBreakFlag-enum"></a>enum QTextFormat::PageBreakFlag<br />flags QTextFormat::PageBreakFlags</h3>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QTextFormat::PageBreak_Auto</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">The page break is determined automatically depending on the available space on the current page</td></tr>
<tr><td valign="top"><tt>QTextFormat::PageBreak_AlwaysBefore</tt></td><td align="center" valign="top"><tt>0x001</tt></td><td valign="top">The page is always broken before the paragraph/table</td></tr>
<tr><td valign="top"><tt>QTextFormat::PageBreak_AlwaysAfter</tt></td><td align="center" valign="top"><tt>0x010</tt></td><td valign="top">A new page is always started after the paragraph/table</td></tr>
</table></p>
<p>This enum was introduced in Qt 4.2.</p>
<p>The PageBreakFlags type is a typedef for <a href="qflags.html">QFlags</a><PageBreakFlag>. It stores an OR combination of PageBreakFlag values.</p>
<h3 class="fn"><a name="Property-enum"></a>enum QTextFormat::Property</h3>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::ObjectIndex</tt></td><td align="center" valign="top"><tt>0x0</tt></td></tr>
</table></p>
<p>Paragraph and character properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QTextFormat::CssFloat</tt></td><td align="center" valign="top"><tt>0x0800</tt></td><td valign="top"> </td></tr>
<tr><td valign="top"><tt>QTextFormat::LayoutDirection</tt></td><td align="center" valign="top"><tt>0x0801</tt></td><td valign="top">The layout direction of the text in the document (<a href="qt.html#LayoutDirection-enum">Qt::LayoutDirection</a>).</td></tr>
<tr><td valign="top"><tt>QTextFormat::OutlinePen</tt></td><td align="center" valign="top"><tt>0x810</tt></td><td valign="top"> </td></tr>
<tr><td valign="top"><tt>QTextFormat::ForegroundBrush</tt></td><td align="center" valign="top"><tt>0x821</tt></td><td valign="top"> </td></tr>
<tr><td valign="top"><tt>QTextFormat::BackgroundBrush</tt></td><td align="center" valign="top"><tt>0x820</tt></td><td valign="top"> </td></tr>
</table></p>
<p>Paragraph properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::BlockAlignment</tt></td><td align="center" valign="top"><tt>0x1010</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockTopMargin</tt></td><td align="center" valign="top"><tt>0x1030</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockBottomMargin</tt></td><td align="center" valign="top"><tt>0x1031</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockLeftMargin</tt></td><td align="center" valign="top"><tt>0x1032</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockRightMargin</tt></td><td align="center" valign="top"><tt>0x1033</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TextIndent</tt></td><td align="center" valign="top"><tt>0x1034</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockIndent</tt></td><td align="center" valign="top"><tt>0x1040</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockNonBreakableLines</tt></td><td align="center" valign="top"><tt>0x1050</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::BlockTrailingHorizontalRulerWidth</tt></td><td align="center" valign="top"><tt>0x1060</tt></td></tr>
</table></p>
<p>Character properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::FontFamily</tt></td><td align="center" valign="top"><tt>0x2000</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontPointSize</tt></td><td align="center" valign="top"><tt>0x2001</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontSizeIncrement</tt></td><td align="center" valign="top"><tt>FontSizeAdjustment</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontWeight</tt></td><td align="center" valign="top"><tt>0x2003</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontItalic</tt></td><td align="center" valign="top"><tt>0x2004</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontUnderline</tt></td><td align="center" valign="top"><tt>0x2005</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontOverline</tt></td><td align="center" valign="top"><tt>0x2006</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontStrikeOut</tt></td><td align="center" valign="top"><tt>0x2007</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontFixedPitch</tt></td><td align="center" valign="top"><tt>0x2008</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FontPixelSize</tt></td><td align="center" valign="top"><tt>0x2009</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TextUnderlineColor</tt></td><td align="center" valign="top"><tt>0x2010</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TextVerticalAlignment</tt></td><td align="center" valign="top"><tt>0x2021</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TextOutline</tt></td><td align="center" valign="top"><tt>0x2022</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TextUnderlineStyle</tt></td><td align="center" valign="top"><tt>0x2023</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::IsAnchor</tt></td><td align="center" valign="top"><tt>0x2030</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::AnchorHref</tt></td><td align="center" valign="top"><tt>0x2031</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::AnchorName</tt></td><td align="center" valign="top"><tt>0x2032</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::ObjectType</tt></td><td align="center" valign="top"><tt>0x2f00</tt></td></tr>
</table></p>
<p>List properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::ListStyle</tt></td><td align="center" valign="top"><tt>0x3000</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::ListIndent</tt></td><td align="center" valign="top"><tt>0x3001</tt></td></tr>
</table></p>
<p>Table and frame properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::TableColumns</tt></td><td align="center" valign="top"><tt>0x4100</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FrameBorder</tt></td><td align="center" valign="top"><tt>0x4000</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FrameMargin</tt></td><td align="center" valign="top"><tt>0x4001</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FramePadding</tt></td><td align="center" valign="top"><tt>0x4002</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FrameWidth</tt></td><td align="center" valign="top"><tt>0x4003</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::FrameHeight</tt></td><td align="center" valign="top"><tt>0x4004</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TableColumnWidthConstraints</tt></td><td align="center" valign="top"><tt>0x4101</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TableCellSpacing</tt></td><td align="center" valign="top"><tt>0x4102</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TableCellPadding</tt></td><td align="center" valign="top"><tt>0x4103</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TableHeaderRowCount</tt></td><td align="center" valign="top"><tt>0x4104</tt></td></tr>
</table></p>
<p>Table cell properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::TableCellRowSpan</tt></td><td align="center" valign="top"><tt>0x4810</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::TableCellColumnSpan</tt></td><td align="center" valign="top"><tt>0x4811</tt></td></tr>
</table></p>
<p>Image properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::ImageName</tt></td><td align="center" valign="top"><tt>0x5000</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::ImageWidth</tt></td><td align="center" valign="top"><tt>0x5010</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::ImageHeight</tt></td><td align="center" valign="top"><tt>0x5011</tt></td></tr>
</table></p>
<p>Selection properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::FullWidthSelection</tt></td><td align="center" valign="top"><tt>0x06000</tt></td></tr>
</table></p>
<p>Page break properties</p>
<p><table border="1" cellpadding="2" cellspacing="1" width="40%">
<tr><th width="60%">Constant</th><th width="40%">Value</th></tr>
<tr><td valign="top"><tt>QTextFormat::PageBreakPolicy</tt></td><td align="center" valign="top"><tt>0x7000</tt></td></tr>
<tr><td valign="top"><tt>QTextFormat::UserProperty</tt></td><td align="center" valign="top"><tt>0x100000</tt></td></tr>
</table></p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QTextFormat"></a>QTextFormat::QTextFormat ()</h3>
<p>Creates a new text format with an <tt>InvalidFormat</tt>.</p>
<p>See also <a href="qtextformat.html#FormatType-enum">FormatType</a>.</p>
<h3 class="fn"><a name="QTextFormat-2"></a>QTextFormat::QTextFormat ( int <i>type</i> )</h3>
<p>Creates a new text format of the given <i>type</i>.</p>
<p>See also <a href="qtextformat.html#FormatType-enum">FormatType</a>.</p>
<h3 class="fn"><a name="QTextFormat-3"></a>QTextFormat::QTextFormat ( const QTextFormat & <i>other</i> )</h3>
<p>Creates a new text format with the same attributes at the <i>other</i> text format.</p>
<h3 class="fn"><a name="dtor.QTextFormat"></a>QTextFormat::~QTextFormat ()</h3>
<p>Destroys this text format.</p>
<h3 class="fn"><a name="background"></a><a href="qbrush.html">QBrush</a> QTextFormat::background () const</h3>
<p>Returns the brush used to paint the document's background.</p>
<p>See also <a href="qtextformat.html#setBackground">setBackground</a>(), <a href="qtextformat.html#clearBackground">clearBackground</a>(), and <a href="qtextformat.html#foreground">foreground</a>().</p>
<h3 class="fn"><a name="boolProperty"></a>bool QTextFormat::boolProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property specified by <i>propertyId</i>. If the property isn't of QTextFormat::Bool type, false is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="brushProperty"></a><a href="qbrush.html">QBrush</a> QTextFormat::brushProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant::Brush</a> type, <a href="qt.html#BrushStyle-enum">Qt::NoBrush</a> is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="clearBackground"></a>void QTextFormat::clearBackground ()</h3>
<p>Clears the brush used to paint the document's background. The default brush will be used.</p>
<p>See also <a href="qtextformat.html#background">background</a>(), <a href="qtextformat.html#setBackground">setBackground</a>(), and <a href="qtextformat.html#clearForeground">clearForeground</a>().</p>
<h3 class="fn"><a name="clearForeground"></a>void QTextFormat::clearForeground ()</h3>
<p>Clears the brush used to paint the document's foreground. The default brush will be used.</p>
<p>See also <a href="qtextformat.html#foreground">foreground</a>(), <a href="qtextformat.html#setForeground">setForeground</a>(), and <a href="qtextformat.html#clearBackground">clearBackground</a>().</p>
<h3 class="fn"><a name="clearProperty"></a>void QTextFormat::clearProperty ( int <i>propertyId</i> )</h3>
<p>Clears the value of the property given by <i>propertyId</i></p>
<h3 class="fn"><a name="colorProperty"></a><a href="qcolor.html">QColor</a> QTextFormat::colorProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant::Color</a> type, an invalid color is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="doubleProperty"></a><a href="qtglobal.html#qreal-typedef">qreal</a> QTextFormat::doubleProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property specified by <i>propertyId</i>. If the property isn't of <a href="qvariant.html#Type-enum">QVariant::Double</a> type, 0 is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="foreground"></a><a href="qbrush.html">QBrush</a> QTextFormat::foreground () const</h3>
<p>Returns the brush used to render foreground details, such as text, frame outlines, and table borders.</p>
<p>See also <a href="qtextformat.html#setForeground">setForeground</a>(), <a href="qtextformat.html#clearForeground">clearForeground</a>(), and <a href="qtextformat.html#background">background</a>().</p>
<h3 class="fn"><a name="hasProperty"></a>bool QTextFormat::hasProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns true if the text format has a property with the given <i>propertyId</i>; otherwise returns false.</p>
<p>See also <a href="qtextformat.html#properties">properties</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="intProperty"></a>int QTextFormat::intProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property specified by <i>propertyId</i>. If the property is not of QTextFormat::Integer type, 0 is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="isBlockFormat"></a>bool QTextFormat::isBlockFormat () const</h3>
<p>Returns true if this text format is a <tt>BlockFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isCharFormat"></a>bool QTextFormat::isCharFormat () const</h3>
<p>Returns true if this text format is a <tt>CharFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isFrameFormat"></a>bool QTextFormat::isFrameFormat () const</h3>
<p>Returns true if this text format is a <tt>FrameFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isImageFormat"></a>bool QTextFormat::isImageFormat () const</h3>
<p>Returns true if this text format is an image format; otherwise returns false.</p>
<h3 class="fn"><a name="isListFormat"></a>bool QTextFormat::isListFormat () const</h3>
<p>Returns true if this text format is a <tt>ListFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isTableFormat"></a>bool QTextFormat::isTableFormat () const</h3>
<p>Returns true if this text format is a <tt>TableFormat</tt>; otherwise returns false.</p>
<h3 class="fn"><a name="isValid"></a>bool QTextFormat::isValid () const</h3>
<p>Returns true if the format is valid (i.e. is not <a href="qtextformat.html#FormatType-enum">InvalidFormat</a>); otherwise returns false.</p>
<h3 class="fn"><a name="layoutDirection"></a><a href="qt.html#LayoutDirection-enum">Qt::LayoutDirection</a> QTextFormat::layoutDirection () const</h3>
<p>Returns the document's layout direction.</p>
<p>See also <a href="qtextformat.html#setLayoutDirection">setLayoutDirection</a>().</p>
<h3 class="fn"><a name="lengthProperty"></a><a href="qtextlength.html">QTextLength</a> QTextFormat::lengthProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="lengthVectorProperty"></a><a href="qvector.html">QVector</a><<a href="qtextlength.html">QTextLength</a>> QTextFormat::lengthVectorProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>. If the property isn't of QTextFormat::LengthVector type, an empty length vector is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="merge"></a>void QTextFormat::merge ( const QTextFormat & <i>other</i> )</h3>
<p>Merges the <i>other</i> format with this format; where there are conflicts the <i>other</i> format takes precedence.</p>
<h3 class="fn"><a name="objectIndex"></a>int QTextFormat::objectIndex () const</h3>
<p>Returns the index of the format object, or -1 if the format object is invalid.</p>
<p>See also <a href="qtextformat.html#setObjectIndex">setObjectIndex</a>().</p>
<h3 class="fn"><a name="objectType"></a>int QTextFormat::objectType () const</h3>
<p>Returns the text format's object type. See <tt>ObjectTypes</tt>.</p>
<p>See also <a href="qtextformat.html#setObjectType">setObjectType</a>().</p>
<h3 class="fn"><a name="penProperty"></a><a href="qpen.html">QPen</a> QTextFormat::penProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant::Pen</a> type, <a href="qt.html#PenStyle-enum">Qt::NoPen</a> is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="properties"></a><a href="qmap.html">QMap</a><int, <a href="qvariant.html">QVariant</a>> QTextFormat::properties () const</h3>
<p>Returns a map with all properties of this text format.</p>
<h3 class="fn"><a name="property"></a><a href="qvariant.html">QVariant</a> QTextFormat::property ( int <i>propertyId</i> ) const</h3>
<p>Returns the property specified by the given <i>propertyId</i>.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>().</p>
<h3 class="fn"><a name="setBackground"></a>void QTextFormat::setBackground ( const <a href="qbrush.html">QBrush</a> & <i>brush</i> )</h3>
<p>Sets the brush use to paint the document's background to the <i>brush</i> specified.</p>
<p>See also <a href="qtextformat.html#background">background</a>(), <a href="qtextformat.html#clearBackground">clearBackground</a>(), and <a href="qtextformat.html#setForeground">setForeground</a>().</p>
<h3 class="fn"><a name="setForeground"></a>void QTextFormat::setForeground ( const <a href="qbrush.html">QBrush</a> & <i>brush</i> )</h3>
<p>Sets the foreground brush to the specified <i>brush</i>. The foreground brush is mostly used to render text.</p>
<p>See also <a href="qtextformat.html#foreground">foreground</a>(), <a href="qtextformat.html#clearForeground">clearForeground</a>(), and <a href="qtextformat.html#setBackground">setBackground</a>().</p>
<h3 class="fn"><a name="setLayoutDirection"></a>void QTextFormat::setLayoutDirection ( <a href="qt.html#LayoutDirection-enum">Qt::LayoutDirection</a> <i>direction</i> )</h3>
<p>Sets the document's layout direction to the specified <i>direction</i>.</p>
<p>See also <a href="qtextformat.html#layoutDirection">layoutDirection</a>().</p>
<h3 class="fn"><a name="setObjectIndex"></a>void QTextFormat::setObjectIndex ( int <i>index</i> )</h3>
<p>Sets the format object's object <i>index</i>.</p>
<p>See also <a href="qtextformat.html#objectIndex">objectIndex</a>().</p>
<h3 class="fn"><a name="setObjectType"></a>void QTextFormat::setObjectType ( int <i>type</i> )</h3>
<p>Sets the text format's object <i>type</i>. See <tt>ObjectTypes</tt>.</p>
<p>See also <a href="qtextformat.html#objectType">objectType</a>().</p>
<h3 class="fn"><a name="setProperty"></a>void QTextFormat::setProperty ( int <i>propertyId</i>, const <a href="qvariant.html">QVariant</a> & <i>value</i> )</h3>
<p>Sets the property specified by the <i>propertyId</i> to the given <i>value</i>.</p>
<p>See also <a href="qtextformat.html#property">property</a>().</p>
<h3 class="fn"><a name="setProperty-2"></a>void QTextFormat::setProperty ( int <i>propertyId</i>, const <a href="qvector.html">QVector</a><<a href="qtextlength.html">QTextLength</a>> & <i>value</i> )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Sets the value of the property given by <i>propertyId</i> to <i>value</i>.</p>
<p>See also <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="stringProperty"></a><a href="qstring.html">QString</a> QTextFormat::stringProperty ( int <i>propertyId</i> ) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of <a href="qvariant.html#Type-enum">QVariant::String</a> type, an empty string is returned instead.</p>
<p>See also <a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<h3 class="fn"><a name="toBlockFormat"></a><a href="qtextblockformat.html">QTextBlockFormat</a> QTextFormat::toBlockFormat () const</h3>
<p>Returns this format as a block format.</p>
<h3 class="fn"><a name="toCharFormat"></a><a href="qtextcharformat.html">QTextCharFormat</a> QTextFormat::toCharFormat () const</h3>
<p>Returns this format as a character format.</p>
<h3 class="fn"><a name="toFrameFormat"></a><a href="qtextframeformat.html">QTextFrameFormat</a> QTextFormat::toFrameFormat () const</h3>
<p>Returns this format as a frame format.</p>
<h3 class="fn"><a name="toImageFormat"></a><a href="qtextimageformat.html">QTextImageFormat</a> QTextFormat::toImageFormat () const</h3>
<p>Returns this format as an image format.</p>
<h3 class="fn"><a name="toListFormat"></a><a href="qtextlistformat.html">QTextListFormat</a> QTextFormat::toListFormat () const</h3>
<p>Returns this format as a list format.</p>
<h3 class="fn"><a name="toTableFormat"></a><a href="qtexttableformat.html">QTextTableFormat</a> QTextFormat::toTableFormat () const</h3>
<p>Returns this format as a table format.</p>
<h3 class="fn"><a name="type"></a>int QTextFormat::type () const</h3>
<p>Returns the type of this format.</p>
<p>See also <a href="qtextformat.html#ObjectTypes-enum">ObjectTypes</a>.</p>
<h3 class="fn"><a name="operator-QVariant"></a>QTextFormat::operator QVariant () const</h3>
<p>Returns the text format as a <a href="qvariant.html">QVariant</a></p>
<h3 class="fn"><a name="operator-not-eq"></a>bool QTextFormat::operator!= ( const QTextFormat & <i>other</i> ) const</h3>
<p>Returns true if this text format is different from the <i>other</i> text format.</p>
<h3 class="fn"><a name="operator-eq"></a>QTextFormat & QTextFormat::operator= ( const QTextFormat & <i>other</i> )</h3>
<p>Assigns the <i>other</i> text format to this text format, and returns a reference to this text format.</p>
<h3 class="fn"><a name="operator-eq-eq"></a>bool QTextFormat::operator== ( const QTextFormat & <i>other</i> ) const</h3>
<p>Returns true if this text format is the same as the <i>other</i> text format.</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2006 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.2.1</div></td>
</tr></table></div></address></body>
</html>
