You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
212 lines
7.5 KiB
212 lines
7.5 KiB
/***************************************************************************
|
|
kmymoneyplugin.h
|
|
-------------------
|
|
begin : Wed Jan 5 2005
|
|
copyright : (C) 2005 Thomas Baumgart
|
|
email : ipwizard@users.sourceforge.net
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
#ifndef KMYMONEYPLUGIN_H
|
|
#define KMYMONEYPLUGIN_H
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// QT Includes
|
|
|
|
#include <tqobject.h>
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// KDE Includes
|
|
|
|
#include <kxmlguiclient.h>
|
|
class TDEAboutData;
|
|
class TDEInstance;
|
|
class TDEAction;
|
|
class TDEToggleAction;
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// Project Includes
|
|
|
|
#include <kmymoney/viewinterface.h>
|
|
#include <kmymoney/statementinterface.h>
|
|
#include <kmymoney/importinterface.h>
|
|
#include <kmymoney/export.h>
|
|
|
|
namespace KMyMoneyPlugin {
|
|
|
|
/**
|
|
* This class describes the interface between the KMyMoney
|
|
* application and it's plugins. All plugins must be derived
|
|
* from this class.
|
|
*
|
|
* A good tutorial on how to design and develop a plugin
|
|
* structure for a KDE application (e.g. KMyMoney) can be found at
|
|
* http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html
|
|
*
|
|
*/
|
|
class KMYMONEY_EXPORT Plugin : public TQObject, public KXMLGUIClient
|
|
{
|
|
TQ_OBJECT
|
|
|
|
public:
|
|
Plugin(TQObject* parent, const char* name);
|
|
virtual ~Plugin();
|
|
|
|
protected:
|
|
/** See KMyMoney2App::action() for a description */
|
|
TDEAction* action(const TQString& name) const;
|
|
|
|
/** See KMyMoney2App::toggleAction() for a description */
|
|
TDEToggleAction* toggleAction(const TQString& name) const;
|
|
|
|
// define interface classes here. The interface classes provide a mechanism
|
|
// for the plugin to interact with KMyMoney
|
|
// they are defined in the following form for an interface
|
|
// named Xxx:
|
|
//
|
|
// XxxInterface* xxxInterface();
|
|
ViewInterface* viewInterface() const;
|
|
StatementInterface* statementInterface() const;
|
|
ImportInterface* importInterface() const;
|
|
};
|
|
|
|
/**
|
|
* This class describes the interface between the KMyMoney
|
|
* application and it's ONLINE-BANKING plugins. All online banking plugins
|
|
* must provide this interface.
|
|
*
|
|
* A good tutorial on how to design and develop a plugin
|
|
* structure for a KDE application (e.g. KMyMoney) can be found at
|
|
* http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html
|
|
*
|
|
*/
|
|
class KMYMONEY_EXPORT OnlinePlugin
|
|
{
|
|
public:
|
|
OnlinePlugin() {}
|
|
virtual ~OnlinePlugin() {}
|
|
|
|
virtual void protocols(TQStringList& protocolList) const = 0;
|
|
|
|
/**
|
|
* This method returns a pointer to a widget representing an additional
|
|
* tab that will be added to the KNewAccountDlg. The string referenced
|
|
* with @a tabName will be filled with the text that should be placed
|
|
* on the tab. It should return 0 if no additional tab is needed.
|
|
*
|
|
* Information about the account can be taken out of @a account.
|
|
*
|
|
* Once the pointer to the widget is returned to KMyMoney, it takes care
|
|
* of destruction of all included widgets when the dialog is closed. The plugin
|
|
* can access the widgets created after the call to storeConfigParameters()
|
|
* happened.
|
|
*/
|
|
virtual TQWidget* accountConfigTab(const MyMoneyAccount& account, TQString& tabName) = 0;
|
|
|
|
/**
|
|
* This method is called by the framework whenever it is time to store
|
|
* the configuration data maintained by the plugin. The plugin should use
|
|
* the widgets created in accountConfigTab() to extract the current values.
|
|
*
|
|
* @param current The @a current container contains the current settings
|
|
*/
|
|
virtual MyMoneyKeyValueContainer onlineBankingSettings(const MyMoneyKeyValueContainer& current) = 0;
|
|
|
|
/**
|
|
* This method is called by the framework when the user wants to map
|
|
* a KMyMoney account onto an online account. The KMyMoney account is identified
|
|
* by @a acc and the online provider should store its data in @a onlineBankingSettings
|
|
* upon success.
|
|
*
|
|
* @retval true if account is mapped
|
|
* @retval false if account is not mapped
|
|
*/
|
|
virtual bool mapAccount(const MyMoneyAccount& acc, MyMoneyKeyValueContainer& onlineBankingSettings) = 0;
|
|
|
|
/**
|
|
* This method is called by the framework when the user wants to update
|
|
* a KMyMoney account with data from an online account. The KMyMoney account is identified
|
|
* by @a acc. The online provider should read its data from acc.onlineBankingSettings().
|
|
* @a true is returned upon success. The plugin might consider to stack the requests
|
|
* in case @a moreAccounts is @p true. @a moreAccounts defaults to @p false.
|
|
*
|
|
* @retval true if account is updated
|
|
* @retval false if account is not updated
|
|
*/
|
|
virtual bool updateAccount(const MyMoneyAccount& acc, bool moreAccounts = false) = 0;
|
|
};
|
|
|
|
/**
|
|
* This class describes the interface between the KMyMoney
|
|
* application and it's IMPORTER plugins. All importer plugins
|
|
* must provide this interface.
|
|
*
|
|
* A good tutorial on how to design and develop a plugin
|
|
* structure for a KDE application (e.g. KMyMoney) can be found at
|
|
* http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html
|
|
*
|
|
*/
|
|
class KMYMONEY_EXPORT ImporterPlugin
|
|
{
|
|
public:
|
|
ImporterPlugin() {}
|
|
virtual ~ImporterPlugin() {}
|
|
|
|
/**
|
|
* This method returns the english-language name of the format
|
|
* this plugin imports, e.g. "OFX"
|
|
*
|
|
* @return TQString Name of the format
|
|
*/
|
|
virtual TQString formatName(void) const = 0;
|
|
|
|
/**
|
|
* This method returns the filename filter suitable for passing to
|
|
* KFileDialog::setFilter(), e.g. "*.ofx *.qfx" which describes how
|
|
* files of this format are likely to be named in the file system
|
|
*
|
|
* @return TQString Filename filter string
|
|
*/
|
|
virtual TQString formatFilenameFilter(void) const = 0;
|
|
|
|
/**
|
|
* This method returns whether this plugin is able to import
|
|
* a particular file.
|
|
*
|
|
* @param filename Fully-qualified pathname to a file
|
|
*
|
|
* @return bool Whether the indicated file is importable by this plugin
|
|
*/
|
|
virtual bool isMyFormat( const TQString& filename ) const = 0;
|
|
|
|
/**
|
|
* Import a file
|
|
*
|
|
* @param filename File to import
|
|
*
|
|
* @return bool Whether the import was successful.
|
|
*/
|
|
virtual bool import( const TQString& filename) = 0;
|
|
|
|
/**
|
|
* Returns the error result of the last import
|
|
*
|
|
* @return TQString English-language name of the error encountered in the
|
|
* last import, or TQString() if it was successful.
|
|
*
|
|
*/
|
|
virtual TQString lastError(void) const = 0;
|
|
|
|
};
|
|
|
|
}; // end of namespace
|
|
#endif
|