gui.h File Reference

#include <gwenhywfar/inherit.h>
#include <gwenhywfar/logger.h>
#include <gwenhywfar/inetsocket.h>
#include <gwenhywfar/ssl_cert_descr.h>
#include <gwenhywfar/iolayer.h>
#include <inttypes.h>

Go to the source code of this file.

Defines

#define GWEN_GUI_CHECK_PERIOD   750
#define GWEN_GUI_CPU_TIMEOUT   200
#define GWEN_GUI_DELAY_SECS   2
Flags For GWEN_Gui_InputBox
These flags are given to GWEN_Gui_InputBox to modify its behaviour.

#define GWEN_GUI_INPUT_FLAGS_ALLOW_DEFAULT   0x00000010
#define GWEN_GUI_INPUT_FLAGS_CONFIRM   0x00000001
#define GWEN_GUI_INPUT_FLAGS_NUMERIC   0x00000004
#define GWEN_GUI_INPUT_FLAGS_RETRY   0x00000008
#define GWEN_GUI_INPUT_FLAGS_SHOW   0x00000002
#define GWEN_GUI_INPUT_FLAGS_TAN   0x00000020
Flags For GWEN_Gui_MessageBox
These flags are given to GWEN_Gui_MessageBox to modify its behaviour. You may OR-combine the flags.
Examples:

A note about confirmation buttons: AqBanking has been designed with non-interactive applications in mind. For such an application it is important to know what button-press it has to simulate upon catching of a messagebox callback. This is what the confimation button flags are for. For informative messages the application may simply return the number of the confirmation button and be done.

However, non-interactive applications should return an error (value 0) for messages classified as dangerous (see GWEN_GUI_MSG_FLAGS_SEVERITY_DANGEROUS) to avoid data loss.

#define GWEN_GUI_MSG_FLAGS_CONFIRM_B1   (1<<3)
#define GWEN_GUI_MSG_FLAGS_CONFIRM_B2   (2<<3)
#define GWEN_GUI_MSG_FLAGS_CONFIRM_B3   (3<<3)
#define GWEN_GUI_MSG_FLAGS_CONFIRM_BUTTON(fl)   ((fl & 0x3)>>3)
#define GWEN_GUI_MSG_FLAGS_SEVERITY_DANGEROUS   (0x1<<5)
#define GWEN_GUI_MSG_FLAGS_SEVERITY_IS_DANGEROUS(fl)
#define GWEN_GUI_MSG_FLAGS_SEVERITY_IS_NORMAL(fl)
#define GWEN_GUI_MSG_FLAGS_SEVERITY_MASK   (0x7<<5)
#define GWEN_GUI_MSG_FLAGS_SEVERITY_NORMAL   (0x0<<5)
#define GWEN_GUI_MSG_FLAGS_TYPE_ERROR   2
#define GWEN_GUI_MSG_FLAGS_TYPE_INFO   0
#define GWEN_GUI_MSG_FLAGS_TYPE_IS_ERROR   ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_ERROR)
#define GWEN_GUI_MSG_FLAGS_TYPE_IS_INFO(fl)   ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_INFO)
#define GWEN_GUI_MSG_FLAGS_TYPE_IS_WARN(fl)   ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_WARN)
#define GWEN_GUI_MSG_FLAGS_TYPE_MASK   0x07
#define GWEN_GUI_MSG_FLAGS_TYPE_WARN   1
Flags For GWEN_Gui_ProgressStart
These flags are given to GWEN_Gui_ProgressStart to modify its behaviour.

#define GWEN_GUI_PROGRESS_ALLOW_EMBED   0x00000010
#define GWEN_GUI_PROGRESS_ALLOW_SUBLEVELS   0x00000008
#define GWEN_GUI_PROGRESS_ALWAYS_SHOW_LOG   0x00000080
#define GWEN_GUI_PROGRESS_DELAY   0x00000001
#define GWEN_GUI_PROGRESS_KEEP_OPEN   0x00000040
#define GWEN_GUI_PROGRESS_SHOW_ABORT   0x00000004
#define GWEN_GUI_PROGRESS_SHOW_LOG   0x00000002
#define GWEN_GUI_PROGRESS_SHOW_PROGRESS   0x00000020
Special Progress Values for GWEN_Gui_ProgressAdvance
#define GWEN_GUI_PROGRESS_NONE   (0xffffffffUL)
#define GWEN_GUI_PROGRESS_ONE   (0xfffffffeUL)
Flags For GWEN_Gui_ShowBox
#define GWEN_GUI_SHOWBOX_FLAGS_BEEP   0x00000001

