KMyMoneyPlugin::ImporterPlugin Class Reference

#include <kmymoneyplugin.h>

Inheritance diagram for KMyMoneyPlugin::ImporterPlugin:

OfxImporterPlugin

List of all members.

Public Member Functions

 ImporterPlugin ()
virtual ~ImporterPlugin ()
virtual QString formatName (void) const =0
virtual QString formatFilenameFilter (void) const =0
virtual bool isMyFormat (const QString &filename) const =0
virtual bool import (const QString &filename)=0
virtual QString lastError (void) const =0


Detailed Description

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


Constructor & Destructor Documentation

KMyMoneyPlugin::ImporterPlugin::ImporterPlugin (  )  [inline]

virtual KMyMoneyPlugin::ImporterPlugin::~ImporterPlugin (  )  [inline, virtual]


Member Function Documentation

virtual QString KMyMoneyPlugin::ImporterPlugin::formatName ( void   )  const [pure virtual]

This method returns the english-language name of the format this plugin imports, e.g. "OFX"

Returns:
QString Name of the format

Implemented in OfxImporterPlugin.

virtual QString KMyMoneyPlugin::ImporterPlugin::formatFilenameFilter ( void   )  const [pure virtual]

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

Returns:
QString Filename filter string

Implemented in OfxImporterPlugin.

virtual bool KMyMoneyPlugin::ImporterPlugin::isMyFormat ( const QString &  filename  )  const [pure virtual]

This method returns whether this plugin is able to import a particular file.

Parameters:
filename Fully-qualified pathname to a file
Returns:
bool Whether the indicated file is importable by this plugin

Implemented in OfxImporterPlugin.

virtual bool KMyMoneyPlugin::ImporterPlugin::import ( const QString &  filename  )  [pure virtual]

Import a file

Parameters:
filename File to import
Returns:
bool Whether the import was successful.

Implemented in OfxImporterPlugin.

virtual QString KMyMoneyPlugin::ImporterPlugin::lastError ( void   )  const [pure virtual]

Returns the error result of the last import

Returns:
QString English-language name of the error encountered in the last import, or QString() if it was successful.

Implemented in OfxImporterPlugin.


The documentation for this class was generated from the following file:

Generated on Wed Jan 26 13:10:37 2011 for KMyMoney by  doxygen 1.5.6