KMyMoney Plugin API

statementinterface.h
1 /*
2  SPDX-FileCopyrightText: 2005-2018 Thomas Baumgart <[email protected]>
3  SPDX-License-Identifier: GPL-2.0-or-later
4 */
5 
6 #ifndef STATEMENTINTERFACE_H
7 #define STATEMENTINTERFACE_H
8 
9 // ----------------------------------------------------------------------------
10 // QT Includes
11 
12 #include <QObject>
13 
14 // ----------------------------------------------------------------------------
15 // KDE Includes
16 
17 // ----------------------------------------------------------------------------
18 // Project Includes
19 
20 #include <kmm_plugin_export.h>
21 
22 class MyMoneyAccount;
23 class MyMoneyStatement;
24 class MyMoneyKeyValueContainer;
25 
26 namespace KMyMoneyPlugin {
27 
28 /**
29  * This abstract class represents the interface to import statements
30  * into the KMyMoney application
31  */
32 class KMM_PLUGIN_EXPORT StatementInterface : public QObject
33 {
34  Q_OBJECT
35 
36 public:
37  explicit StatementInterface(QObject* parent, const char* name = 0);
38  virtual ~StatementInterface();
39 
40  virtual void resetMessages() const = 0;
41  virtual void showMessages(int statementCount) const = 0;
42 
43  /**
44  * This method imports a MyMoneyStatement into the engine
45  */
46  virtual QStringList import(const MyMoneyStatement& s, bool silent = false) = 0;
47 
48  /**
49  * This method returns the account for a given @a key - @a value pair.
50  * If the account is not found in the list of accounts, MyMoneyAccount()
51  * is returned.
52  */
53  virtual MyMoneyAccount account(const QString& key, const QString& value) const = 0;
54 
55  /**
56  */
57  virtual void setAccountOnlineParameters(const MyMoneyAccount& acc, const MyMoneyKeyValueContainer& kvps) const = 0;
58 };
59 
60 } // namespace
61 #endif
This abstract class represents the interface to import statements into the KMyMoney application.
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Fri Dec 1 2023 03:48:57 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.