QSqlIndex(3qt)

📦 version 3.3.8b, in fedora 43, fedora 44

💖 QSqlIndex — the qsqlindex.3qt glow-up 💖

okay bestie, welcome to the QSqlIndex(3qt) page ✨ this is a Qt 3 man page, so grab a strawberry drink 🍓 and let's get into it.

✨ NAME ✨

QSqlIndex — functions to manipulate and describe QSqlCursor and QSqlDatabase indexes. no cap, that's literally the whole vibe. 👑

🌸 SYNOPSIS 🌸

#include <qsqlindex.h>

it inherits QSqlRecord, so all that inherited energy is coming along for the ride 🦋

💅 Public Members 💅

QSqlIndex ( const QString & cursorname = QString::null, const QString &
    name = QString::null )
QSqlIndex ( const QSqlIndex & other )
~QSqlIndex ()
QSqlIndex & operator= ( const QSqlIndex & other )
virtual void setCursorName ( const QString & cursorName )
QString cursorName () const
virtual void setName ( const QString & name )
QString name () const
virtual void append ( const QSqlField & field )
virtual void append ( const QSqlField & field, bool desc )
bool isDescending ( int i ) const
virtual void setDescending ( int i, bool desc )

⭐ Static Public Members ⭐

QSqlIndex fromStringList ( const QStringList & l, const QSqlCursor *
    cursor )

🎀 DESCRIPTION 🎀

the QSqlIndex class provides functions to manipulate and describe QSqlCursor and QSqlDatabase indexes. periodt.

so like, this class is the class for describing and manipulating QSqlCursor and QSqlDatabase indexes. an index refers to a single table or view in a database — one table, one view, that's the whole situation, no polyamory there 🙈

and the info about the fields that make up the index? you can use that to generate SQL statements, or to affect the behavior of a QSqlCursor object. it's giving "the index knows things and you can absolutely use those things" 💅

normally, QSqlIndex objects are created by QSqlDatabase or QSqlCursor. like, you're not usually the one making them — they just show up, main character behavior honestly ✨

see also Database Classes. (the original said "See also", we're keeping it, it's iconic)

👑 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. empty index, full potential, we love a blank canvas 🌈

QSqlIndex::QSqlIndex ( const QSqlIndex & other )

constructs a copy of other. twin behavior, no notes 💖

QSqlIndex::~QSqlIndex ()

destroys the object and frees any allocated resources. she's done, she's resting, she ate and left no crumbs 💀

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. (so like, the parent class had a version, this one's the glow-up ✨)

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. lowkey the same, highkey convenient 🫶

appends the field field to the list of indexed fields. the field is appended with an ascending sort order, unless desc is TRUE. so if you pass TRUE in that desc slot, it's not ascending anymore, iykyk 😌

QString QSqlIndex::cursorName () const

returns the name of the cursor which the index is associated with. it's the cursor's name, that's it, that's the whole function 🎀

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. vibe check on field i, basically 📉

QString QSqlIndex::name () const

returns the name of the index. that's her name, that's her whole identity 💜

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

sets the index equal to other. copy-paste but make it official ✨

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

sets the name of the cursor that the index is associated with to cursorName. naming rights, but for cursors 🦋

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. no error, no drama, just silence 🫠

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

sets the name of the index to name. giving the index its little name tag 🏷️

🌈 SEE ALSO 🌈

Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

🌟 AUTHOR 🌟

Generated automatically from the source code. (no human author, just vibes and a code generator 🤖✨)

😭 BUGS 😭

if you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. good bug reports help us to help you. thank you. 🫶 (fr fr, good bug reports are the love language of open source)

the definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt 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.

⚠️ heads up bestie: this man page format is a convenience, not officially supported by Trolltech. the HTML docs are the definitive ones. do not come for this page when the HTML says something else, ok? 🙈

if you find errors in this manual page, please report them to qt-bugs@trolltech.com. please include the name of the manual page (qsqlindex.3qt) and the Qt version (3.3.8). include both, or the report is incomplete, periodt 💅

and that's the page!! 🌸 this one's from Trolltech AS, dated 2 February 2007, and it's the QSqlIndex(3qt) man page, Qt version 3.3.8. slay, go index something, mwah 💖✨🎀

📦 where this page comes from