KMyMoney Plugin API
kmymoneyplugin.h
54 * KMyMoney knows several types of plugins. The most common and generic one is KMyMoneyPlugin::Plugin.
56 * Another group of plugins are just loaded on demand and offer special functions with a tight integration into KMyMoney. Whenever possible you should use this
67 * The plugins are based on Qt 5's plugin system. So you must compile json information into the plugin.
68 * KMyMoney looks into the folder "${PLUGIN_INSTALL_DIR}/kmymoney/" and loads all plugins found there (if the user did not deactivate the plugin).
70 * The json header of the plugin must comply with the requirements of KCoreAddon's KPluginMetaData class.
73 * @warning The plugin system for KMyMoney 5 is still in development. Especially the loading of the on-demand plugins (mainly undocumented :( ) will change.
165 * http://web.archive.org/web/20100305214125/http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html
198 virtual MyMoneyKeyValueContainer onlineBankingSettings(const MyMoneyKeyValueContainer& current) = 0;
209 virtual bool mapAccount(const MyMoneyAccount& acc, MyMoneyKeyValueContainer& onlineBankingSettings) = 0;
231 * http://web.archive.org/web/20100305214125/http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html
355 QMap<QString, Plugin*> standard; // this should contain all loaded plugins because every plugin should inherit Plugin class
357 QMap<QString, OnlinePluginExtended*> extended; // casted standard plugin, if such interface is available
358 QMap<QString, ImporterPlugin*> importer; // casted standard plugin, if such interface is available
359 QMap<QString, StoragePlugin*> storage; // casted standard plugin, if such interface is available
This class describes the interface between the KMyMoney application and its data plugins.
Definition kmymoneyplugin.h:335
virtual QVariant requestData(const QString &arg, uint type)=0
Gets data from data service.
This abstract class represents the ImportInterface to add new importers to KMyMoney.
Definition importinterface.h:32
This class describes the interface between the KMyMoney application and it's IMPORTER plugins.
Definition kmymoneyplugin.h:235
virtual QString lastError() const =0
Returns the error result of the last import.
virtual QStringList formatMimeTypes() const =0
This method returns the list of the MIME types that this plugin handles, e.g.
Interface between KMyMoney and Online Banking plugins for executing transactions.
Definition onlinepluginextended.h:30
This class describes the interface between the KMyMoney application and it's ONLINE-BANKING plugins.
Definition kmymoneyplugin.h:169
virtual MyMoneyKeyValueContainer onlineBankingSettings(const MyMoneyKeyValueContainer ¤t)=0
This method is called by the framework whenever it is time to store the configuration data maintained...
virtual bool mapAccount(const MyMoneyAccount &acc, MyMoneyKeyValueContainer &onlineBankingSettings)=0
This method is called by the framework when the user wants to map a KMyMoney account onto an online a...
virtual QWidget * accountConfigTab(const MyMoneyAccount &account, QString &tabName)=0
This method returns a pointer to a widget representing an additional tab that will be added to the KN...
virtual bool updateAccount(const MyMoneyAccount &acc, bool moreAccounts=false)=0
This method is called by the framework when the user wants to update a KMyMoney account with data fro...
This class describes the interface between KMyMoney and it's plugins.
Definition kmymoneyplugin.h:107
This abstract class represents the interface to import statements into the KMyMoney application.
Definition statementinterface.h:33
This class describes the interface between the KMyMoney application and it's STORAGE plugins.
Definition kmymoneyplugin.h:287
virtual eKMyMoney::StorageType storageType() const =0
Storage identifier.
virtual QUrl openUrl() const =0
returns the full URL used to open the database (incl.
This abstract class represents the ViewInterface to add new view pages to the JanusWidget of KMyMoney...
Definition viewinterface.h:48
KMM_PLUGIN_EXPORT KMyMoneyPlugin::Container pPlugins
Structure of plugins objects by their interfaces.
Definition kmymoneyplugin.cpp:27
The Container struct to hold all plugin interfaces.
Definition kmymoneyplugin.h:354
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 8 2024 11:52:51 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 8 2024 11:52:51 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.