KDb

KDbQuerySchemaParameter.shared.h
1 /* This file is part of the KDE project
2  Copyright (C) 2006-2010 JarosÅ‚aw Staniek <[email protected]>
3 
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef KDB_QUERYSCHEMAPARAMETER_H
21 #define KDB_QUERYSCHEMAPARAMETER_H
22 
23 #include "KDbField.h"
24 
25 //! @short A single parameter of a query schema
26 class KDB_EXPORT KDbQuerySchemaParameter //SDC: operator==
27 {
28 public:
29  /*!
30  @getter
31  @return datatype of the parameter.
32  @setter
33  Sets a datatype of the parameter.
34  */
35  KDbField::Type type; //SDC: default=KDbField::InvalidType
36 
37  /*!
38  @getter
39  @return user-visible message that will be displayed when asking for value of the parameter.
40  @setter
41  Sets user-visible message that will be displayed when asking for value of the parameter.
42  */
43  QString message; //SDC:
44 };
45 
46 //! @short An iterator for a list of values of query schema parameters
47 //! Allows to iterate over parameters and returns QVariant value or well-formatted string.
48 //! The iterator is initially set to the last item because of the parser requirements
50 {
51 public:
54 
55  //! @return previous value
56  QVariant previousValue() const;
57 
58 private:
60  class Private;
61  Private * const d;
62 };
63 
64 //! Sends information about query schema parameter @a parameter to debug output @a dbg.
65 KDB_EXPORT QDebug operator<<(QDebug dbg, const KDbQuerySchemaParameter& parameter);
66 
67 //! Sends information about query schema parameter list @a list to debug output @a dbg.
68 KDB_EXPORT QDebug operator<<(QDebug dbg, const QList<KDbQuerySchemaParameter>& list);
69 
70 #endif
An iterator for a list of values of query schema parameters Allows to iterate over parameters and ret...
A single parameter of a query schema.
QDataStream & operator<<(QDataStream &out, const KDateTime &dateTime)
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sat Jun 25 2022 06:21:33 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.