summaryrefslogtreecommitdiffstats
path: root/kexi/plugins/importexport/csv/kexicsvexport.h
blob: 393da17a0fb322975789896eace99e695e35f967 (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/* This file is part of the KDE project
   Copyright (C) 2005,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 KEXI_CSVEXPORT_H
#define KEXI_CSVEXPORT_H

#include <kexidb/utils.h>

namespace KexiCSVExport
{

//! Exporting mode: a file or clipboard
enum Mode { Clipboard, File };

//! Options used in KexiCSVExportWizard contructor.
class Options {
	public:
		Options();
	
		//! Assigns \a args. \return false on failure.
		bool assign( TQMap<TQString,TQString>& args );

		Mode mode;
		int itemId; //!< Table or query ID
		TQString fileName;
		TQString delimiter;
		TQString forceDelimiter; //!< Used for "clipboard" mode
		TQString textQuote;
		bool addColumnNames : 1;
};

/*! Exports data. \return false on failure.
 @param options options for the export
 @param rowCount row count of the input data or -1 if the row cound has not yet been computed
 @param predefinedTextStream text stream that should be used instead of writing to a file
*/
bool exportData(KexiDB::TableOrQuerySchema& tableOrQuery, const Options& options, int rowCount = -1, 
	TQTextStream *predefinedTextStream = 0);

}

#endif