QBanking Class Reference

#include <qbanking.h>

Inheritance diagram for QBanking:

Banking KBanking

Detailed Description

Definition at line 50 of file qbanking.h.

Public Member Functions

 QBanking (const char *appname, const char *fname=0)
virtual ~QBanking ()
int init ()
int fini ()
void setAppHelpPath (const QString &s)
virtual int messageBox (GWEN_TYPE_UINT32 flags, const char *title, const char *text, const char *b1, const char *b2, const char *b3)
virtual int inputBox (GWEN_TYPE_UINT32 flags, const char *title, const char *text, char *buffer, int minLen, int maxLen)
virtual GWEN_TYPE_UINT32 showBox (GWEN_TYPE_UINT32 flags, const char *title, const char *text)
virtual void hideBox (GWEN_TYPE_UINT32 id)
virtual GWEN_TYPE_UINT32 progressStart (const char *title, const char *text, GWEN_TYPE_UINT32 total)
virtual int progressAdvance (GWEN_TYPE_UINT32 id, GWEN_TYPE_UINT32 progress)
virtual int progressLog (GWEN_TYPE_UINT32 id, AB_BANKING_LOGLEVEL level, const char *text)
virtual int progressEnd (GWEN_TYPE_UINT32 id)
virtual int print (const char *docTitle, const char *docType, const char *descr, const char *text)
virtual QBFlagStaffflagStaff ()
void setParentWidget (QWidget *w)
QWidget * getParentWidget ()
int enqueueJob (AB_JOB *j)
int dequeueJob (AB_JOB *j)
int executeQueue (AB_IMEXPORTER_CONTEXT *ctx)
void setAccountAlias (AB_ACCOUNT *a, const char *alias)
void accountsUpdated ()
void outboxCountChanged (int count)
void statusMessage (const QString &s)
virtual void invokeHelp (const QString &context, const QString &subject)
virtual bool mapAccount (const AB_ACCOUNT *a)
bool askMapAccount (const char *id, const char *bankCode, const char *accountId)
virtual bool addTransaction (const AB_ACCOUNT *a, const AB_TRANSACTION *t)
virtual bool setAccountStatus (const AB_ACCOUNT *a, const AB_ACCOUNT_STATUS *ast)
bool requestBalance (const char *accountId)
bool requestTransactions (const char *accountId, const QDate &fromDate, const QDate &toDate)
virtual bool importContext (AB_IMEXPORTER_CONTEXT *ctx, GWEN_TYPE_UINT32 flags)
virtual bool importAccountInfo (AB_IMEXPORTER_ACCOUNTINFO *ai, GWEN_TYPE_UINT32 flags)
virtual bool interactiveImport ()
virtual GWEN_TYPE_UINT32 showBox (GWEN_TYPE_UINT32 flags, const QString &title, const QString &text)
virtual GWEN_TYPE_UINT32 progressStart (const QString &title, const QString &text, GWEN_TYPE_UINT32 total)
virtual int progressLog (GWEN_TYPE_UINT32 id, AB_BANKING_LOGLEVEL level, const QString &text)
virtual int print (const QString &docTitle, const QString &docType, const QString &descr, const QString &text)
AB_BANKINFOselectBank (QWidget *parent=0, const QString &title=QString(""), const QString &country=QString("de"), const QString &bankCode=QString(""), const QString &swiftCode=QString(""), const QString &bankName=QString(""), const QString &location=QString(""))
void setupDialog (QWidget *parent=0)
QBCfgModulegetConfigModule (const char *modname)
void setAppConfigModule (QBCfgModule *mod)

Static Public Member Functions

static QBANKING_API std::string QStringToUtf8String (const QString &qs)
static QBANKING_API std::string guiString (const char *s)
static QBANKING_API bool isPure7BitAscii (const QString &s)

Friends

class QBanking_Linker


Constructor & Destructor Documentation

QBanking::QBanking ( const char *  appname,
const char *  fname = 0 
)

virtual QBanking::~QBanking (  )  [virtual]


Member Function Documentation

int QBanking::init (  ) 

See AB_Banking_Init

Reimplemented from Banking.

Reimplemented in KBanking.

int QBanking::fini (  ) 

See AB_Banking_Fini

Reimplemented from Banking.

Reimplemented in KBanking.

void QBanking::setAppHelpPath ( const QString &  s  ) 

virtual int QBanking::messageBox ( GWEN_TYPE_UINT32  flags,
const char *  title,
const char *  text,
const char *  b1,
const char *  b2,
const char *  b3 
) [virtual]

