'\" t
.TH TQSqlIndex 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
TQSqlIndex \- Functions to manipulate and describe TQSqlCursor and TQSqlDatabase indexes
.SH SYNOPSIS
\fC#include <tqsqlindex.h>\fR
.PP
Inherits TQSqlRecord.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBTQSqlIndex\fR ( const TQString & cursorname = TQString::null, const TQString & name = TQString::null )"
.br
.ti -1c
.BI "\fBTQSqlIndex\fR ( const TQSqlIndex & other )"
.br
.ti -1c
.BI "\fB~TQSqlIndex\fR ()"
.br
.ti -1c
.BI "TQSqlIndex & \fBoperator=\fR ( const TQSqlIndex & other )"
.br
.ti -1c
.BI "virtual void \fBsetCursorName\fR ( const TQString & cursorName )"
.br
.ti -1c
.BI "TQString \fBcursorName\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetName\fR ( const TQString & name )"
.br
.ti -1c
.BI "TQString \fBname\fR () const"
.br
.ti -1c
.BI "virtual void \fBappend\fR ( const TQSqlField & field )"
.br
.ti -1c
.BI "virtual void \fBappend\fR ( const TQSqlField & field, bool desc )"
.br
.ti -1c
.BI "bool \fBisDescending\fR ( int i ) const"
.br
.ti -1c
.BI "virtual void \fBsetDescending\fR ( int i, bool desc )"
.br
.in -1c
.SS "Static Public Members"
.in +1c
.ti -1c
.BI "TQSqlIndex \fBfromStringList\fR ( const QStringList & l, const TQSqlCursor * cursor )"
.br
.in -1c
.SH DESCRIPTION
The TQSqlIndex class provides functions to manipulate and describe TQSqlCursor and TQSqlDatabase indexes.
.PP
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 TQSqlCursor object.
.PP
Normally, TQSqlIndex objects are created by TQSqlDatabase or TQSqlCursor.
.PP
See also Database Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "TQSqlIndex::TQSqlIndex ( const TQString & cursorname = TQString::null, const TQString & name = TQString::null )"
Constructs an empty index using the cursor name \fIcursorname\fR and index name \fIname\fR.
.SH "TQSqlIndex::TQSqlIndex ( const TQSqlIndex & other )"
Constructs a copy of \fIother\fR.
.SH "TQSqlIndex::~TQSqlIndex ()"
Destroys the object and frees any allocated resources.
.SH "void TQSqlIndex::append ( const TQSqlField & field )\fC [virtual]\fR"
Appends the field \fIfield\fR to the list of indexed fields. The field is appended with an ascending sort order.
.PP
Reimplemented from TQSqlRecord.
.SH "void TQSqlIndex::append ( const TQSqlField & field, bool desc )\fC [virtual]\fR"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Appends the field \fIfield\fR to the list of indexed fields. The field is appended with an ascending sort order, unless \fIdesc\fR is TRUE.
.SH "TQString TQSqlIndex::cursorName () const"
Returns the name of the cursor which the index is associated with.
.SH "TQSqlIndex TQSqlIndex::fromStringList ( const QStringList & l, const TQSqlCursor * cursor )\fC [static]\fR"
Returns an index based on the field descriptions in \fIl\fR and the cursor \fIcursor\fR. The field descriptions should be in the same format that toStringList() produces, for example, a surname field in the people table might be in one of these forms: "surname"," surname DESC" or "people.surname ASC".
.PP
See also toStringList().
.SH "bool TQSqlIndex::isDescending ( int i ) const"
Returns TRUE if field \fIi\fR in the index is sorted in descending order; otherwise returns FALSE.
.SH "TQString TQSqlIndex::name () const"
Returns the name of the index.
.SH "TQSqlIndex & TQSqlIndex::operator= ( const TQSqlIndex & other )"
Sets the index equal to \fIother\fR.
.SH "void TQSqlIndex::setCursorName ( const TQString & cursorName )\fC [virtual]\fR"
Sets the name of the cursor that the index is associated with to \fIcursorName\fR.
.SH "void TQSqlIndex::setDescending ( int i, bool desc )\fC [virtual]\fR"
If \fIdesc\fR is TRUE, field \fIi\fR is sorted in descending order. Otherwise, field \fIi\fR is sorted in ascending order (the default). If the field does not exist, nothing happens.
.SH "void TQSqlIndex::setName ( const TQString & name )\fC [virtual]\fR"
Sets the name of the index to \fIname\fR.
.SH "SEE ALSO"
.BR http://doc.trolltech.com/tqsqlindex.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive TQt documentation is provided in HTML format; it is
located at $TQTDIR/doc/html and can be read using TQt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech.
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (tqsqlindex.3qt) and the Qt
version (3.3.8).
