<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qtextformat.cpp -->
<title>Qt 4.8: QTextBlockFormat Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QTextBlockFormat</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QTextBlockFormat Class Reference</h1>
<!-- $$$QTextBlockFormat-brief -->
<p>The QTextBlockFormat class provides formatting information for blocks of text in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextBlockFormat -->
<pre class="cpp"> <span class="preprocessor">#include <QTextBlockFormat></span></pre><p><b>Inherits: </b><a href="qtextformat.html">QTextFormat</a>.</p>
<p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qtextblockformat-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#LineHeightTypes-enum">LineHeightTypes</a></b> { SingleHeight, ProportionalHeight, FixedHeight, MinimumHeight, LineDistanceHeight }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#QTextBlockFormat">QTextBlockFormat</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::Alignment </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#alignment">alignment</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#bottomMargin">bottomMargin</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#indent">indent</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#leftMargin">leftMargin</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#lineHeight">lineHeight</a></b> ( qreal <i>scriptLineHeight</i>, qreal <i>scaling</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#lineHeight-2">lineHeight</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#lineHeightType">lineHeightType</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#nonBreakableLines">nonBreakableLines</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> PageBreakFlags </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#pageBreakPolicy">pageBreakPolicy</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#rightMargin">rightMargin</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setAlignment">setAlignment</a></b> ( Qt::Alignment <i>alignment</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setBottomMargin">setBottomMargin</a></b> ( qreal <i>margin</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setIndent">setIndent</a></b> ( int <i>indentation</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a></b> ( qreal <i>margin</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setLineHeight">setLineHeight</a></b> ( qreal <i>height</i>, int <i>heightType</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setNonBreakableLines">setNonBreakableLines</a></b> ( bool <i>b</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setPageBreakPolicy">setPageBreakPolicy</a></b> ( PageBreakFlags <i>policy</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setRightMargin">setRightMargin</a></b> ( qreal <i>margin</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setTabPositions">setTabPositions</a></b> ( const QList<QTextOption::Tab> & <i>tabs</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setTextIndent">setTextIndent</a></b> ( qreal <i>indent</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#setTopMargin">setTopMargin</a></b> ( qreal <i>margin</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QTextOption::Tab> </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#tabPositions">tabPositions</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#textIndent">textIndent</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextblockformat.html#topMargin">topMargin</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">49 public functions inherited from <a href="qtextformat.html#public-functions">QTextFormat</a></li>
</ul>
<a name="details"></a>
<!-- $$$QTextBlockFormat-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextBlockFormat class provides formatting information for blocks of text in a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>A document is composed of a list of blocks, represented by <a href="qtextblock.html">QTextBlock</a> 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.</p>
<p>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 <a href="qtextblockformat.html#setAlignment">setAlignment</a>(). Margins are controlled by <a href="qtextblockformat.html#setTopMargin">setTopMargin</a>(), <a href="qtextblockformat.html#setBottomMargin">setBottomMargin</a>(), <a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a>(), <a href="qtextblockformat.html#setRightMargin">setRightMargin</a>(). Overall indentation is set with <a href="qtextblockformat.html#setIndent">setIndent</a>(), the indentation of the first line with <a href="qtextblockformat.html#setTextIndent">setTextIndent</a>().</p>
<p>Line spacing is set with <a href="qtextblockformat.html#setLineHeight">setLineHeight</a>() and retrieved via <a href="qtextblockformat.html#lineHeight">lineHeight</a>() and <a href="qtextblockformat.html#lineHeightType">lineHeightType</a>(). The types of line spacing available are in the <a href="qtextblockformat.html#LineHeightTypes-enum">LineHeightTypes</a> enum.</p>
<p>Line breaking can be enabled and disabled with <a href="qtextblockformat.html#setNonBreakableLines">setNonBreakableLines</a>().</p>
<p>The brush used to paint the paragraph's background is set with <a href="qtextformat.html#setBackground">setBackground()</a>, and other aspects of the text's appearance can be customized by using the <a href="qtextformat.html#setProperty">setProperty()</a> function with the <tt>OutlinePen</tt>, <tt>ForegroundBrush</tt>, and <tt>BackgroundBrush</tt> <a href="qtextformat.html#Property-enum">QTextFormat::Property</a> values.</p>
<p>If a text block is part of a list, it can also have a list format that is accessible with the listFormat() function.</p>
</div>
<p><b>See also </b><a href="qtextblock.html">QTextBlock</a> and <a href="qtextcharformat.html">QTextCharFormat</a>.</p>
<!-- @@@QTextBlockFormat -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$LineHeightTypes$$$SingleHeight$$$ProportionalHeight$$$FixedHeight$$$MinimumHeight$$$LineDistanceHeight -->
<h3 class="fn"><a name="LineHeightTypes-enum"></a>enum QTextBlockFormat::<span class="name">LineHeightTypes</span></h3>
<p>This enum describes the various types of line spacing support paragraphs can have.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QTextBlockFormat::SingleHeight</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">This is the default line height: single spacing.</td></tr>
<tr><td class="topAlign"><tt>QTextBlockFormat::ProportionalHeight</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">This sets the spacing proportional to the line (in percentage). For example, set to 200 for double spacing.</td></tr>
<tr><td class="topAlign"><tt>QTextBlockFormat::FixedHeight</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">This sets the line height to a fixed line height (in pixels).</td></tr>
<tr><td class="topAlign"><tt>QTextBlockFormat::MinimumHeight</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">This sets the minimum line height (in pixels).</td></tr>
<tr><td class="topAlign"><tt>QTextBlockFormat::LineDistanceHeight</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">This adds the specified height between lines (in pixels).</td></tr>
</table>
<p>This enum was introduced or modified in Qt 4.8.</p>
<p><b>See also </b><a href="qtextblockformat.html#lineHeight">lineHeight</a>(), <a href="qtextblockformat.html#lineHeightType">lineHeightType</a>(), and <a href="qtextblockformat.html#setLineHeight">setLineHeight</a>().</p>
<!-- @@@LineHeightTypes -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextBlockFormat[overload1]$$$QTextBlockFormat -->
<h3 class="fn"><a name="QTextBlockFormat"></a>QTextBlockFormat::<span class="name">QTextBlockFormat</span> ()</h3>
<p>Constructs a new <a href="qtextblockformat.html">QTextBlockFormat</a>.</p>
<!-- @@@QTextBlockFormat -->
<!-- $$$alignment[overload1]$$$alignment -->
<h3 class="fn"><a name="alignment"></a><span class="type"><a href="qt.html#AlignmentFlag-enum">Qt::Alignment</a></span> QTextBlockFormat::<span class="name">alignment</span> () const</h3>
<p>Returns the paragraph's alignment.</p>
<p><b>See also </b><a href="qtextblockformat.html#setAlignment">setAlignment</a>().</p>
<!-- @@@alignment -->
<!-- $$$bottomMargin[overload1]$$$bottomMargin -->
<h3 class="fn"><a name="bottomMargin"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextBlockFormat::<span class="name">bottomMargin</span> () const</h3>
<p>Returns the paragraph's bottom margin.</p>
<p><b>See also </b><a href="qtextblockformat.html#setBottomMargin">setBottomMargin</a>() and <a href="qtextblockformat.html#topMargin">topMargin</a>().</p>
<!-- @@@bottomMargin -->
<!-- $$$indent[overload1]$$$indent -->
<h3 class="fn"><a name="indent"></a><span class="type">int</span> QTextBlockFormat::<span class="name">indent</span> () const</h3>
<p>Returns the paragraph's indent.</p>
<p><b>See also </b><a href="qtextblockformat.html#setIndent">setIndent</a>().</p>
<!-- @@@indent -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QTextBlockFormat::<span class="name">isValid</span> () const</h3>
<p>Returns true if this block format is valid; otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$leftMargin[overload1]$$$leftMargin -->
<h3 class="fn"><a name="leftMargin"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextBlockFormat::<span class="name">leftMargin</span> () const</h3>
<p>Returns the paragraph's left margin.</p>
<p><b>See also </b><a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a>(), <a href="qtextblockformat.html#rightMargin">rightMargin</a>(), and <a href="qtextblockformat.html#indent">indent</a>().</p>
<!-- @@@leftMargin -->
<!-- $$$lineHeight[overload1]$$$lineHeightqrealqreal -->
<h3 class="fn"><a name="lineHeight"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextBlockFormat::<span class="name">lineHeight</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>scriptLineHeight</i>, <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>scaling</i> ) const</h3>
<p>Returns the height of the lines in the paragraph based on the height of the script line given by <i>scriptLineHeight</i> and the specified <i>scaling</i> factor.</p>
<p>The value that is returned is also dependent on the given <a href="qtextformat.html#Property-enum">LineHeightType</a> of the paragraph as well as the <a href="qtextformat.html#Property-enum">LineHeight</a> setting that has been set for the paragraph.</p>
<p>The scaling is needed for heights that include a fixed number of pixels, to scale them appropriately for printing.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextblockformat.html#LineHeightTypes-enum">LineHeightTypes</a>, <a href="qtextblockformat.html#setLineHeight">setLineHeight</a>(), and <a href="qtextblockformat.html#lineHeightType">lineHeightType</a>().</p>
<!-- @@@lineHeight -->
<!-- $$$lineHeight$$$lineHeight -->
<h3 class="fn"><a name="lineHeight-2"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextBlockFormat::<span class="name">lineHeight</span> () const</h3>
<p>This returns the <a href="qtextformat.html#Property-enum">LineHeight</a> property for the paragraph.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextblockformat.html#LineHeightTypes-enum">LineHeightTypes</a>, <a href="qtextblockformat.html#setLineHeight">setLineHeight</a>(), and <a href="qtextblockformat.html#lineHeightType">lineHeightType</a>().</p>
<!-- @@@lineHeight -->
<!-- $$$lineHeightType[overload1]$$$lineHeightType -->
<h3 class="fn"><a name="lineHeightType"></a><span class="type">int</span> QTextBlockFormat::<span class="name">lineHeightType</span> () const</h3>
<p>This returns the <a href="qtextformat.html#Property-enum">LineHeightType</a> property of the paragraph.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextblockformat.html#LineHeightTypes-enum">LineHeightTypes</a>, <a href="qtextblockformat.html#setLineHeight">setLineHeight</a>(), and <a href="qtextblockformat.html#lineHeight">lineHeight</a>().</p>
<!-- @@@lineHeightType -->
<!-- $$$nonBreakableLines[overload1]$$$nonBreakableLines -->
<h3 class="fn"><a name="nonBreakableLines"></a><span class="type">bool</span> QTextBlockFormat::<span class="name">nonBreakableLines</span> () const</h3>
<p>Returns true if the lines in the paragraph are non-breakable; otherwise returns false.</p>
<p><b>See also </b><a href="qtextblockformat.html#setNonBreakableLines">setNonBreakableLines</a>().</p>
<!-- @@@nonBreakableLines -->
<!-- $$$pageBreakPolicy[overload1]$$$pageBreakPolicy -->
<h3 class="fn"><a name="pageBreakPolicy"></a><span class="type"><a href="qtextformat.html#PageBreakFlag-enum">PageBreakFlags</a></span> QTextBlockFormat::<span class="name">pageBreakPolicy</span> () const</h3>
<p>Returns the currently set page break policy for the paragraph. The default is <a href="qtextformat.html#PageBreakFlag-enum">QTextFormat::PageBreak_Auto</a>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qtextblockformat.html#setPageBreakPolicy">setPageBreakPolicy</a>().</p>
<!-- @@@pageBreakPolicy -->
<!-- $$$rightMargin[overload1]$$$rightMargin -->
<h3 class="fn"><a name="rightMargin"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextBlockFormat::<span class="name">rightMargin</span> () const</h3>
<p>Returns the paragraph's right margin.</p>
<p><b>See also </b><a href="qtextblockformat.html#setRightMargin">setRightMargin</a>() and <a href="qtextblockformat.html#leftMargin">leftMargin</a>().</p>
<!-- @@@rightMargin -->
<!-- $$$setAlignment[overload1]$$$setAlignmentQt::Alignment -->
<h3 class="fn"><a name="setAlignment"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setAlignment</span> ( <span class="type"><a href="qt.html#AlignmentFlag-enum">Qt::Alignment</a></span> <i>alignment</i> )</h3>
<p>Sets the paragraph's <i>alignment</i>.</p>
<p><b>See also </b><a href="qtextblockformat.html#alignment">alignment</a>().</p>
<!-- @@@setAlignment -->
<!-- $$$setBottomMargin[overload1]$$$setBottomMarginqreal -->
<h3 class="fn"><a name="setBottomMargin"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setBottomMargin</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>margin</i> )</h3>
<p>Sets the paragraph's bottom <i>margin</i>.</p>
<p><b>See also </b><a href="qtextblockformat.html#bottomMargin">bottomMargin</a>(), <a href="qtextblockformat.html#setTopMargin">setTopMargin</a>(), <a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a>(), and <a href="qtextblockformat.html#setRightMargin">setRightMargin</a>().</p>
<!-- @@@setBottomMargin -->
<!-- $$$setIndent[overload1]$$$setIndentint -->
<h3 class="fn"><a name="setIndent"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setIndent</span> ( <span class="type">int</span> <i>indentation</i> )</h3>
<p>Sets the paragraph's <i>indentation</i>. Margins are set independently of indentation with <a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a>() and <a href="qtextblockformat.html#setTextIndent">setTextIndent</a>(). The <i>indentation</i> is an integer that is multiplied with the document-wide standard indent, resulting in the actual indent of the paragraph.</p>
<p><b>See also </b><a href="qtextblockformat.html#indent">indent</a>() and <a href="qtextdocument.html#indentWidth-prop">QTextDocument::indentWidth</a>().</p>
<!-- @@@setIndent -->
<!-- $$$setLeftMargin[overload1]$$$setLeftMarginqreal -->
<h3 class="fn"><a name="setLeftMargin"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setLeftMargin</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>margin</i> )</h3>
<p>Sets the paragraph's left <i>margin</i>. Indentation can be applied separately with <a href="qtextblockformat.html#setIndent">setIndent</a>().</p>
<p><b>See also </b><a href="qtextblockformat.html#leftMargin">leftMargin</a>(), <a href="qtextblockformat.html#setRightMargin">setRightMargin</a>(), <a href="qtextblockformat.html#setTopMargin">setTopMargin</a>(), and <a href="qtextblockformat.html#setBottomMargin">setBottomMargin</a>().</p>
<!-- @@@setLeftMargin -->
<!-- $$$setLineHeight[overload1]$$$setLineHeightqrealint -->
<h3 class="fn"><a name="setLineHeight"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setLineHeight</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>height</i>, <span class="type">int</span> <i>heightType</i> )</h3>
<p>Sets the line height for the paragraph to the value given by <i>height</i> which is dependent on <i>heightType</i> in the way described by the <a href="qtextblockformat.html#LineHeightTypes-enum">LineHeightTypes</a> enum.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextblockformat.html#LineHeightTypes-enum">LineHeightTypes</a>, <a href="qtextblockformat.html#lineHeight">lineHeight</a>(), and <a href="qtextblockformat.html#lineHeightType">lineHeightType</a>().</p>
<!-- @@@setLineHeight -->
<!-- $$$setNonBreakableLines[overload1]$$$setNonBreakableLinesbool -->
<h3 class="fn"><a name="setNonBreakableLines"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setNonBreakableLines</span> ( <span class="type">bool</span> <i>b</i> )</h3>
<p>If <i>b</i> is true, the lines in the paragraph are treated as non-breakable; otherwise they are breakable.</p>
<p><b>See also </b><a href="qtextblockformat.html#nonBreakableLines">nonBreakableLines</a>().</p>
<!-- @@@setNonBreakableLines -->
<!-- $$$setPageBreakPolicy[overload1]$$$setPageBreakPolicyPageBreakFlags -->
<h3 class="fn"><a name="setPageBreakPolicy"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setPageBreakPolicy</span> ( <span class="type"><a href="qtextformat.html#PageBreakFlag-enum">PageBreakFlags</a></span> <i>policy</i> )</h3>
<p>Sets the page break policy for the paragraph to <i>policy</i>.</p>
<p>This function was introduced in Qt 4.2.</p>
<p><b>See also </b><a href="qtextblockformat.html#pageBreakPolicy">pageBreakPolicy</a>().</p>
<!-- @@@setPageBreakPolicy -->
<!-- $$$setRightMargin[overload1]$$$setRightMarginqreal -->
<h3 class="fn"><a name="setRightMargin"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setRightMargin</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>margin</i> )</h3>
<p>Sets the paragraph's right <i>margin</i>.</p>
<p><b>See also </b><a href="qtextblockformat.html#rightMargin">rightMargin</a>(), <a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a>(), <a href="qtextblockformat.html#setTopMargin">setTopMargin</a>(), and <a href="qtextblockformat.html#setBottomMargin">setBottomMargin</a>().</p>
<!-- @@@setRightMargin -->
<!-- $$$setTabPositions[overload1]$$$setTabPositionsconstQList<QTextOption::Tab>& -->
<h3 class="fn"><a name="setTabPositions"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setTabPositions</span> ( const <span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qtextoption-tab.html">QTextOption::Tab</a></span>> & <i>tabs</i> )</h3>
<p>Sets the tab positions for the text block to those specified by <i>tabs</i>.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qtextblockformat.html#tabPositions">tabPositions</a>().</p>
<!-- @@@setTabPositions -->
<!-- $$$setTextIndent[overload1]$$$setTextIndentqreal -->
<h3 class="fn"><a name="setTextIndent"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setTextIndent</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>indent</i> )</h3>
<p>Sets the <i>indent</i> 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.</p>
<p><b>See also </b><a href="qtextblockformat.html#textIndent">textIndent</a>(), <a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a>(), <a href="qtextblockformat.html#setRightMargin">setRightMargin</a>(), <a href="qtextblockformat.html#setTopMargin">setTopMargin</a>(), and <a href="qtextblockformat.html#setBottomMargin">setBottomMargin</a>().</p>
<!-- @@@setTextIndent -->
<!-- $$$setTopMargin[overload1]$$$setTopMarginqreal -->
<h3 class="fn"><a name="setTopMargin"></a><span class="type">void</span> QTextBlockFormat::<span class="name">setTopMargin</span> ( <span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> <i>margin</i> )</h3>
<p>Sets the paragraph's top <i>margin</i>.</p>
<p><b>See also </b><a href="qtextblockformat.html#topMargin">topMargin</a>(), <a href="qtextblockformat.html#setBottomMargin">setBottomMargin</a>(), <a href="qtextblockformat.html#setLeftMargin">setLeftMargin</a>(), and <a href="qtextblockformat.html#setRightMargin">setRightMargin</a>().</p>
<!-- @@@setTopMargin -->
<!-- $$$tabPositions[overload1]$$$tabPositions -->
<h3 class="fn"><a name="tabPositions"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qtextoption-tab.html">QTextOption::Tab</a></span>> QTextBlockFormat::<span class="name">tabPositions</span> () const</h3>
<p>Returns a list of tab positions defined for the text block.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qtextblockformat.html#setTabPositions">setTabPositions</a>().</p>
<!-- @@@tabPositions -->
<!-- $$$textIndent[overload1]$$$textIndent -->
<h3 class="fn"><a name="textIndent"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextBlockFormat::<span class="name">textIndent</span> () const</h3>
<p>Returns the paragraph's text indent.</p>
<p><b>See also </b><a href="qtextblockformat.html#setTextIndent">setTextIndent</a>().</p>
<!-- @@@textIndent -->
<!-- $$$topMargin[overload1]$$$topMargin -->
<h3 class="fn"><a name="topMargin"></a><span class="type"><a href="qtglobal.html#qreal-typedef">qreal</a></span> QTextBlockFormat::<span class="name">topMargin</span> () const</h3>
<p>Returns the paragraph's top margin.</p>
<p><b>See also </b><a href="qtextblockformat.html#setTopMargin">setTopMargin</a>() and <a href="qtextblockformat.html#bottomMargin">bottomMargin</a>().</p>
<!-- @@@topMargin -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