See AB_Banking_MessageBox

Reimplemented from Banking.

virtual int QBanking::inputBox ( GWEN_TYPE_UINT32  flags,
const char *  title,
const char *  text,
char *  buffer,
int  minLen,
int  maxLen 
) [virtual]

See AB_Banking_InputBox

Reimplemented from Banking.

virtual GWEN_TYPE_UINT32 QBanking::showBox ( GWEN_TYPE_UINT32  flags,
const char *  title,
const char *  text 
) [virtual]

See AB_Banking_ShowBox

Reimplemented from Banking.

virtual void QBanking::hideBox ( GWEN_TYPE_UINT32  id  )  [virtual]

See AB_Banking_HideBox

Reimplemented from Banking.

virtual GWEN_TYPE_UINT32 QBanking::progressStart ( const char *  title,
const char *  text,
GWEN_TYPE_UINT32  total 
) [virtual]

See AB_Banking_ProgressStart

Reimplemented from Banking.

virtual int QBanking::progressAdvance ( GWEN_TYPE_UINT32  id,
GWEN_TYPE_UINT32  progress 
) [virtual]

Advances the progress bar an application might present to the user.

Parameters:
id id assigned by AB_Banking_Progress_Start
progress new value for progress. A special value is AB_BANKING_PROGRESS_NONE which means that the progress is unchanged. This might be used as a keepalive call to a GUI.

Reimplemented from Banking.

virtual int QBanking::progressLog ( GWEN_TYPE_UINT32  id,
AB_BANKING_LOGLEVEL  level,
const char *  text 
) [virtual]

See AB_Banking_ProgressLog

Reimplemented from Banking.

virtual int QBanking::progressEnd ( GWEN_TYPE_UINT32  id  )  [virtual]

See AB_Banking_ProgressEnd

Reimplemented from Banking.

virtual int QBanking::print ( const char *  docTitle,
const char *  docType,
const char *  descr,
const char *  text 
) [virtual]

This function makes the application print something. This is the implementation of AB_Banking_Print(); see there for arguments.

Note: all string arguments must be in UTF-8 encoding.

Reimplemented from Banking.

virtual QBFlagStaff* QBanking::flagStaff (  )  [virtual]

Reimplemented in KBanking.

void QBanking::setParentWidget ( QWidget *  w  ) 

QWidget* QBanking::getParentWidget (  ) 

int QBanking::enqueueJob ( AB_JOB j  ) 

