QBanking Class Reference

#include <qbanking.h>

Inheritance diagram for QBanking:

Banking KBanking

Public Member Functions

 QBanking (const char *appname, const char *fname=0)
virtual ~QBanking ()
int init ()
int fini ()
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 ()
void setAccountAlias (AB_ACCOUNT *a, const char *alias)
void accountsUpdated ()
void outboxCountChanged (int count)
void statusMessage (const QString &s)
virtual void invokeHelp (const char *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 ()
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(""))

Static Public Member Functions

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

Friends

class QBanking_Linker

Detailed Description

Definition at line 42 of file qbanking.h.


Constructor & Destructor Documentation

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

virtual QBanking::~QBanking  )  [virtual]
 


Member Function Documentation

void QBanking::accountsUpdated  ) 
 

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

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

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::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::executeQueue  ) 
 

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.

int QBanking::fini  ) 
 

See AB_Banking_Fini

Reimplemented from Banking.

Reimplemented in KBanking.

virtual QBFlagStaff* QBanking::flagStaff  )  [virtual]
 

Reimplemented in KBanking.

QWidget* QBanking::getParentWidget  ) 
 

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

Convenience function for extracting the GUI part of the HTML/cleartext-combi-strings from aqbanking.

If the given string contains a <html>html-part...</html> section, then the "html-part" section will be returned. If the given string does not contain a section like this, then the string will be returned unchanged.

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

See AB_Banking_HideBox

Reimplemented from Banking.

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

Reimplemented in KBanking.

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.

int QBanking::init  ) 
 

See AB_Banking_Init

Reimplemented from Banking.

Reimplemented in KBanking.

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 bool QBanking::interactiveImport  )  [virtual]
 

virtual void QBanking::invokeHelp const char *  subject  )  [virtual]
 

static 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.

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

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.

void QBanking::outboxCountChanged int  count  ) 
 

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

See AB_Banking_Print

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::progressEnd GWEN_TYPE_UINT32  id  )  [virtual]
 

See AB_Banking_ProgressEnd

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 GWEN_TYPE_UINT32 QBanking::progressStart const char *  title,
const char *  text,
GWEN_TYPE_UINT32  total
[virtual]
 

See AB_Banking_ProgressStart

Reimplemented from Banking.

static 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!

bool QBanking::requestBalance const char *  accountId  ) 
 

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

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::setAccountAlias AB_ACCOUNT a,
const char *  alias
 

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

void QBanking::setParentWidget QWidget *  w  ) 
 

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

See AB_Banking_ShowBox

Reimplemented from Banking.

void QBanking::statusMessage const QString &  s  ) 
 


Friends And Related Function Documentation

friend class QBanking_Linker [friend]
 

Definition at line 43 of file qbanking.h.


The documentation for this class was generated from the following file:
Generated on Sat Jan 7 04:22:42 2006 for aqbanking by  doxygen 1.4.6