/* This file is part of the KDE project
   Copyright (C) 2006 Jaroslaw Staniek <js@iidea.pl>

   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 KEXIDB_TQUERYSCHEMAPARAMETER_H
#define KEXIDB_TQUERYSCHEMAPARAMETER_H

#include "queryschema.h"

namespace KexiDB
{

//! @short A single parameter of a query schema
class KEXI_DB_EXPORT QuerySchemaParameter
{
	public:
		QuerySchemaParameter();
		~QuerySchemaParameter();

		TQString debugString() const;

		Field::Type type; //!< A datatype of the parameter
		TQString message; //!< A user-visible message that will be displayed to ask for value of the parameter
};

typedef TQValueList<QuerySchemaParameter> QuerySchemaParameterList;
typedef TQValueList<QuerySchemaParameter>::Iterator QuerySchemaParameterListIterator;
typedef TQValueList<QuerySchemaParameter>::ConstIterator QuerySchemaParameterListConstIterator;

//! Shows debug information for \a list
KEXI_DB_EXPORT void debug(const QuerySchemaParameterList& list);

//! @short An iteratof for a list of values of query schema parameters providing 
//! Allows to iterate over parameters and return TQVariant value or well-formatted string.
//! The iterator is initially set to the last item because of the parser requirements
class KEXI_DB_EXPORT QuerySchemaParameterValueListIterator
{
	public:
		QuerySchemaParameterValueListIterator(const Driver& driver, const TQValueList<TQVariant>& params);
		~QuerySchemaParameterValueListIterator();

		//! \return previous value
		TQVariant getPreviousValue();

		//! \return previous value as string formatted using driver's escaping
		TQString getPreviousValueAsString(Field::Type type);
	protected:
		class Private;
		Private * const d;
};

} //namespace KexiDB

#endif