<?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" /> <!-- qsqlindex.cpp --> <title>Qt 4.8: QSqlIndex 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="qtsql.html">QtSql</a></li> <li>QSqlIndex</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">QSqlIndex Class Reference</h1> <!-- $$$QSqlIndex-brief --> <p>The QSqlIndex class provides functions to manipulate and describe database indexes. <a href="#details">More...</a></p> <!-- @@@QSqlIndex --> <pre class="cpp"> <span class="preprocessor">#include <QSqlIndex></span></pre><p><b>Inherits: </b><a href="qsqlrecord.html">QSqlRecord</a>.</p> <ul> <li><a href="qsqlindex-members.html">List of all members, including inherited members</a></li> <li><a href="qsqlindex-qt3.html">Qt 3 support members</a></li> </ul> <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="qsqlindex.html#QSqlIndex">QSqlIndex</a></b> ( const QString & <i>cursorname</i> = QString(), const QString & <i>name</i> = QString() )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#QSqlIndex-2">QSqlIndex</a></b> ( const QSqlIndex & <i>other</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#dtor.QSqlIndex">~QSqlIndex</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#append">append</a></b> ( const QSqlField & <i>field</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#append-2">append</a></b> ( const QSqlField & <i>field</i>, bool <i>desc</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#cursorName">cursorName</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#isDescending">isDescending</a></b> ( int <i>i</i> ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#name">name</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#setCursorName">setCursorName</a></b> ( const QString & <i>cursorName</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#setDescending">setDescending</a></b> ( int <i>i</i>, bool <i>desc</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#setName">setName</a></b> ( const QString & <i>name</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QSqlIndex & </td><td class="memItemRight bottomAlign"><b><a href="qsqlindex.html#operator-eq">operator=</a></b> ( const QSqlIndex & <i>other</i> )</td></tr> </table> <ul> <li class="fn">28 public functions inherited from <a href="qsqlrecord.html#public-functions">QSqlRecord</a></li> </ul> <a name="details"></a> <!-- $$$QSqlIndex-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The QSqlIndex class provides functions to manipulate and describe database indexes.</p> <p>An <i>index</i> refers to a single table or view in a database. Information about the fields that comprise the index can be used to generate SQL statements.</p> </div> <!-- @@@QSqlIndex --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QSqlIndex[overload1]$$$QSqlIndexconstQString&constQString& --> <h3 class="fn"><a name="QSqlIndex"></a>QSqlIndex::<span class="name">QSqlIndex</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>cursorname</i> = QString(), const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> = QString() )</h3> <p>Constructs an empty index using the cursor name <i>cursorname</i> and index name <i>name</i>.</p> <!-- @@@QSqlIndex --> <!-- $$$QSqlIndex$$$QSqlIndexconstQSqlIndex& --> <h3 class="fn"><a name="QSqlIndex-2"></a>QSqlIndex::<span class="name">QSqlIndex</span> ( const <span class="type">QSqlIndex</span> & <i>other</i> )</h3> <p>Constructs a copy of <i>other</i>.</p> <!-- @@@QSqlIndex --> <!-- $$$~QSqlIndex[overload1]$$$~QSqlIndex --> <h3 class="fn"><a name="dtor.QSqlIndex"></a>QSqlIndex::<span class="name">~QSqlIndex</span> ()</h3> <p>Destroys the object and frees any allocated resources.</p> <!-- @@@~QSqlIndex --> <!-- $$$append[overload1]$$$appendconstQSqlField& --> <h3 class="fn"><a name="append"></a><span class="type">void</span> QSqlIndex::<span class="name">append</span> ( const <span class="type"><a href="qsqlfield.html">QSqlField</a></span> & <i>field</i> )</h3> <p>Appends the field <i>field</i> to the list of indexed fields. The field is appended with an ascending sort order.</p> <!-- @@@append --> <!-- $$$append$$$appendconstQSqlField&bool --> <h3 class="fn"><a name="append-2"></a><span class="type">void</span> QSqlIndex::<span class="name">append</span> ( const <span class="type"><a href="qsqlfield.html">QSqlField</a></span> & <i>field</i>, <span class="type">bool</span> <i>desc</i> )</h3> <p>This is an overloaded function.</p> <p>Appends the field <i>field</i> to the list of indexed fields. The field is appended with an ascending sort order, unless <i>desc</i> is true.</p> <!-- @@@append --> <!-- $$$cursorName[overload1]$$$cursorName --> <h3 class="fn"><a name="cursorName"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlIndex::<span class="name">cursorName</span> () const</h3> <p>Returns the name of the cursor which the index is associated with.</p> <p><b>See also </b><a href="qsqlindex.html#setCursorName">setCursorName</a>().</p> <!-- @@@cursorName --> <!-- $$$isDescending[overload1]$$$isDescendingint --> <h3 class="fn"><a name="isDescending"></a><span class="type">bool</span> QSqlIndex::<span class="name">isDescending</span> ( <span class="type">int</span> <i>i</i> ) const</h3> <p>Returns true if field <i>i</i> in the index is sorted in descending order; otherwise returns false.</p> <!-- @@@isDescending --> <!-- $$$name[overload1]$$$name --> <h3 class="fn"><a name="name"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlIndex::<span class="name">name</span> () const</h3> <p>Returns the name of the index.</p> <p><b>See also </b><a href="qsqlindex.html#setName">setName</a>().</p> <!-- @@@name --> <!-- $$$setCursorName[overload1]$$$setCursorNameconstQString& --> <h3 class="fn"><a name="setCursorName"></a><span class="type">void</span> QSqlIndex::<span class="name">setCursorName</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>cursorName</i> )</h3> <p>Sets the name of the cursor that the index is associated with to <i>cursorName</i>.</p> <p><b>See also </b><a href="qsqlindex.html#cursorName">cursorName</a>().</p> <!-- @@@setCursorName --> <!-- $$$setDescending[overload1]$$$setDescendingintbool --> <h3 class="fn"><a name="setDescending"></a><span class="type">void</span> QSqlIndex::<span class="name">setDescending</span> ( <span class="type">int</span> <i>i</i>, <span class="type">bool</span> <i>desc</i> )</h3> <p>If <i>desc</i> is true, field <i>i</i> is sorted in descending order. Otherwise, field <i>i</i> is sorted in ascending order (the default). If the field does not exist, nothing happens.</p> <p><b>See also </b><a href="qsqlindex.html#isDescending">isDescending</a>().</p> <!-- @@@setDescending --> <!-- $$$setName[overload1]$$$setNameconstQString& --> <h3 class="fn"><a name="setName"></a><span class="type">void</span> QSqlIndex::<span class="name">setName</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )</h3> <p>Sets the name of the index to <i>name</i>.</p> <p><b>See also </b><a href="qsqlindex.html#name">name</a>().</p> <!-- @@@setName --> <!-- $$$operator=[overload1]$$$operator=constQSqlIndex& --> <h3 class="fn"><a name="operator-eq"></a><span class="type">QSqlIndex</span> & QSqlIndex::<span class="name">operator=</span> ( const <span class="type">QSqlIndex</span> & <i>other</i> )</h3> <p>Sets the index equal to <i>other</i>.</p> <!-- @@@operator= --> </div> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc 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>