<?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: QTextListFormat 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>QTextListFormat</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">QTextListFormat Class Reference</h1>
<!-- $$$QTextListFormat-brief -->
<p>The QTextListFormat class provides formatting information for lists in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextListFormat -->
<pre class="cpp"> <span class="preprocessor">#include <QTextListFormat></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="qtextlistformat-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="qtextlistformat.html#Style-enum">Style</a></b> { ListDisc, ListCircle, ListSquare, ListDecimal, ..., ListUpperRoman }</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="qtextlistformat.html#QTextListFormat">QTextListFormat</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.html#indent">indent</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.html#numberPrefix">numberPrefix</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.html#numberSuffix">numberSuffix</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.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="qtextlistformat.html#setNumberPrefix">setNumberPrefix</a></b> ( const QString & <i>numberPrefix</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.html#setNumberSuffix">setNumberSuffix</a></b> ( const QString & <i>numberSuffix</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.html#setStyle">setStyle</a></b> ( Style <i>style</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Style </td><td class="memItemRight bottomAlign"><b><a href="qtextlistformat.html#style">style</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>
<!-- $$$QTextListFormat-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTextListFormat class provides formatting information for lists in a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>A list is composed of one or more items, represented as text blocks. The list's format specifies the appearance of items in the list. In particular, it determines the indentation and the style of each item.</p>
<p>The indentation of the items is an integer value that causes each item to be offset from the left margin by a certain amount. This value is read with <a href="qtextlistformat.html#indent">indent</a>() and set with <a href="qtextlistformat.html#setIndent">setIndent</a>().</p>
<p>The style used to decorate each item is set with <a href="qtextlistformat.html#setStyle">setStyle</a>() and can be read with the <a href="qtextlistformat.html#style">style</a>() function. The style controls the type of bullet points and numbering scheme used for items in the list. Note that lists that use the decimal numbering scheme begin counting at 1 rather than 0.</p>
<p>Style properties can be set to further configure the appearance of list items; for example, the <a href="qtextformat.html#Property-enum">ListNumberPrefix</a> and <a href="qtextformat.html#Property-enum">ListNumberSuffix</a> properties can be used to customize the numbers used in an ordered list so that they appear as (1), (2), (3), etc.:</p>
<pre class="cpp"> <span class="type">QTextListFormat</span> listFormat;
listFormat<span class="operator">.</span>setStyle(<span class="type">QTextListFormat</span><span class="operator">::</span>ListDecimal);
listFormat<span class="operator">.</span>setNumberPrefix(<span class="string">"("</span>);
listFormat<span class="operator">.</span>setNumberSuffix(<span class="string">")"</span>);
cursor<span class="operator">.</span>insertList(listFormat);</pre>
</div>
<p><b>See also </b><a href="qtextlist.html">QTextList</a>.</p>
<!-- @@@QTextListFormat -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Style$$$ListDisc$$$ListCircle$$$ListSquare$$$ListDecimal$$$ListLowerAlpha$$$ListUpperAlpha$$$ListLowerRoman$$$ListUpperRoman$$$ListStyleUndefined -->
<h3 class="fn"><a name="Style-enum"></a>enum QTextListFormat::<span class="name">Style</span></h3>
<p>This enum describes the symbols used to decorate list items:</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>QTextListFormat::ListDisc</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">a filled circle</td></tr>
<tr><td class="topAlign"><tt>QTextListFormat::ListCircle</tt></td><td class="topAlign"><tt>-2</tt></td><td class="topAlign">an empty circle</td></tr>
<tr><td class="topAlign"><tt>QTextListFormat::ListSquare</tt></td><td class="topAlign"><tt>-3</tt></td><td class="topAlign">a filled square</td></tr>
<tr><td class="topAlign"><tt>QTextListFormat::ListDecimal</tt></td><td class="topAlign"><tt>-4</tt></td><td class="topAlign">decimal values in ascending order</td></tr>
<tr><td class="topAlign"><tt>QTextListFormat::ListLowerAlpha</tt></td><td class="topAlign"><tt>-5</tt></td><td class="topAlign">lower case Latin characters in alphabetical order</td></tr>
<tr><td class="topAlign"><tt>QTextListFormat::ListUpperAlpha</tt></td><td class="topAlign"><tt>-6</tt></td><td class="topAlign">upper case Latin characters in alphabetical order</td></tr>
<tr><td class="topAlign"><tt>QTextListFormat::ListLowerRoman</tt></td><td class="topAlign"><tt>-7</tt></td><td class="topAlign">lower case roman numerals (supports up to 4999 items only)</td></tr>
<tr><td class="topAlign"><tt>QTextListFormat::ListUpperRoman</tt></td><td class="topAlign"><tt>-8</tt></td><td class="topAlign">upper case roman numerals (supports up to 4999 items only)</td></tr>
</table>
<!-- @@@Style -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextListFormat[overload1]$$$QTextListFormat -->
<h3 class="fn"><a name="QTextListFormat"></a>QTextListFormat::<span class="name">QTextListFormat</span> ()</h3>
<p>Constructs a new list format object.</p>
<!-- @@@QTextListFormat -->
<!-- $$$indent[overload1]$$$indent -->
<h3 class="fn"><a name="indent"></a><span class="type">int</span> QTextListFormat::<span class="name">indent</span> () const</h3>
<p>Returns the list format's indentation. The indentation is multiplied by the <a href="qtextdocument.html#indentWidth-prop">QTextDocument::indentWidth</a> property to get the effective indent in pixels.</p>
<p><b>See also </b><a href="qtextlistformat.html#setIndent">setIndent</a>().</p>
<!-- @@@indent -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QTextListFormat::<span class="name">isValid</span> () const</h3>
<p>Returns true if this list format is valid; otherwise returns false.</p>
<!-- @@@isValid -->
<!-- $$$numberPrefix[overload1]$$$numberPrefix -->
<h3 class="fn"><a name="numberPrefix"></a><span class="type"><a href="qstring.html">QString</a></span> QTextListFormat::<span class="name">numberPrefix</span> () const</h3>
<p>Returns the list format's number prefix.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlistformat.html#setNumberPrefix">setNumberPrefix</a>().</p>
<!-- @@@numberPrefix -->
<!-- $$$numberSuffix[overload1]$$$numberSuffix -->
<h3 class="fn"><a name="numberSuffix"></a><span class="type"><a href="qstring.html">QString</a></span> QTextListFormat::<span class="name">numberSuffix</span> () const</h3>
<p>Returns the list format's number suffix.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlistformat.html#setNumberSuffix">setNumberSuffix</a>().</p>
<!-- @@@numberSuffix -->
<!-- $$$setIndent[overload1]$$$setIndentint -->
<h3 class="fn"><a name="setIndent"></a><span class="type">void</span> QTextListFormat::<span class="name">setIndent</span> ( <span class="type">int</span> <i>indentation</i> )</h3>
<p>Sets the list format's <i>indentation</i>. The indentation is multiplied by the <a href="qtextdocument.html#indentWidth-prop">QTextDocument::indentWidth</a> property to get the effective indent in pixels.</p>
<p><b>See also </b><a href="qtextlistformat.html#indent">indent</a>().</p>
<!-- @@@setIndent -->
<!-- $$$setNumberPrefix[overload1]$$$setNumberPrefixconstQString& -->
<h3 class="fn"><a name="setNumberPrefix"></a><span class="type">void</span> QTextListFormat::<span class="name">setNumberPrefix</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>numberPrefix</i> )</h3>
<p>Sets the list format's number prefix to the string specified by <i>numberPrefix</i>. This can be used with all sorted list types. It does not have any effect on unsorted list types.</p>
<p>The default prefix is an empty string.</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlistformat.html#numberPrefix">numberPrefix</a>().</p>
<!-- @@@setNumberPrefix -->
<!-- $$$setNumberSuffix[overload1]$$$setNumberSuffixconstQString& -->
<h3 class="fn"><a name="setNumberSuffix"></a><span class="type">void</span> QTextListFormat::<span class="name">setNumberSuffix</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>numberSuffix</i> )</h3>
<p>Sets the list format's number suffix to the string specified by <i>numberSuffix</i>. This can be used with all sorted list types. It does not have any effect on unsorted list types.</p>
<p>The default suffix is ".".</p>
<p>This function was introduced in Qt 4.8.</p>
<p><b>See also </b><a href="qtextlistformat.html#numberSuffix">numberSuffix</a>().</p>
<!-- @@@setNumberSuffix -->
<!-- $$$setStyle[overload1]$$$setStyleStyle -->
<h3 class="fn"><a name="setStyle"></a><span class="type">void</span> QTextListFormat::<span class="name">setStyle</span> ( <span class="type"><a href="qtextlistformat.html#Style-enum">Style</a></span> <i>style</i> )</h3>
<p>Sets the list format's <i>style</i>.</p>
<p><b>See also </b><a href="qtextlistformat.html#style">style</a>() and <a href="qtextlistformat.html#Style-enum">Style</a>.</p>
<!-- @@@setStyle -->
<!-- $$$style[overload1]$$$style -->
<h3 class="fn"><a name="style"></a><span class="type"><a href="qtextlistformat.html#Style-enum">Style</a></span> QTextListFormat::<span class="name">style</span> () const</h3>
<p>Returns the list format's style.</p>
<p><b>See also </b><a href="qtextlistformat.html#setStyle">setStyle</a>() and <a href="qtextlistformat.html#Style-enum">Style</a>.</p>
<!-- @@@style -->
</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>
