doc/src/q3sqlrecordinfo.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the documentation of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 /*!
  43     \class Q3SqlRecordInfo
  44     \brief The Q3SqlRecordInfo class encapsulates a set of database field meta data.
  45
  46     \compat
  47
  48     This class is a list that holds a set of database field meta
  49     data. Use contains() to see if a given field name exists in the
  50     record, and use find() to get a QSqlFieldInfo record for a named
  51     field.
  52
  53     \sa Q3SqlFieldInfo
  54 */
  55
  56 /*!
  57     \fn Q3SqlRecordInfo::Q3SqlRecordInfo()
  58
  59     Constructs an empty record info object.
  60 */
  61
  62 /*!
  63     \fn Q3SqlRecordInfo::Q3SqlRecordInfo(const Q3SqlFieldInfoList& other)
  64     \fn Q3SqlRecordInfo::Q3SqlRecordInfo(const QSqlRecord& other)
  65
  66     Constructs a copy of \a other.
  67 */
  68
  69 /*!
  70     \fn size_type Q3SqlRecordInfo::contains(const QString& fieldName) const
  71
  72     Returns the number of times a field called \a fieldName occurs in
  73     the record. Returns 0 if no field by that name could be found.
  74 */
  75
  76 /*!
  77     \fn Q3SqlFieldInfo Q3SqlRecordInfo::find(const QString& fieldName) const
  78
  79     Returns a QSqlFieldInfo object for the first field in the record
  80     which has the field name \a fieldName. If no matching field is
  81     found then an empty QSqlFieldInfo object is returned.
  82 */
  83
  84 /*!
  85     \fn QSqlRecord Q3SqlRecordInfo::toRecord() const
  86
  87     Returns an empty QSqlRecord based on the field information
  88     in this Q3SqlRecordInfo.
  89 */