MyMoneyStatementReader Class Reference

#include <mymoneystatementreader.h>

Inheritance diagram for MyMoneyStatementReader:

Collaboration diagram for MyMoneyStatementReader:

[legend]List of all members.


Signals
void	importFinished (void)
Public Member Functions
	MyMoneyStatementReader ()
	~MyMoneyStatementReader ()
bool	import (const MyMoneyStatement &s, QStringList &messages)
void	setAutoCreatePayee (const bool create)
const MyMoneyAccount &	account () const
void	setProgressCallback (void(*callback)(int, int, const QString &))
Private Types
enum	SelectCreateMode { Create = 0, Select }
Private Member Functions
void	signalProgress (int current, int total, const QString &="")
void	processTransactionEntry (const MyMoneyStatement::Transaction &)
void	processSecurityEntry (const MyMoneyStatement::Security &)
bool	selectOrCreateAccount (const SelectCreateMode mode, MyMoneyAccount &account)
Static Private Member Functions
static const QCString	findOrCreateIncomeAccount (const QString &searchname)
static const QCString	findOrCreateExpenseAccount (const QString &searchname)
Private Attributes
MyMoneyStatementReaderPrivate *	d
MyMoneyAccount	m_account
QStringList	m_dontAskAgain
bool	m_skipAccount
bool	m_userAbort
bool	m_autoCreatePayee
MyMoneyFileTransaction *	m_ft
void(*	m_progressCallback )(int, int, const QString &)

Detailed Description

This is a pared-down version of a MyMoneyQifReader object

Author:: Ace Jones

Member Enumeration Documentation

enum MyMoneyStatementReader::SelectCreateMode [private]

Enumeration values:

Create

Select

Constructor & Destructor Documentation

MyMoneyStatementReader::MyMoneyStatementReader ( )

MyMoneyStatementReader::~MyMoneyStatementReader ( )

Member Function Documentation

const MyMoneyAccount& MyMoneyStatementReader::account ( ) const [inline]

static const QCString MyMoneyStatementReader::findOrCreateExpenseAccount ( const QString & searchname ) [static, private]

static const QCString MyMoneyStatementReader::findOrCreateIncomeAccount ( const QString & searchname ) [static, private]

This method looks up the searchname account by name and returns its id if it was found. If it was not found, it creates a new income account using searchname as a name, and returns the id if the newly created account

Parameters:

searchname The name of the account to find or create

Returns:
QCString id of the found or created account

bool MyMoneyStatementReader::import ( const MyMoneyStatement & s,

QStringList & messages

)

This method imports data from the MyMoneyStatement object s into the MyMoney engine. It leaves some statistical information in the messages string list

Return values:

true the import was processed successfully

false the import resulted in a failure.

void MyMoneyStatementReader::importFinished ( void ) [signal]

This signal will be emitted when the import is finished.

void MyMoneyStatementReader::processSecurityEntry ( const MyMoneyStatement::Security & ) [private]

void MyMoneyStatementReader::processTransactionEntry ( const MyMoneyStatement::Transaction & ) [private]

bool MyMoneyStatementReader::selectOrCreateAccount ( const SelectCreateMode mode,

MyMoneyAccount & account

) [private]

This method is used to find an account using the account's name stored in account in the current MyMoneyFile object. If it does not exist, the user has the chance to create it or to skip processing of this account.
Please see the documentation for this function in MyMoneyQifReader

Parameters:

mode Is either Create or Select depending on the above table

account Reference to MyMoneyAccount object

void MyMoneyStatementReader::setAutoCreatePayee ( const bool create )

This method is used to modify the auto payee creation flag. If this flag is set, records for payees that are not currently found in the engine will be automatically created with no further user interaction required. If this flag is no set, the user will be asked if the payee should be created or not. If the MyMoneyQifReader object is created auto payee creation is turned off.

Parameters:

create flag if this feature should be turned on (true) or turned off (false)

void MyMoneyStatementReader::setProgressCallback ( void(*)(int, int, const QString &) callback )

void MyMoneyStatementReader::signalProgress ( int current,

int total,

const QString & = ""

) [private]

This method is used to update the progress information. It checks if an appropriate function is known and calls it.
For a parameter description see KMyMoneyView::progressCallback().