QBanking Class Reference

#include <qbanking.h>

Inheritance diagram for QBanking:

AB_Banking

Detailed Description

Definition at line 60 of file qbanking.h.


Public Member Functions

 QBanking (const char *appname, const char *fname=0)
virtual ~QBanking ()
int init ()
int fini ()
QGuigetGui () const
void setGui (QGui *g)
QWidget * getParentWidget () const
void setParentWidget (QWidget *w)
void setAppHelpPath (const QString &s)
virtual QBFlagStaffflagStaff ()
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)
virtual bool importContext (AB_IMEXPORTER_CONTEXT *ctx, uint32_t flags)
virtual bool importAccountInfo (AB_IMEXPORTER_ACCOUNTINFO *ai, uint32_t flags)
virtual bool interactiveImport ()
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)

Constructor & Destructor Documentation

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

virtual QBanking::~QBanking (  )  [virtual]


Member Function Documentation

int QBanking::init (  )  [virtual]

See AB_Banking_Init

Reimplemented from AB_Banking.

int QBanking::fini (  )  [virtual]

See AB_Banking_Fini

Reimplemented from AB_Banking.

QGui* QBanking::getGui (  )  const

void QBanking::setGui ( QGui g  ) 

QWidget* QBanking::getParentWidget (  )  const [inline]

Definition at line 93 of file qbanking.h.

void QBanking::setParentWidget ( QWidget *  w  )  [inline]

Definition at line 94 of file qbanking.h.

void QBanking::setAppHelpPath ( const QString &  s  ) 

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

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]

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

Let the application import a given statement context.

Reimplemented from AB_Banking.

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

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


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

Generated on Sun Jun 22 00:25:14 2008 for aqbanking by  doxygen 1.5.6