Typedefs

typedef struct GWEN_GUI GWEN_GUI

Enumerations

enum  GWEN_GUI_PASSWORD_STATUS {
  GWEN_Gui_PasswordStatus_Bad = -1, GWEN_Gui_PasswordStatus_Unknown, GWEN_Gui_PasswordStatus_Ok, GWEN_Gui_PasswordStatus_Used,
  GWEN_Gui_PasswordStatus_Unused, GWEN_Gui_PasswordStatus_Remove
}

Functions

Constructor, Destructor etc
GWENHYWFAR_API void GWEN_Gui_Attach (GWEN_GUI *gui)
GWENHYWFAR_API void GWEN_Gui_free (GWEN_GUI *gui)
GWENHYWFAR_API GWEN_GUIGWEN_Gui_GetGui ()
GWENHYWFAR_API GWEN_GUIGWEN_Gui_new ()
GWENHYWFAR_API void GWEN_Gui_SetGui (GWEN_GUI *gui)
Virtual User Interaction Functions
All text passed to the frontend via one of the following functions is expected to be an UTF-8 string which may contain newlines but no other control characters. Text delivered as argument called text throughout the documentation in this group may contain HTML tags. If it does a non-HTML version must be supplied, too. The text MUST begin with the non-HTML version, so that a frontend not capable of parsing HTML can simply exclude the HTML part by cutting before "<html".

This is an example for HTML and non-HTML text:

 const char *text;

 text="This is the non-HTML text"
      "<html>"
      "And this is the <b>HTML</b> version."
      "</html>"

Frontends capable of parsing HTML (such as the KDE frontend) will extract the HTML information and show only that part of the string.

Other frontends have to extract the non-HTML information and show only that.

