<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > TQSqlIndex 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 > TQSqlIndex Class Reference< br > < small > [< a href = "sql.html" > sql module< / a > ]< / small > < / h1 >
< p > The TQSqlIndex class provides functions to manipulate and
describe TQSqlCursor and TQSqlDatabase indexes.
< a href = "#details" > More...< / a >
< p > < tt > #include < < a href = "tqsqlindex-h.html" > tqsqlindex.h< / a > > < / tt >
< p > Inherits < a href = "tqsqlrecord.html" > TQSqlRecord< / a > .
< p > < a href = "tqsqlindex-members.html" > List of all member functions.< / a >
< h2 > Public Members< / h2 >
< ul >
< li class = fn > < a href = "#TQSqlIndex" > < b > TQSqlIndex< / b > < / a > ( const TQString & cursorname = TQString::null, const TQString & name = TQString::null )< / li >
< li class = fn > < a href = "#TQSqlIndex-2" > < b > TQSqlIndex< / b > < / a > ( const TQSqlIndex & other )< / li >
< li class = fn > < a href = "#~TQSqlIndex" > < b > ~TQSqlIndex< / b > < / a > ()< / li >
< li class = fn > TQSqlIndex & < a href = "#operator-eq" > < b > operator=< / b > < / a > ( const TQSqlIndex & other )< / li >
< li class = fn > virtual void < a href = "#setCursorName" > < b > setCursorName< / b > < / a > ( const TQString & cursorName )< / li >
< li class = fn > TQString < a href = "#cursorName" > < b > cursorName< / b > < / a > () const< / li >
< li class = fn > virtual void < a href = "#setName" > < b > setName< / b > < / a > ( const TQString & name )< / li >
< li class = fn > TQString < a href = "#name" > < b > name< / b > < / a > () const< / li >
< li class = fn > virtual void < a href = "#append" > < b > append< / b > < / a > ( const TQSqlField & field )< / li >
< li class = fn > virtual void < a href = "#append-2" > < b > append< / b > < / a > ( const TQSqlField & 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 > TQSqlIndex < a href = "#fromStringList" > < b > fromStringList< / b > < / a > ( const TQStringList & l, const TQSqlCursor * cursor )< / li >
< / ul >
< hr > < a name = "details" > < / a > < h2 > Detailed Description< / h2 >
The TQSqlIndex class provides functions to manipulate and
describe < a href = "tqsqlcursor.html" > TQSqlCursor< / a > and < a href = "tqsqldatabase.html" > TQSqlDatabase< / a > indexes.
< p >
< p > This class is used to describe and manipulate TQSqlCursor and
TQSqlDatabase 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 = "tqsqlcursor.html" > TQSqlCursor< / a > object.
< p > Normally, TQSqlIndex objects are created by < a href = "tqsqldatabase.html" > TQSqlDatabase< / a > or
TQSqlCursor.
< p > See also < a href = "database.html" > Database Classes< / a > .
< hr > < h2 > Member Function Documentation< / h2 >
< h3 class = fn > < a name = "TQSqlIndex" > < / a > TQSqlIndex::TQSqlIndex ( const < a href = "tqstring.html" > TQString< / a > & cursorname = TQString::null, const < a href = "tqstring.html" > TQString< / a > & name = TQString::null )
< / h3 >
Constructs an empty index using the cursor name < em > cursorname< / em > and
index name < em > name< / em > .
< h3 class = fn > < a name = "TQSqlIndex-2" > < / a > TQSqlIndex::TQSqlIndex ( const < a href = "tqsqlindex.html" > TQSqlIndex< / a > & other )
< / h3 >
Constructs a copy of < em > other< / em > .
< h3 class = fn > < a name = "~TQSqlIndex" > < / a > TQSqlIndex::~TQSqlIndex ()
< / h3 >
Destroys the object and frees any allocated resources.
< h3 class = fn > void < a name = "append" > < / a > TQSqlIndex::append ( const < a href = "tqsqlfield.html" > TQSqlField< / 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 = "tqsqlrecord.html#append" > TQSqlRecord< / a > .
< h3 class = fn > void < a name = "append-2" > < / a > TQSqlIndex::append ( const < a href = "tqsqlfield.html" > TQSqlField< / 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 = "tqstring.html" > TQString< / a > < a name = "cursorName" > < / a > TQSqlIndex::cursorName () const
< / h3 >
< p > Returns the name of the cursor which the index is associated with.
< h3 class = fn > < a href = "tqsqlindex.html" > TQSqlIndex< / a > < a name = "fromStringList" > < / a > TQSqlIndex::fromStringList ( const < a href = "tqstringlist.html" > TQStringList< / a > & l, const < a href = "tqsqlcursor.html" > TQSqlCursor< / 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 = "tqsqlrecord.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 = "tqsqlrecord.html#toStringList" > toStringList< / a > ().
< h3 class = fn > bool < a name = "isDescending" > < / a > TQSqlIndex::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 = "tqstring.html" > TQString< / a > < a name = "name" > < / a > TQSqlIndex::name () const
< / h3 >
< p > Returns the name of the index.
< h3 class = fn > < a href = "tqsqlindex.html" > TQSqlIndex< / a > & < a name = "operator-eq" > < / a > TQSqlIndex::operator= ( const < a href = "tqsqlindex.html" > TQSqlIndex< / a > & other )
< / h3 >
Sets the index equal to < em > other< / em > .
< h3 class = fn > void < a name = "setCursorName" > < / a > TQSqlIndex::setCursorName ( const < a href = "tqstring.html" > TQString< / 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 > TQSqlIndex::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 > TQSqlIndex::setName ( const < a href = "tqstring.html" > TQString< / 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" > TQt 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 > TQt 3.3.8< / div >
< / table > < / div > < / address > < / body >
< / html >
