<?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" /> <!-- qtextlist.cpp --> <title>Qt 4.8: QTextList 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>QTextList</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-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QTextList Class Reference</h1> <!-- $$$QTextList-brief --> <p>The QTextList class provides a decorated list of items in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p> <!-- @@@QTextList --> <pre class="cpp"> <span class="preprocessor">#include <QTextList></span></pre><p><b>Inherits: </b><a href="qtextblockgroup.html">QTextBlockGroup</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="qtextlist-members.html">List of all members, including inherited members</a></li> <li><a href="qtextlist-obsolete.html">Obsolete members</a></li> </ul> <a name="public-functions"></a> <h2>Public Functions</h2> <table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#add">add</a></b> ( const QTextBlock & <i>block</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#count">count</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextListFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#format">format</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QTextBlock </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#item">item</a></b> ( int <i>i</i> ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#itemNumber">itemNumber</a></b> ( const QTextBlock & <i>block</i> ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#itemText">itemText</a></b> ( const QTextBlock & <i>block</i> ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#remove">remove</a></b> ( const QTextBlock & <i>block</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#removeItem">removeItem</a></b> ( int <i>i</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextlist.html#setFormat">setFormat</a></b> ( const QTextListFormat & <i>format</i> )</td></tr> </table> <ul> <li class="fn">4 public functions inherited from <a href="qtextobject.html#public-functions">QTextObject</a></li> <li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li> <li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> <li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li> <li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> <li class="fn">4 protected functions inherited from <a href="qtextblockgroup.html#protected-functions">QTextBlockGroup</a></li> <li class="fn">1 protected function inherited from <a href="qtextobject.html#protected-functions">QTextObject</a></li> <li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QTextList-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The QTextList class provides a decorated list of items in a <a href="qtextdocument.html">QTextDocument</a>.</p> <p>A list contains a sequence of text blocks, each of which is marked with a bullet point or other symbol. Multiple levels of lists can be used, and the automatic numbering feature provides support for ordered numeric and alphabetical lists.</p> <p>Lists are created by using a text cursor to insert an empty list at the current position or by moving existing text into a new list. The <a href="qtextcursor.html#insertList">QTextCursor::insertList</a>() function inserts an empty block into the document at the cursor position, and makes it the first item in a list.</p> <pre class="cpp"> <span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span> listFormat; <span class="keyword">if</span> (list) { listFormat <span class="operator">=</span> list<span class="operator">-</span><span class="operator">></span>format(); listFormat<span class="operator">.</span>setIndent(listFormat<span class="operator">.</span>indent() <span class="operator">+</span> <span class="number">1</span>); } listFormat<span class="operator">.</span>setStyle(<span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span><span class="operator">::</span>ListDisc); cursor<span class="operator">.</span>insertList(listFormat);</pre> <p>The <a href="qtextcursor.html#createList">QTextCursor::createList</a>() function takes the contents of the cursor's current block and turns it into the first item of a new list.</p> <p>The cursor's current list is found with <a href="qtextcursor.html#currentList">QTextCursor::currentList</a>().</p> <p>The number of items in a list is given by <a href="qtextlist.html#count">count</a>(). Each item can be obtained by its index in the list with the <a href="qtextlist.html#item">item</a>() function. Similarly, the index of a given item can be found with <a href="qtextlist.html#itemNumber">itemNumber</a>(). The text of each item can be found with the <a href="qtextlist.html#itemText">itemText</a>() function.</p> <p>Note that the items in the list may not be adjacent elements in the document. For example, the top-level items in a multi-level list will be separated by the items in lower levels of the list.</p> <p>List items can be deleted by index with the <a href="qtextlist.html#removeItem">removeItem</a>() function. <a href="qtextlist.html#remove">remove</a>() deletes the specified item in the list.</p> <p>The list's format is set with <a href="qtextlist.html#setFormat">setFormat</a>() and read with <a href="qtextlist.html#format">format</a>(). The format describes the decoration of the list itself, and not the individual items.</p> </div> <p><b>See also </b><a href="qtextblock.html">QTextBlock</a>, <a href="qtextlistformat.html">QTextListFormat</a>, and <a href="qtextcursor.html">QTextCursor</a>.</p> <!-- @@@QTextList --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$add[overload1]$$$addconstQTextBlock& --> <h3 class="fn"><a name="add"></a><span class="type">void</span> QTextList::<span class="name">add</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> )</h3> <p>Makes the given <i>block</i> part of the list.</p> <p><b>See also </b><a href="qtextlist.html#remove">remove</a>() and <a href="qtextlist.html#removeItem">removeItem</a>().</p> <!-- @@@add --> <!-- $$$count[overload1]$$$count --> <h3 class="fn"><a name="count"></a><span class="type">int</span> QTextList::<span class="name">count</span> () const</h3> <p>Returns the number of items in the list.</p> <!-- @@@count --> <!-- $$$format[overload1]$$$format --> <h3 class="fn"><a name="format"></a><span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span> QTextList::<span class="name">format</span> () const</h3> <p>Returns the list's format.</p> <p><b>See also </b><a href="qtextlist.html#setFormat">setFormat</a>().</p> <!-- @@@format --> <!-- $$$item[overload1]$$$itemint --> <h3 class="fn"><a name="item"></a><span class="type"><a href="qtextblock.html">QTextBlock</a></span> QTextList::<span class="name">item</span> ( <span class="type">int</span> <i>i</i> ) const</h3> <p>Returns the <i>i</i>-th text block in the list.</p> <p><b>See also </b><a href="qtextlist.html#count">count</a>() and <a href="qtextlist.html#itemText">itemText</a>().</p> <!-- @@@item --> <!-- $$$itemNumber[overload1]$$$itemNumberconstQTextBlock& --> <h3 class="fn"><a name="itemNumber"></a><span class="type">int</span> QTextList::<span class="name">itemNumber</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> ) const</h3> <p>Returns the index of the list item that corresponds to the given <i>block</i>. Returns -1 if the block was not present in the list.</p> <!-- @@@itemNumber --> <!-- $$$itemText[overload1]$$$itemTextconstQTextBlock& --> <h3 class="fn"><a name="itemText"></a><span class="type"><a href="qstring.html">QString</a></span> QTextList::<span class="name">itemText</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> ) const</h3> <p>Returns the text of the list item that corresponds to the given <i>block</i>.</p> <!-- @@@itemText --> <!-- $$$remove[overload1]$$$removeconstQTextBlock& --> <h3 class="fn"><a name="remove"></a><span class="type">void</span> QTextList::<span class="name">remove</span> ( const <span class="type"><a href="qtextblock.html">QTextBlock</a></span> & <i>block</i> )</h3> <p>Removes the given <i>block</i> from the list.</p> <p><b>See also </b><a href="qtextlist.html#add">add</a>() and <a href="qtextlist.html#removeItem">removeItem</a>().</p> <!-- @@@remove --> <!-- $$$removeItem[overload1]$$$removeItemint --> <h3 class="fn"><a name="removeItem"></a><span class="type">void</span> QTextList::<span class="name">removeItem</span> ( <span class="type">int</span> <i>i</i> )</h3> <p>Removes the item at item position <i>i</i> from the list. When the last item in the list is removed, the list is automatically deleted by the <a href="qtextdocument.html">QTextDocument</a> that owns it.</p> <p><b>See also </b><a href="qtextlist.html#add">add</a>() and <a href="qtextlist.html#remove">remove</a>().</p> <!-- @@@removeItem --> <!-- $$$setFormat[overload1]$$$setFormatconstQTextListFormat& --> <h3 class="fn"><a name="setFormat"></a><span class="type">void</span> QTextList::<span class="name">setFormat</span> ( const <span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span> & <i>format</i> )</h3> <p>Sets the list's format to <i>format</i>.</p> <p><b>See also </b><a href="qtextlist.html#format">format</a>().</p> <!-- @@@setFormat --> </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>