GWENHYWFAR_API int GWEN_Gui_CheckCert (const GWEN_SSLCERTDESCR *cert, GWEN_IO_LAYER *io, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_GetPassword (uint32_t flags, const char *token, const char *title, const char *text, char *buffer, int minLen, int maxLen, uint32_t guiid)
GWENHYWFAR_API void GWEN_Gui_HideBox (uint32_t id)
GWENHYWFAR_API int GWEN_Gui_InputBox (uint32_t flags, const char *title, const char *text, char *buffer, int minLen, int maxLen, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_KeyDataFromText_OpenSSL (const char *text, unsigned char *buffer, unsigned int bufLength)
GWENHYWFAR_API int GWEN_Gui_LogHook (const char *logDomain, GWEN_LOGGER_LEVEL priority, const char *s)
GWENHYWFAR_API int GWEN_Gui_MessageBox (uint32_t flags, const char *title, const char *text, const char *b1, const char *b2, const char *b3, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_Print (const char *docTitle, const char *docType, const char *descr, const char *text, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_ProgressAdvance (uint32_t id, uint32_t progress)
GWENHYWFAR_API int GWEN_Gui_ProgressEnd (uint32_t id)
GWENHYWFAR_API int GWEN_Gui_ProgressLog (uint32_t id, GWEN_LOGGER_LEVEL level, const char *text)
GWENHYWFAR_API uint32_t GWEN_Gui_ProgressStart (uint32_t progressFlags, const char *title, const char *text, uint64_t total, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_SetPasswordStatus (const char *token, const char *pin, GWEN_GUI_PASSWORD_STATUS status, uint32_t guiid)
GWENHYWFAR_API uint32_t GWEN_Gui_ShowBox (uint32_t flags, const char *title, const char *text, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_WaitForSockets (GWEN_SOCKET_LIST2 *readSockets, GWEN_SOCKET_LIST2 *writeSockets, uint32_t guiid, int msecs)


Define Documentation

#define GWEN_GUI_CHECK_PERIOD   750

Definition at line 53 of file gui.h.

#define GWEN_GUI_CPU_TIMEOUT   200

Definition at line 51 of file gui.h.

Referenced by GWEN_Gui_WaitForSockets(), and GWEN_Io_Manager_WaitForRequest().

#define GWEN_GUI_DELAY_SECS   2

Definition at line 54 of file gui.h.

Referenced by GWEN_Gui_CProgress_Advance().

#define GWEN_GUI_INPUT_FLAGS_ALLOW_DEFAULT   0x00000010

allow a default value to be used instead of an entered one. A graphical UI should add a "default" button to the dialog.

Definition at line 91 of file gui.h.

Referenced by GWEN_Gui_CGui__input().

#define GWEN_GUI_INPUT_FLAGS_CONFIRM   0x00000001

input must be confirmed (e.g. by asking for the same input twice)

Definition at line 82 of file gui.h.

Referenced by GWEN_Crypt_Token_GetPin(), GWEN_Gui_CGui_GetPassword(), and GWEN_Gui_CGui_InputBox().

#define GWEN_GUI_INPUT_FLAGS_NUMERIC   0x00000004

numeric input is requested (e.g. for PINs)

Definition at line 86 of file gui.h.

Referenced by GWEN_Crypt_Token_GetPin(), and GWEN_Gui_CGui__input().

#define GWEN_GUI_INPUT_FLAGS_RETRY   0x00000008

if set then this is a retry (esp. when getting a PIN)

Definition at line 88 of file gui.h.

#define GWEN_GUI_INPUT_FLAGS_SHOW   0x00000002

input may be shown (otherwise it should be hidden, e.g. for passwords)

Definition at line 84 of file gui.h.

Referenced by GWEN_Gui_CGui__input().

#define GWEN_GUI_INPUT_FLAGS_TAN   0x00000020

The input is a TAN (this is used by GWEN_Gui_GetPassword)

Definition at line 93 of file gui.h.

Referenced by GWEN_Gui_CGui_GetPassword().

#define GWEN_GUI_MSG_FLAGS_CONFIRM_B1   (1<<3)

#define GWEN_GUI_MSG_FLAGS_CONFIRM_B2   (2<<3)

button 2 is the confirmation button

Definition at line 167 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_CONFIRM_B3   (3<<3)

button 3 is the confirmation button

Definition at line 169 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_CONFIRM_BUTTON ( fl   )     ((fl & 0x3)>>3)

Determine which button is the confirmation button

Definition at line 171 of file gui.h.

Referenced by GWEN_Gui_CGui_MessageBox().

#define GWEN_GUI_MSG_FLAGS_SEVERITY_DANGEROUS   (0x1<<5)

Message is considered dangerous and thus should be attended to by a humanoid ;-)

Definition at line 203 of file gui.h.

Referenced by GWEN_Crypt_Token_InsertCorrectToken(), GWEN_Crypt_Token_InsertToken(), GWEN_Gui_CGui__input(), GWEN_Gui_CGui_GetPassword(), and GWEN_Gui_CheckCertBuiltIn().

#define GWEN_GUI_MSG_FLAGS_SEVERITY_IS_DANGEROUS ( fl   ) 

#define GWEN_GUI_MSG_FLAGS_SEVERITY_IS_NORMAL ( fl   ) 

Value:

Definition at line 198 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_SEVERITY_MASK   (0x7<<5)

Check for the severity of the message. This allows non-interactive backends to react on the message accordingly. The backend calling this function thus allows the frontend to detect when the message is important regarding data security. E.g. a message like "Shall I delete this file" should be considered dangerous (since this might result in a data loss). However, the messae "Just started" is not that dangerous ;-)

The following example allows to determine whether a message is dangerous:

 if ( ( flags & GWEN_GUI_MSG_FLAGS_SEVERITY_MASK) ==
      GWEN_GUI_MSG_FLAGS_SEVERITY_DANGEROUS) {
      fprintf(stderr, "This is dangerous.\n");
 }

Definition at line 195 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_SEVERITY_NORMAL   (0x0<<5)

Message does not affect security or induce any problem to the system

Definition at line 197 of file gui.h.

Referenced by GWEN_Crypt_Token_InsertToken().

#define GWEN_GUI_MSG_FLAGS_TYPE_ERROR   2

The message is a error message

Definition at line 159 of file gui.h.

Referenced by GWEN_Crypt_Token_InsertCorrectToken(), GWEN_Crypt_Token_InsertToken(), and GWEN_Gui_CGui_GetPassword().

#define GWEN_GUI_MSG_FLAGS_TYPE_INFO   0

The message is a simple information.

Definition at line 147 of file gui.h.

Referenced by GWEN_Gui_CGui__input().

#define GWEN_GUI_MSG_FLAGS_TYPE_IS_ERROR   ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_ERROR)

check whether the given flags represent an error message

Definition at line 161 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_TYPE_IS_INFO ( fl   )     ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_INFO)

check whether the given flags represent an info message

Definition at line 149 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_TYPE_IS_WARN ( fl   )     ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_WARN)

check whether the given flags represent a warning message

Definition at line 155 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_TYPE_MASK   0x07

Defines the mask to catch the message type. E.g. a check whether a message is a warning could be performed by:

 if ( ( flags & GWEN_GUI_MSG_FLAGS_TYPE_MASK) ==
      GWEN_GUI_MSG_FLAGS_TYPE_WARN) {
      fprintf(stderr, "This is a warning.\n");
 }

Definition at line 145 of file gui.h.

#define GWEN_GUI_MSG_FLAGS_TYPE_WARN   1

The message is a warning

Definition at line 153 of file gui.h.

Referenced by GWEN_Crypt_Token_InsertCorrectToken(), GWEN_Crypt_Token_InsertToken(), and GWEN_Gui_CheckCertBuiltIn().

#define GWEN_GUI_PROGRESS_ALLOW_EMBED   0x00000010

#define GWEN_GUI_PROGRESS_ALLOW_SUBLEVELS   0x00000008

Definition at line 66 of file gui.h.

#define GWEN_GUI_PROGRESS_ALWAYS_SHOW_LOG   0x00000080

Definition at line 70 of file gui.h.

#define GWEN_GUI_PROGRESS_DELAY   0x00000001

#define GWEN_GUI_PROGRESS_KEEP_OPEN   0x00000040

Definition at line 69 of file gui.h.

#define GWEN_GUI_PROGRESS_NONE   (0xffffffffUL)

This value is used with GWEN_Gui_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 234 of file gui.h.

Referenced by GWEN_Gui_CProgress_Advance().

#define GWEN_GUI_PROGRESS_ONE   (0xfffffffeUL)

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 242 of file gui.h.

Referenced by GWEN_Gui_CProgress_Advance().

#define GWEN_GUI_PROGRESS_SHOW_ABORT   0x00000004

#define GWEN_GUI_PROGRESS_SHOW_LOG   0x00000002

Definition at line 64 of file gui.h.

#define GWEN_GUI_PROGRESS_SHOW_PROGRESS   0x00000020

#define GWEN_GUI_SHOWBOX_FLAGS_BEEP   0x00000001

Make the frontend beep. This should rarely be used, and only in situations where it is very important to get the users attention (e.g. when asking for a PIN on a card reader).

Definition at line 219 of file gui.h.

Referenced by GWEN_Crypt_Token_BeginEnterPin().


Typedef Documentation

typedef struct GWEN_GUI GWEN_GUI

Definition at line 47 of file gui.h.


Enumeration Type Documentation

This status is used for passwords, pins and tans, e.g. by the CryptToken code. It can be used by implementations to mark bad pins, used/unused tans etc.

Enumerator:
GWEN_Gui_PasswordStatus_Bad 
GWEN_Gui_PasswordStatus_Unknown 
GWEN_Gui_PasswordStatus_Ok 
GWEN_Gui_PasswordStatus_Used 
GWEN_Gui_PasswordStatus_Unused 
GWEN_Gui_PasswordStatus_Remove 

Definition at line 252 of file gui.h.


Function Documentation

GWENHYWFAR_API void GWEN_Gui_Attach ( GWEN_GUI gui  ) 

Definition at line 74 of file gui.c.

Referenced by GWEN_Gui_SetGui().

GWENHYWFAR_API int GWEN_Gui_CheckCert ( const GWEN_SSLCERTDESCR cert,
GWEN_IO_LAYER io,
uint32_t  guiid 
)

Definition at line 538 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

Referenced by GWEN_Io_LayerTls_WorkOnRequests().

GWENHYWFAR_API void GWEN_Gui_free ( GWEN_GUI gui  ) 

Definition at line 62 of file gui.c.

References GWEN_FREE_OBJECT, and GWEN_INHERIT_FINI.

Referenced by GWEN_Gui_SetGui(), and test_gui().

GWENHYWFAR_API GWEN_GUI* GWEN_Gui_GetGui (  ) 

Definition at line 92 of file gui.c.

References gwenhywfar_gui.

GWENHYWFAR_API int GWEN_Gui_GetPassword ( uint32_t  flags,
const char *  token,
const char *  title,
const char *  text,
char *  buffer,
int  minLen,
int  maxLen,
uint32_t  guiid 
)

Definition at line 410 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

Referenced by GWEN_Crypt_Token_GetPin().

GWENHYWFAR_API void GWEN_Gui_HideBox ( uint32_t  id  ) 

Hides a message box previously shown by a call to GWEN_Gui_ShowBox.

This function MUST return immediately (non-blocking).

Parameters:
ab banking interface
id id returned by GWEN_Gui_ShowBox. If 0 then the last message shown is referred to.

Definition at line 340 of file gui.c.

References gwenhywfar_gui.

Referenced by GWEN_Crypt_Token_EndEnterPin(), and test_gui().

GWENHYWFAR_API int GWEN_Gui_InputBox ( uint32_t  flags,
const char *  title,
const char *  text,
char *  buffer,
int  minLen,
int  maxLen,
uint32_t  guiid 
)

Ask the user for input.

This function is blocking.

Parameters:
ab banking interface
flags flags, see GWEN_GUI_INPUT_FLAGS_CONFIRM ff.
title title of the input box
text Text of the box: UTF-8, with both a normal text and a HTML variant of the text in the same string. See text restrictions note above.
buffer buffer to store the response in. Must have at least room for maxLen bytes
minLen minimal length of input (if 0 then there is no low limit)
maxLen size of the buffer including the trailing NULL character. This means that if you want to ask the user for a PIN of at most 4 characters you need to supply a buffer of at least 5 bytes and provide a 5 as maxLen.
Returns:
Zero on success, nonzero when the user requested abort or there was any error. The special value AB_ERROR_DEFAULT_VALUE should be returned if the flag GWEN_GUI_INPUT_FLAGS_ALLOW_DEFAULT was given and the user has chosen to use the default value (e.g. pressed the "default" button in a GUI).

Definition at line 306 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

Referenced by GWEN_Gui_CGui_GetPassword(), and test_gui().

GWENHYWFAR_API int GWEN_Gui_KeyDataFromText_OpenSSL ( const char *  text,
unsigned char *  buffer,
unsigned int  bufLength 
)

This function is not officially part of the API but is needed for some ancient OpenHBCI keyfiles. License issues forbid us to link against OpenSSL so we leave it up to the application to implement this function. A converter tool might use this function once to convert an anciant OpenHBCI key file.

Definition at line 724 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

GWENHYWFAR_API int GWEN_Gui_LogHook ( const char *  logDomain,
GWEN_LOGGER_LEVEL  priority,
const char *  s 
)

This function is called internally by GWEN_Logger_Log.

Definition at line 456 of file gui.c.

References gwenhywfar_gui.

Referenced by GWEN_Logger_Log().

GWENHYWFAR_API int GWEN_Gui_MessageBox ( uint32_t  flags,
const char *  title,
const char *  text,
const char *  b1,
const char *  b2,
const char *  b3,
uint32_t  guiid 
)

Show a message box with optional buttons. The message box may either contain 1, 2 or three buttons. If only one button is wanted then b1 should hold a pointer to the button text (b2 and b3 must be NULL) In two-button mode b1 and b2 must be valid (b3 must be NULL) In three-button-mode b1, b2 and b3 must be valid pointers. The return value tells which button the user pressed:

  • 1: button 1
  • 2: button 2
  • 3: button 3
If the frontend can not determine which button has been pressed (e.g. if no button was pressed but the user rather aborted the dialog by simply closing the box) it should return 0.

This function is blocking.

Returns:
the number of the button pressed (1=b1, 2=b2, 3=b3), any other value should be considered an error, including 0)
Parameters:
flags flags, see GWEN_GUI_MSG_FLAGS_TYPE_MASK ff.
title title of the message box
text Text of the box: UTF-8, with both a normal text and a HTML variant of the text in the same string. See text restrictions note above.
b1 text for the first button (required), should be something like "Ok" (see text restrictions note above)
b2 text for the optional second button
b3 text for the optional third button

Definition at line 288 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

Referenced by GWEN_Crypt_Token_InsertCorrectToken(), GWEN_Crypt_Token_InsertToken(), GWEN_Gui_CGui__input(), GWEN_Gui_CGui_GetPassword(), GWEN_Gui_CheckCertBuiltIn(), and test_gui().

GWENHYWFAR_API GWEN_GUI* GWEN_Gui_new (  ) 

Definition at line 48 of file gui.c.

References GWEN_Gui_CheckCertBuiltIn(), GWEN_INHERIT_INIT, and GWEN_NEW_OBJECT.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API int GWEN_Gui_Print ( const char *  docTitle,
const char *  docType,
const char *  descr,
const char *  text,
uint32_t  guiid 
)

This function makes the application print something.

Parameters:
docTitle title of the document. This might be presented to the user
docType an unique identifier of the document to be printed. This can be used by the application to separate printer settings for different document types. The name itself has no meaning and can be choosen freely by the caller. However, backends should append their name and a colon to keep this argument unique. This argument should not be translated.
descr an optional description about what the document contains. This might be shown to the user (see text restriction notes above).
text text to be printed (see text restriction notes above).

Definition at line 393 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

GWENHYWFAR_API int GWEN_Gui_ProgressAdvance ( uint32_t  id,
uint32_t  progress 
)

Advances the progress bar an application might present to the user and checks whether the user wants to abort the operation currently in progress.

On graphical user interfaces this function should also check for user interaction and/or update the GUI (e.g. by calling qApp->processEvents() when using QT/KDE).

This function MUST return immediately (non-blocking).

Returns:
0 if ok, !=0 if the current operation is to be aborted
Parameters:
id id assigned by GWEN_Gui_ProgressStart (if 0 then the last started progress dialog is referred to)
progress new value for progress. A special value is GWEN_GUI_PROGRESS_NONE which means that the progress is unchanged. This might be used as a keepalive call to a GUI.

Definition at line 364 of file gui.c.

References gwenhywfar_gui.

Referenced by GWEN_BufferedIO_ReadRawForced(), GWEN_BufferedIO_WriteRawForced(), and GWEN_Crypt_Token_PluginManager_CheckToken().

GWENHYWFAR_API int GWEN_Gui_ProgressEnd ( uint32_t  id  ) 

Flags the end of the current operation. In graphical user interfaces this call should allow the user to close the progress dialog window.

On graphical user interfaces a call to this function should disable the abort button. It would be best not to close the dialog on receiption of this call but to simply enable a dialog closing (otherwise the user will not be able to see the log messages).

This function MUST return immediately (non-blocking).

Parameters:
id id assigned by GWEN_Gui_ProgressStart (if 0 then the last started progress dialog is referred to)

Definition at line 385 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

Referenced by GWEN_BufferedIO_ReadRawForced(), GWEN_BufferedIO_WriteRawForced(), GWEN_Crypt_Token_PluginManager_CheckToken(), and GWEN_Io_Manager_WaitForRequest().

GWENHYWFAR_API int GWEN_Gui_ProgressLog ( uint32_t  id,
GWEN_LOGGER_LEVEL  level,
const char *  text 
)

Adds a log message to the referred process dialog.

This function MUST return immediately (non-blocking).

Parameters:
id id assigned by GWEN_Gui_ProgressStart (if 0 then the last started progress dialog is referred to)
level log level (see GWEN_Gui_LogLevelPanic ff.)
text Text of the box: UTF-8, with both a normal text and a HTML variant of the text in the same string. See text restrictions note above.

Definition at line 374 of file gui.c.

References gwenhywfar_gui.

Referenced by GWEN_BufferedIO_ReadRawForced(), GWEN_Crypt_Token_InsertCorrectToken(), GWEN_Crypt_Token_InsertToken(), GWEN_Crypt_Token_PluginManager_CheckToken(), GWEN_Crypt_TokenFile__CloseFile(), GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), GWEN_HttpSession__RecvPacket(), GWEN_HttpSession__SetAddress(), GWEN_HttpSession_Init(), GWEN_HttpSession_RecvPacket(), GWEN_HttpSession_SendPacket(), GWEN_Io_LayerTls_GetPeerCert(), and GWEN_Io_Manager_WaitForRequest().

