summaryrefslogtreecommitdiffstats
path: root/kexi/widget/kexiqueryparameters.h
blob: 00bd0b67677aaef98a1e6df324e6f1e36f470941 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/* This file is part of the KDE project
   Copyright (C) 2006 Jaroslaw Staniek <[email protected]>

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

#include <kexidb/queryschema.h>

//! @short Utilities providing GUI for getting query parameters
class KEXIEXTWIDGETS_EXPORT KexiQueryParameters
{
	public:
		/*! Asks for query parameters using KInputDialog, one dialog per query parameter 
		 (see @ref KexiDB::QuerySchema::parameters()). The type of each dialog depends 
		 on the type of query parameter.
		 \return list of values obtained from the user
		 \a ok is set to true on success and to false on failure. */
	//! @todo do not use KInputDialog - switch to more powerful custom dialog
	//! @todo offer option to display one dialog (form) with all the parameters
	//! @todo support more types (using validators)
	//! @todo support defaults 
	//! @todo support validation rules, e.g. min/max value, unsigned
	//! @todo support Enum type (list of strings, need support for keys and user-visible strings)
		static TQValueList<TQVariant> getParameters(TQWidget *parent, const KexiDB::Driver &driver, 
			KexiDB::QuerySchema& querySchema, bool &ok);
};

#endif // KEXIDBCONNECTIONWIDGET_H