From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qsqlindex.html | 155 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 doc/html/qsqlindex.html (limited to 'doc/html/qsqlindex.html') diff --git a/doc/html/qsqlindex.html b/doc/html/qsqlindex.html new file mode 100644 index 0000000..9f6b78e --- /dev/null +++ b/doc/html/qsqlindex.html @@ -0,0 +1,155 @@ + + + + + +QSqlIndex Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QSqlIndex Class Reference
[sql module]

+ +

The QSqlIndex class provides functions to manipulate and +describe QSqlCursor and QSqlDatabase indexes. +More... +

#include <qsqlindex.h> +

Inherits QSqlRecord. +

List of all member functions. +

Public Members

+ +

Static Public Members

+ +

Detailed Description

+ + +The QSqlIndex class provides functions to manipulate and +describe QSqlCursor and QSqlDatabase indexes. +

+ +

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 QSqlCursor object. +

Normally, QSqlIndex objects are created by QSqlDatabase or +QSqlCursor. +

See also Database Classes. + +

Member Function Documentation

+

QSqlIndex::QSqlIndex ( const QString & cursorname = QString::null, const QString & name = QString::null ) +

+Constructs an empty index using the cursor name cursorname and +index name name. + +

QSqlIndex::QSqlIndex ( const QSqlIndex & other ) +

+Constructs a copy of other. + +

QSqlIndex::~QSqlIndex () +

+Destroys the object and frees any allocated resources. + +

void QSqlIndex::append ( const QSqlField & field ) [virtual] +

+Appends the field field to the list of indexed fields. The +field is appended with an ascending sort order. + +

Reimplemented from QSqlRecord. +

void QSqlIndex::append ( const QSqlField & field, bool desc ) [virtual] +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Appends the field field to the list of indexed fields. The +field is appended with an ascending sort order, unless desc is +TRUE. + +

QString QSqlIndex::cursorName () const +

+ +

Returns the name of the cursor which the index is associated with. + +

QSqlIndex QSqlIndex::fromStringList ( const QStringList & l, const QSqlCursor * cursor ) [static] +

+Returns an index based on the field descriptions in l and the +cursor cursor. 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". +

See also toStringList(). + +

bool QSqlIndex::isDescending ( int i ) const +

+Returns TRUE if field i in the index is sorted in descending +order; otherwise returns FALSE. + +

QString QSqlIndex::name () const +

+ +

Returns the name of the index. + +

QSqlIndex & QSqlIndex::operator= ( const QSqlIndex & other ) +

+Sets the index equal to other. + +

void QSqlIndex::setCursorName ( const QString & cursorName ) [virtual] +

+Sets the name of the cursor that the index is associated with to +cursorName. + +

void QSqlIndex::setDescending ( int i, bool desc ) [virtual] +

+If desc is TRUE, field i is sorted in descending order. +Otherwise, field i is sorted in ascending order (the default). +If the field does not exist, nothing happens. + +

void QSqlIndex::setName ( const QString & name ) [virtual] +

+Sets the name of the index to name. + + +

+This file is part of the Qt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
Qt 3.3.8
+
+ -- cgit v1.2.3