GWENHYWFAR_API uint32_t GWEN_Gui_ProgressStart ( uint32_t  progressFlags,
const char *  title,
const char *  text,
uint64_t  total,
uint32_t  guiid 
)

This function is called when a long term operation is started. Theoretically nesting is allowed, however, you should refrain from opening multiple progress dialogs to avoid confusion of the user.

This function must return immediately (i.e. it MUST NOT wait for user interaction).

On graphical user interfaces such a dialog should contain a widget for the text presented here, a progress bar, a text widget to collect the log messages received via GWEN_Gui_ProgressLog and a button to allow the user to abort the current operation monitored by this dialog window.

Between a call to this function and one to GWEN_Gui_ProgressEnd the user should not be allowed to close the dialog window.

This function MUST return immediately (non-blocking).

Returns:
id to be used with the other GWEN_Gui_Progress functions.
Parameters:
title title of the dialog
text Text of the box: UTF-8, with both a normal text and a HTML variant of the text in the same string. See text restrictions note above.
total total number of steps of the operation started (i.e. value which represents 100%)

Definition at line 347 of file gui.c.

References gwenhywfar_gui.

Referenced by GWEN_BufferedIO_ReadRawForced(), GWEN_BufferedIO_WriteRawForced(), GWEN_Crypt_Token_PluginManager_CheckToken(), and GWEN_Io_Manager_WaitForRequest().

