File indexing completed on 2024-04-14 14:53:33

 /* This file is part of the KDE project
    Copyright (C) 2006-2010 Jarosław Staniek <staniek@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
 */
 
 #ifndef KDB_QUERYSCHEMAPARAMETER_H
 #define KDB_QUERYSCHEMAPARAMETER_H
 
 #include "KDbField.h"
 
 //! @short A single parameter of a query schema
 class KDB_EXPORT KDbQuerySchemaParameter //SDC: operator==
 {
 public:
     /*!
     @getter
     @return datatype of the parameter.
     @setter
     Sets a datatype of the parameter.
     */
     KDbField::Type type; //SDC: default=KDbField::InvalidType
 
     /*!
     @getter
     @return user-visible message that will be displayed when asking for value of the parameter.
     @setter
     Sets user-visible message that will be displayed when asking for value of the parameter.
     */
     QString message; //SDC:
 };
 
 //! @short An iterator for a list of values of query schema parameters
 //! Allows to iterate over parameters and returns QVariant value or well-formatted string.
 //! The iterator is initially set to the last item because of the parser requirements
 class KDB_EXPORT KDbQuerySchemaParameterValueListIterator
 {
 public:
     explicit KDbQuerySchemaParameterValueListIterator(const QList<QVariant>& params);
     ~KDbQuerySchemaParameterValueListIterator();
 
     //! @return previous value
     QVariant previousValue() const;
 
 private:
     Q_DISABLE_COPY(KDbQuerySchemaParameterValueListIterator)
     class Private;
     Private * const d;
 };
 
 //! Sends information about query schema parameter @a parameter to debug output @a dbg.
 KDB_EXPORT QDebug operator<<(QDebug dbg, const KDbQuerySchemaParameter& parameter);
 
 //! Sends information about query schema parameter list @a list to debug output @a dbg.
 KDB_EXPORT QDebug operator<<(QDebug dbg, const QList<KDbQuerySchemaParameter>& list);
 
 #endif