KMyMoney Plugin API

importinterface.h
1 /*
2  SPDX-FileCopyrightText: 2008 Thomas Baumgart <[email protected]>
3  SPDX-License-Identifier: GPL-2.0-or-later
4 */
5 
6 #ifndef IMPORTINTERFACE_H
7 #define IMPORTINTERFACE_H
8 
9 // ----------------------------------------------------------------------------
10 // QT Includes
11 
12 #include <QFileDialog>
13 #include <QObject>
14 #include <QString>
15 #include <QUrl>
16 
17 // ----------------------------------------------------------------------------
18 // KDE Includes
19 
20 // ----------------------------------------------------------------------------
21 // Project Includes
22 
23 #include <kmm_plugin_export.h>
24 
25 namespace KMyMoneyPlugin {
26 
27 /**
28  * This abstract class represents the ImportInterface to
29  * add new importers to KMyMoney.
30  */
31 class KMM_PLUGIN_EXPORT ImportInterface : public QObject
32 {
33  Q_OBJECT
34 
35 public:
36  explicit ImportInterface(QObject* parent, const char* name = 0);
37  virtual ~ImportInterface();
38 
39  /**
40  * This method is provided by KMyMoney to select a file to
41  * be imported. A caption for the dialog can be provided via
42  * @a title, a specific directory to be started with as @a path.
43  * Which files are selectable is controlled via the contents
44  * of @a mask. @a mode controls the behavior of the dialog. In case
45  * the importer requires additional information, it can provide
46  * a widget to ask for them. If none are required, pass 0.
47  *
48  * @note In case you create a widget and pass it to selectFile()
49  * you are responsible to delete the widget. It will not be deleted
50  * automatically during the destruction of the dialog.
51  */
52  virtual QUrl selectFile(const QString& title, const QString& path, const QString& mask, QFileDialog::FileMode mode, QWidget* widget) const = 0;
53 
54 Q_SIGNALS:
55 };
56 
57 } // namespace
58 #endif
This abstract class represents the ImportInterface to add new importers to KMyMoney.
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Oct 19 2021 23:23:38 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.