GWENHYWFAR_API void GWEN_Gui_SetGui ( GWEN_GUI gui  ) 

Definition at line 82 of file gui.c.

References GWEN_Gui_Attach(), GWEN_Gui_free(), and gwenhywfar_gui.

Referenced by test_gui().

GWENHYWFAR_API int GWEN_Gui_SetPasswordStatus ( const char *  token,
const char *  pin,
GWEN_GUI_PASSWORD_STATUS  status,
uint32_t  guiid 
)

This functions sets the status of a password.

Definition at line 444 of file gui.c.

References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.

Referenced by GWEN_Crypt_Token_SetPinStatus().

GWENHYWFAR_API uint32_t GWEN_Gui_ShowBox ( uint32_t  flags,
const char *  title,
const char *  text,
uint32_t  guiid 
)

Shows a box with the given text. This function should return immediately, it should especially NOT wait for user input. This is used to show very important notices the user should see but which don't need user interaction. The message box will be removed later via GWEN_Gui_HideBox. It is ok to allow the user to prematurely close the box.

It is required for every call to this function to be followed later by a corresponding call to GWEN_Gui_HideBox.

This function MUST return immediately (non-blocking).

Returns:
returns an id to be presented to GWEN_Gui_HideBox.
Parameters:
ab banking interface
flags flags, see GWEN_GUI_SHOWBOX_FLAGS_BEEP ff
title title of the box
text Text of the box: UTF-8, with both a normal text and a HTML variant of the text in the same string. See text restrictions note above.

Definition at line 325 of file gui.c.

References gwenhywfar_gui.

Referenced by GWEN_Crypt_Token_BeginEnterPin(), and test_gui().

GWENHYWFAR_API int GWEN_Gui_WaitForSockets ( GWEN_SOCKET_LIST2 readSockets,
GWEN_SOCKET_LIST2 writeSockets,
uint32_t  guiid,
int  msecs 
)


Generated on Wed Jul 9 13:12:29 2008 for gwenhywfar by  doxygen 1.5.6