KMyMoneyPlugin::StoragePlugin Class Reference

#include <kmymoneyplugin.h>

Public Member Functions
virtual void	close ()=0
virtual QString	fileExtension () const =0
virtual bool	open (const QUrl &url)=0
virtual QString	openErrorMessage () const
virtual QUrl	openUrl () const =0
virtual bool	save (const QUrl &url)=0
virtual bool	saveAs ()=0
virtual eKMyMoney::StorageType	storageType () const =0

Detailed Description

This class describes the interface between the KMyMoney application and it's STORAGE plugins.

All storage plugins must provide this interface.

Definition at line 286 of file kmymoneyplugin.h.

Member Function Documentation

close()

virtual void KMyMoneyPlugin::StoragePlugin::close ( )

pure virtual

Closes the currently opened file If no file is opened, nothing will be done.

open()

virtual bool KMyMoneyPlugin::StoragePlugin::open ( const QUrl & url )

pure virtual

Loads file into storage.

Parameters

url	URL of the file

Returns

true if successfully opened

openErrorMessage()

QString KMyMoneyPlugin::StoragePlugin::openErrorMessage ( ) const

virtual

returns a descriptive message why opening failed

Returns a descriptive error message when open() returned false because it could not read the file but the plugin is otherwise handling this file.

Returns an empty string if the plugin is not responsible for this file.

Returns

QString containing message.

Definition at line 137 of file kmymoneyplugin.cpp.

openUrl()

virtual QUrl KMyMoneyPlugin::StoragePlugin::openUrl ( ) const

pure virtual

returns the full URL used to open the database (incl.

password)

Returns

QUrl to re-open the database

save()

virtual bool KMyMoneyPlugin::StoragePlugin::save ( const QUrl & url )

pure virtual

Saves storage into file.

Parameters

url	URL of the file

Returns

true if successfully saved

saveAs()

virtual bool KMyMoneyPlugin::StoragePlugin::saveAs ( )

pure virtual

Saves storage into file.

Parameters

url	URL of the file

Returns

true if successfully saved

storageType()

virtual eKMyMoney::StorageType KMyMoneyPlugin::StoragePlugin::storageType ( ) const

pure virtual

Storage identifier.

Returns

Storage identifier

---

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

• kmymoneyplugin.h
• kmymoneyplugin.cpp