1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/sql/qsqlindex.cpp:43 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QSqlIndex Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td 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="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped Classes</font></a>
| <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QSqlIndex Class Reference<br><small>[<a href="sql.html">sql module</a>]</small></h1>
<p>The QSqlIndex class provides functions to manipulate and
describe QSqlCursor and QSqlDatabase indexes.
<a href="#details">More...</a>
<p><tt>#include <<a href="qsqlindex-h.html">qsqlindex.h</a>></tt>
<p>Inherits <a href="qsqlrecord.html">QSqlRecord</a>.
<p><a href="qsqlindex-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QSqlIndex"><b>QSqlIndex</b></a> ( const QString & cursorname = QString::null, const QString & name = QString::null )</li>
<li class=fn><a href="#QSqlIndex-2"><b>QSqlIndex</b></a> ( const QSqlIndex & other )</li>
<li class=fn><a href="#~QSqlIndex"><b>~QSqlIndex</b></a> ()</li>
<li class=fn>QSqlIndex & <a href="#operator-eq"><b>operator=</b></a> ( const QSqlIndex & other )</li>
<li class=fn>virtual void <a href="#setCursorName"><b>setCursorName</b></a> ( const QString & cursorName )</li>
<li class=fn>QString <a href="#cursorName"><b>cursorName</b></a> () const</li>
<li class=fn>virtual void <a href="#setName"><b>setName</b></a> ( const QString & name )</li>
<li class=fn>QString <a href="#name"><b>name</b></a> () const</li>
<li class=fn>virtual void <a href="#append"><b>append</b></a> ( const QSqlField & field )</li>
<li class=fn>virtual void <a href="#append-2"><b>append</b></a> ( const QSqlField & field, bool desc )</li>
<li class=fn>bool <a href="#isDescending"><b>isDescending</b></a> ( int i ) const</li>
<li class=fn>virtual void <a href="#setDescending"><b>setDescending</b></a> ( int i, bool desc )</li>
</ul>
<h2>Static Public Members</h2>
<ul>
<li class=fn>QSqlIndex <a href="#fromStringList"><b>fromStringList</b></a> ( const QStringList & l, const QSqlCursor * cursor )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The QSqlIndex class provides functions to manipulate and
describe <a href="qsqlcursor.html">QSqlCursor</a> and <a href="qsqldatabase.html">QSqlDatabase</a> indexes.
<p>
<p> This class is used to describe and manipulate QSqlCursor and
QSqlDatabase indexes. An index 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, or to affect the
behavior of a <a href="qsqlcursor.html">QSqlCursor</a> object.
<p> Normally, QSqlIndex objects are created by <a href="qsqldatabase.html">QSqlDatabase</a> or
QSqlCursor.
<p>See also <a href="database.html">Database Classes</a>.
<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QSqlIndex"></a>QSqlIndex::QSqlIndex ( const <a href="qstring.html">QString</a> & cursorname = QString::null, const <a href="qstring.html">QString</a> & name = QString::null )
</h3>
Constructs an empty index using the cursor name <em>cursorname</em> and
index name <em>name</em>.
<h3 class=fn><a name="QSqlIndex-2"></a>QSqlIndex::QSqlIndex ( const <a href="qsqlindex.html">QSqlIndex</a> & other )
</h3>
Constructs a copy of <em>other</em>.
<h3 class=fn><a name="~QSqlIndex"></a>QSqlIndex::~QSqlIndex ()
</h3>
Destroys the object and frees any allocated resources.
<h3 class=fn>void <a name="append"></a>QSqlIndex::append ( const <a href="qsqlfield.html">QSqlField</a> & field )<tt> [virtual]</tt>
</h3>
Appends the field <em>field</em> to the list of indexed fields. The
field is appended with an ascending sort order.
<p>Reimplemented from <a href="qsqlrecord.html#append">QSqlRecord</a>.
<h3 class=fn>void <a name="append-2"></a>QSqlIndex::append ( const <a href="qsqlfield.html">QSqlField</a> & field, bool desc )<tt> [virtual]</tt>
</h3>
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
<p> Appends the field <em>field</em> to the list of indexed fields. The
field is appended with an ascending sort order, unless <em>desc</em> is
TRUE.
<h3 class=fn><a href="qstring.html">QString</a> <a name="cursorName"></a>QSqlIndex::cursorName () const
</h3>
<p> Returns the name of the cursor which the index is associated with.
<h3 class=fn><a href="qsqlindex.html">QSqlIndex</a> <a name="fromStringList"></a>QSqlIndex::fromStringList ( const <a href="qstringlist.html">QStringList</a> & l, const <a href="qsqlcursor.html">QSqlCursor</a> * cursor )<tt> [static]</tt>
</h3>
Returns an index based on the field descriptions in <em>l</em> and the
cursor <em>cursor</em>. The field descriptions should be in the same
format that <a href="qsqlrecord.html#toStringList">toStringList</a>() produces, for example, a surname field
in the people table might be in one of these forms: "surname",
"surname DESC" or "people.surname ASC".
<p> <p>See also <a href="qsqlrecord.html#toStringList">toStringList</a>().
<h3 class=fn>bool <a name="isDescending"></a>QSqlIndex::isDescending ( int i ) const
</h3>
Returns TRUE if field <em>i</em> in the index is sorted in descending
order; otherwise returns FALSE.
<h3 class=fn><a href="qstring.html">QString</a> <a name="name"></a>QSqlIndex::name () const
</h3>
<p> Returns the name of the index.
<h3 class=fn><a href="qsqlindex.html">QSqlIndex</a> & <a name="operator-eq"></a>QSqlIndex::operator= ( const <a href="qsqlindex.html">QSqlIndex</a> & other )
</h3>
Sets the index equal to <em>other</em>.
<h3 class=fn>void <a name="setCursorName"></a>QSqlIndex::setCursorName ( const <a href="qstring.html">QString</a> & cursorName )<tt> [virtual]</tt>
</h3>
Sets the name of the cursor that the index is associated with to
<em>cursorName</em>.
<h3 class=fn>void <a name="setDescending"></a>QSqlIndex::setDescending ( int i, bool desc )<tt> [virtual]</tt>
</h3>
If <em>desc</em> is TRUE, field <em>i</em> is sorted in descending order.
Otherwise, field <em>i</em> is sorted in ascending order (the default).
If the field does not exist, nothing happens.
<h3 class=fn>void <a name="setName"></a>QSqlIndex::setName ( const <a href="qstring.html">QString</a> & name )<tt> [virtual]</tt>
</h3>
Sets the name of the index to <em>name</em>.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright © 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright © 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>
|
