AB_BANKING (Main Interface)

This group contains the main API function group. More...


Modules

 AB_BANKING Job-API
 This group contains the job API ("main interface") function group.
 Im/Exporter API
 This group contains a very simple API.

Extensions supported by the application

#define AB_BANKING_EXTENSION_NONE   0x00000000
#define AB_BANKING_EXTENSION_NESTING_PROGRESS   0x00000001

Defines

#define AB_BANKING_PROGRESS_NONE   0xffffffff
#define AB_BANKING_PROGRESS_ONE   0xfffffffe

Typedefs

typedef AB_BANKING AB_BANKING

Detailed Description

This group contains the main API function group.

A program should first call AB_Banking_Init to allow AqBanking to load its configuration files and initialize itself. After that you may call any other function of this group (most likely the program will request a list of managed account via AB_Banking_GetAccounts).

When the program has finished its work it should call AB_Banking_Fini as the last function of AqBanking (just before calling AB_Banking_free).


Define Documentation

#define AB_BANKING_EXTENSION_NESTING_PROGRESS   0x00000001
 

If this flag is set then the application allows nesting progress dialogs. If the application does it might be best to use the toplevel progress widget and just add a progress bar to it. If this flag is not set then AqBanking keeps track of the nesting level and dismisses further calls to AB_Banking_ProgressStart until AB_Banking_ProgressEnd has been called often enough to reset the nesting counter. I.e. the application will not receive nesting calls to AB_Banking_ProgressStart.

Definition at line 73 of file aqbanking/banking.h.

#define AB_BANKING_EXTENSION_NONE   0x00000000
 

Definition at line 62 of file aqbanking/banking.h.

#define AB_BANKING_PROGRESS_NONE   0xffffffff
 

This value is used with AB_Banking_ProgressAdvance to flag that there really was no progress since the last call to that function but that that function should simply check for user interaction (without the need of updating the progress bar).

Definition at line 83 of file aqbanking/banking.h.

#define AB_BANKING_PROGRESS_ONE   0xfffffffe
 

This value is used when the total number of steps is not known to the caller and he just wants to advance the progress by one (e.g. backends use this value when a job has been finished, but the backends do not know how many jobs there still are in AqBanking's queue).

Definition at line 91 of file aqbanking/banking.h.


Typedef Documentation

typedef struct AB_BANKING AB_BANKING
 

Object to be operated on by functions in this group (AB_BANKING).

Definition at line 97 of file aqbanking/banking.h.


Generated on Sat Jan 7 04:22:43 2006 for aqbanking by  doxygen 1.4.6