Enqueues a job. This function does not take over the ownership of the job. However, this function makes sure that the job will not be deleted as long as it is in the queue (by calling AB_Job_Attach). So it is safe for you to call AB_Job_free on an enqueued job directly after enqueuing it (but it doesn't make much sense since you would not be able to check for a result).

Reimplemented from Banking.

int QBanking::dequeueJob ( AB_JOB j  ) 

Removes a job from the queue. This function does not free the given job, the caller still is the owner. Dequeued jobs however are NOT preserved across shutdowns.

Reimplemented from Banking.

int QBanking::executeQueue ( AB_IMEXPORTER_CONTEXT ctx  )  [virtual]

This function sends all jobs in the queue to their corresponding backends and allows that backend to process it. If the user did not abort or there was no fatal error the queue is empty upon return. You can verify this by calling AB_Banking_GetEnqueuedJobs.

Reimplemented from Banking.

Reimplemented in KBanking.

void QBanking::setAccountAlias ( AB_ACCOUNT a,
const char *  alias 
)

void QBanking::accountsUpdated (  ) 

void QBanking::outboxCountChanged ( int  count  ) 

void QBanking::statusMessage ( const QString &  s  ) 

virtual void QBanking::invokeHelp ( const QString &  context,
const QString &  subject 
) [virtual]

virtual bool QBanking::mapAccount ( const AB_ACCOUNT a  )  [virtual]

bool QBanking::askMapAccount ( const char *  id,
const char *  bankCode,
const char *  accountId 
)

virtual bool QBanking::addTransaction ( const AB_ACCOUNT a,
const AB_TRANSACTION t 
) [virtual]

virtual bool QBanking::setAccountStatus ( const AB_ACCOUNT a,
const AB_ACCOUNT_STATUS ast 
) [virtual]

bool QBanking::requestBalance ( const char *  accountId  ) 

bool QBanking::requestTransactions ( const char *  accountId,
const QDate &  fromDate,
const QDate &  toDate 
)

virtual bool QBanking::importContext ( AB_IMEXPORTER_CONTEXT ctx,
GWEN_TYPE_UINT32  flags 
) [virtual]

Let the application import a given statement context.

Reimplemented from Banking.

Reimplemented in KBanking.

virtual bool QBanking::importAccountInfo ( AB_IMEXPORTER_ACCOUNTINFO ai,
GWEN_TYPE_UINT32  flags 
) [virtual]

Reimplemented in KBanking.

virtual bool QBanking::interactiveImport (  )  [virtual]

virtual GWEN_TYPE_UINT32 QBanking::showBox ( GWEN_TYPE_UINT32  flags,
const QString &  title,
const QString &  text 
) [virtual]

virtual GWEN_TYPE_UINT32 QBanking::progressStart ( const QString &  title,
const QString &  text,
GWEN_TYPE_UINT32  total 
) [virtual]

virtual int QBanking::progressLog ( GWEN_TYPE_UINT32  id,
AB_BANKING_LOGLEVEL  level,
const QString &  text 
) [virtual]

virtual int QBanking::print ( const QString &  docTitle,
const QString &  docType,
const QString &  descr,
const QString &  text 
) [virtual]

This function makes the application print something. This is a wrapper around the print() with "const char*" which is the implementation of AB_Banking_Print(); see there for arguments.

Note: Make sure all arguments passed here are really a QString! If any argument is a "const char*" (e. g. simply a string constant), then especially QT-4 will complain about an ambiguity between the "const char*"-print() and this one.

AB_BANKINFO* QBanking::selectBank ( QWidget *  parent = 0,
const QString &  title = QString(""),
const QString &  country = QString("de"),
const QString &  bankCode = QString(""),
const QString &  swiftCode = QString(""),
const QString &  bankName = QString(""),
const QString &  location = QString("") 
)

Opens a dialog which asks the user for a bank. This bank can be selected using the bank code (also called sort code in some countries), the SWIFT code (so called BIC), bank name and/or location of the bank. This dialog also contains a list of matching banks which is updated while the user enters data. If any of the parameters contains a value those values will be used to preset the bank list of the dialog widget.

Returns:
a AB_BANKINFO object (owned by the caller, so the caller is responsible for freeing this object via AB_BankInfo_free)
Parameters:
parent parent widget (or NULL)
title caption of the dialog
country ISO 3166 country code (e.g. "de" for Germany, "at" for Austria etc, like in TLDs)
bankCode bank code (also called sort code in some countries, or Bankleitzahl in Germany/Austria)
swiftCode code assigned to the bank by SWIFT (so-called BIC)
bankName name of the bank
location location of the bank (typically the city the bank is located in)

void QBanking::setupDialog ( QWidget *  parent = 0  ) 

QBCfgModule* QBanking::getConfigModule ( const char *  modname  ) 

This function makes sure that the configuration module with the given name is available. It loads the appropriate plugin on demand. You MUST NOT delete the pointer returned (if any).

Parameters:
modname name of the module to load. Normally this is the name of the backend for which the configuration module is requested. If NULL then the applications config module is returned (if one is set).

void QBanking::setAppConfigModule ( QBCfgModule mod  ) 

Sets the configuration module of the application. The caller remains the owner of the module.

static QBANKING_API std::string QBanking::QStringToUtf8String ( const QString &  qs  )  [static]

Convenience function to convert a QString into a std::string that will contain UTF-8 encoded characters, as necessary when passing strings into aqbanking.

Watch out with the correct encodings! String passed into and out of aqbanking are expected in UTF-8, but NOT in Latin-1 or similar!

static QBANKING_API std::string QBanking::guiString ( const char *  s  )  [static]

Convenience function for extracting the GUI part of the HTML/cleartext-combi-strings from aqbanking, adapted to strings for QT gui widgets.

If the given string contains a <html>html-part...</html> section, then the "html-part" section will be returned with enclosing <qt>...</qt> tags plus potentially some whitespace around those. If the given string does not contain a section like this, then the string will be returned unchanged.

static QBANKING_API bool QBanking::isPure7BitAscii ( const QString &  s  )  [static]

Convenience function that returns true if the given string consists of pure 7-bit ASCII characters, and false otherwise.

In particular, if the given string contains Umlauts, accents, or similar, then this will return false.


Friends And Related Function Documentation

friend class QBanking_Linker [friend]

Definition at line 51 of file qbanking.h.


The documentation for this class was generated from the following file:
Generated on Fri Nov 10 03:56:55 2006 for aqbanking by  doxygen 1.5.1