qsqlindex.h Include File

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# qsqlindex.h

This is the verbatim text of the qsqlindex.h include file. It is provided only for illustration; the copyright remains with Trolltech.

    /****************************************************************************
    **
    ** Definition of QSqlIndex class
    **
    ** Created : 2000-11-03
    **
    ** Copyright (C) 2005-2007 Trolltech ASA.  All rights reserved.
    **
    ** This file is part of the sql module of the Qt GUI Toolkit.
    **
    ** This file may be used under the terms of the GNU General Public
    ** License versions 2.0 or 3.0 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file. Alternatively you may (at your option) use any
    ** later version of the GNU General Public License if such license has
    ** been publicly approved by Trolltech ASA (or its successors, if any)
    ** and the KDE Free Qt Foundation.
    **
    ** Please review the following information to ensure GNU General
    ** Public Licensing requirements will be met:
    ** http://trolltech.com/products/qt/licenses/licensing/opensource/.
    ** If you are unsure which license is appropriate for your use, please
    ** review the following information:
    ** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
    ** or contact the sales department at sales@trolltech.com.
    **
    ** This file may be used under the terms of the Q Public License as
    ** defined by Trolltech ASA and appearing in the file LICENSE.QPL
    ** included in the packaging of this file.  Licensees holding valid Qt
    ** Commercial licenses may use this file in accordance with the Qt
    ** Commercial License Agreement provided with the Software.
    **
    ** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
    ** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
    ** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
    ** herein.
    **
    **********************************************************************/

    #ifndef QSQLINDEX_H
    #define QSQLINDEX_H

    #ifndef QT_H
    #include "qstring.h"
    #include "qstringlist.h"
    #include "qsqlfield.h"
    #include "qsqlrecord.h"
    #endif // QT_H

    #if !defined( QT_MODULE_SQL ) || defined( QT_LICENSE_PROFESSIONAL )
    #define QM_EXPORT_SQL
    #define QM_TEMPLATE_EXTERN_SQL
    #else
    #define QM_EXPORT_SQL Q_EXPORT
    #define QM_TEMPLATE_EXTERN_SQL Q_TEMPLATE_EXTERN
    #endif

    #ifndef QT_NO_SQL

    class QSqlCursor;

    class QM_EXPORT_SQL QSqlIndex : public QSqlRecord
    {
    public:
        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 { return cursor; }
        virtual void     setName( const QString& name );
        QString          name() const { return nm; }

        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 );

        QString          toString( const QString& prefix = QString::null,
    			       const QString& sep = ",",
    			       bool verbose = TRUE ) const;
        QStringList      toStringList( const QString& prefix = QString::null,
    				   bool verbose = TRUE ) const;

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

    private:
        QString          createField( int i, const QString& prefix, bool verbose ) const;
        QString          cursor;
        QString          nm;
        QValueList<bool> sorts;
    };

    #define Q_DEFINED_QSQLINDEX
    #include "qwinexport.h"
    #endif	// QT_NO_SQL
    #endif