From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/ntqsqlindex.html | 155 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 doc/html/ntqsqlindex.html (limited to 'doc/html/ntqsqlindex.html') diff --git a/doc/html/ntqsqlindex.html b/doc/html/ntqsqlindex.html new file mode 100644 index 000000000..453e195c5 --- /dev/null +++ b/doc/html/ntqsqlindex.html @@ -0,0 +1,155 @@ + + + + + +TQSqlIndex Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQSqlIndex Class Reference
[sql module]

+ +

The TQSqlIndex class provides functions to manipulate and +describe TQSqlCursor and TQSqlDatabase indexes. +More... +

#include <ntqsqlindex.h> +

Inherits TQSqlRecord. +

List of all member functions. +

Public Members

+ +

Static Public Members

+ +

Detailed Description

+ + +The TQSqlIndex class provides functions to manipulate and +describe TQSqlCursor and TQSqlDatabase indexes. +

+ +

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

Normally, TQSqlIndex objects are created by TQSqlDatabase or +TQSqlCursor. +

See also Database Classes. + +

Member Function Documentation

+

TQSqlIndex::TQSqlIndex ( const TQString & cursorname = TQString::null, const TQString & name = TQString::null ) +

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

TQSqlIndex::TQSqlIndex ( const TQSqlIndex & other ) +

+Constructs a copy of other. + +

TQSqlIndex::~TQSqlIndex () +

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

void TQSqlIndex::append ( const TQSqlField & field ) [virtual] +

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

Reimplemented from TQSqlRecord. +

void TQSqlIndex::append ( const TQSqlField & 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. + +

TQString TQSqlIndex::cursorName () const +

+ +

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

TQSqlIndex TQSqlIndex::fromStringList ( const TQStringList & l, const TQSqlCursor * 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 TQSqlIndex::isDescending ( int i ) const +

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

TQString TQSqlIndex::name () const +

+ +

Returns the name of the index. + +

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

+Sets the index equal to other. + +

void TQSqlIndex::setCursorName ( const TQString & cursorName ) [virtual] +

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

void TQSqlIndex::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 TQSqlIndex::setName ( const TQString & name ) [virtual] +

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

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

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1