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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/***************************************************************************
copyright : (C) 2003-2006 by Robby Stephenson
email : [email protected]
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of version 2 of the GNU General Public License as *
* published by the Free Software Foundation; *
* *
***************************************************************************/
#ifndef IMPORTER_H
#define IMPORTER_H
class QWidget;
#include "../datavectors.h"
#include <klocale.h>
#include <kurl.h>
#include <qobject.h>
#include <qstring.h>
namespace Tellico {
namespace Import {
enum Options {
ImportProgress = 1 << 5 // show progress bar
};
/**
* The top-level abstract class for importing other document formats into Tellico.
*
* The Importer classes import a file, and return a pointer to a newly created
* @ref Data::Collection. Any errors or warnings are added to a status message queue.
* The calling function owns the collection pointer.
*
* @author Robby Stephenson
*/
class Importer : public QObject {
Q_OBJECT
public:
Importer() : QObject(), m_options(ImportProgress) {}
/**
* The constructor should immediately load the contents of the file to be imported.
* Any warnings or errors should be added the the status message queue.
*
* @param url The URL of the file to import
*/
Importer(const KURL& url) : QObject(), m_options(ImportProgress), m_urls(url) {}
Importer(const KURL::List& urls) : QObject(), m_options(ImportProgress), m_urls(urls) {}
Importer(const QString& text) : QObject(), m_options(ImportProgress), m_text(text) {}
/**
*/
virtual ~Importer() {}
/**
* Returns a pointer to a @ref Data::Collection containing the contents of the imported file.
* This function should probably only be called once, but the subclasses may cache the
* collection. The collection should not be created until this function is called.
*
* @return A pointer to a @ref Collection created on the stack, or 0 if none could be created.
*/
virtual Data::CollPtr collection() = 0;
/**
* Returns a string containing all the messages added to the queue in the course of loading
* and importing the file.
*
* @return The status message
*/
const QString& statusMessage() const { return m_statusMsg; }
/**
* Returns a widget with the setting specific to this importer, or 0 if no
* options are needed.
*
* @return A pointer to the setting widget
*/
virtual QWidget* widget(QWidget*, const char*) { return 0; }
/**
* Checks to see if the importer can return a collection of this type
*
* @param type The collection type to check
* @return Whether the importer could return a collection of that type
*/
virtual bool canImport(int) const { return true; }
/**
* Validate the import settings
*/
virtual bool validImport() const { return true; }
virtual void setText(const QString& text) { m_text = text; }
long options() const { return m_options; }
void setOptions(long options) { m_options = options; }
/**
* Returns a string useful for the ProgressManager
*/
QString progressLabel() const {
if(url().isEmpty()) return i18n("Loading data..."); else return i18n("Loading %1...").arg(url().fileName());
}
public slots:
/**
* The import action was changed in the import dialog
*/
virtual void slotActionChanged(int) {}
protected:
/**
* Return the URL of the imported file.
*
* @return the file URL
*/
KURL url() const { return m_urls.isEmpty() ? KURL() : m_urls[0]; }
KURL::List urls() const { return m_urls; }
QString text() const { return m_text; }
/**
* Adds a message to the status queue.
*
* @param msg A string containing a warning or error.
*/
void setStatusMessage(const QString& msg) { if(!msg.isEmpty()) m_statusMsg += msg + QChar(' '); }
static const uint s_stepSize;
private:
long m_options;
KURL::List m_urls;
QString m_text;
QString m_statusMsg;
};
} // end namespace
} // end namespace
#endif
|
