gui_be.h File Reference

#include <gwenhywfar/gui.h>

Go to the source code of this file.

Typedefs

Prototypes For Virtual User Interaction Functions
typedef int(* GWEN_GUI_CHECKCERT_FN )(GWEN_GUI *gui, const GWEN_SSLCERTDESCR *cert, GWEN_IO_LAYER *io, uint32_t guiid)
typedef int(* GWEN_GUI_GETPASSWORD_FN )(GWEN_GUI *gui, uint32_t flags, const char *token, const char *title, const char *text, char *buffer, int minLen, int maxLen, uint32_t guiid)
typedef void(* GWEN_GUI_HIDEBOX_FN )(GWEN_GUI *gui, uint32_t id)
typedef int(* GWEN_GUI_INPUTBOX_FN )(GWEN_GUI *gui, uint32_t flags, const char *title, const char *text, char *buffer, int minLen, int maxLen, uint32_t guiid)
typedef int(* GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN )(GWEN_GUI *gui, const char *text, unsigned char *buffer, unsigned int bufLength)
typedef int(* GWEN_GUI_LOG_HOOK_FN )(GWEN_GUI *gui, const char *logDomain, GWEN_LOGGER_LEVEL priority, const char *s)
typedef int(* GWEN_GUI_MESSAGEBOX_FN )(GWEN_GUI *gui, uint32_t flags, const char *title, const char *text, const char *b1, const char *b2, const char *b3, uint32_t guiid)
typedef int(* GWEN_GUI_PRINT_FN )(GWEN_GUI *gui, const char *docTitle, const char *docType, const char *descr, const char *text, uint32_t guiid)
typedef int(* GWEN_GUI_PROGRESS_ADVANCE_FN )(GWEN_GUI *gui, uint32_t id, uint64_t progress)
typedef int(* GWEN_GUI_PROGRESS_END_FN )(GWEN_GUI *gui, uint32_t id)
typedef int(* GWEN_GUI_PROGRESS_LOG_FN )(GWEN_GUI *gui, uint32_t id, GWEN_LOGGER_LEVEL level, const char *text)
typedef uint32_t(* GWEN_GUI_PROGRESS_START_FN )(GWEN_GUI *gui, uint32_t progressFlags, const char *title, const char *text, uint64_t total, uint32_t guiid)
typedef int(* GWEN_GUI_SETPASSWORDSTATUS_FN )(GWEN_GUI *gui, const char *token, const char *pin, GWEN_GUI_PASSWORD_STATUS status, uint32_t guiid)
typedef uint32_t(* GWEN_GUI_SHOWBOX_FN )(GWEN_GUI *gui, uint32_t flags, const char *title, const char *text, uint32_t guiid)
typedef int(* GWEN_GUI_WAITFORSOCKETS_FN )(GWEN_GUI *gui, GWEN_SOCKET_LIST2 *readSockets, GWEN_SOCKET_LIST2 *writeSockets, int msecs, uint32_t guiid)

Functions

Setters For Virtual User Interaction Functions
The functions in this group set the corresponding callback function pointers.

GWENHYWFAR_API
GWEN_GUI_CHECKCERT_FN 
GWEN_Gui_SetCheckCertFn (GWEN_GUI *gui, GWEN_GUI_CHECKCERT_FN f)
GWENHYWFAR_API
GWEN_GUI_GETPASSWORD_FN 
GWEN_Gui_SetGetPasswordFn (GWEN_GUI *gui, GWEN_GUI_GETPASSWORD_FN f)
GWENHYWFAR_API GWEN_GUI_HIDEBOX_FN GWEN_Gui_SetHideBoxFn (GWEN_GUI *gui, GWEN_GUI_HIDEBOX_FN f)
GWENHYWFAR_API GWEN_GUI_INPUTBOX_FN GWEN_Gui_SetInputBoxFn (GWEN_GUI *gui, GWEN_GUI_INPUTBOX_FN f)
GWENHYWFAR_API
GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN 
GWEN_Gui_SetKeyDataFromTextOpenSslFn (GWEN_GUI *gui, GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN f)
GWENHYWFAR_API GWEN_GUI_LOG_HOOK_FN GWEN_Gui_SetLogHookFn (GWEN_GUI *gui, GWEN_GUI_LOG_HOOK_FN f)
GWENHYWFAR_API
GWEN_GUI_MESSAGEBOX_FN 
GWEN_Gui_SetMessageBoxFn (GWEN_GUI *gui, GWEN_GUI_MESSAGEBOX_FN f)
GWENHYWFAR_API GWEN_GUI_PRINT_FN GWEN_Gui_SetPrintFn (GWEN_GUI *gui, GWEN_GUI_PRINT_FN f)
GWENHYWFAR_API
GWEN_GUI_PROGRESS_ADVANCE_FN 
GWEN_Gui_SetProgressAdvanceFn (GWEN_GUI *gui, GWEN_GUI_PROGRESS_ADVANCE_FN f)
GWENHYWFAR_API
GWEN_GUI_PROGRESS_END_FN 
GWEN_Gui_SetProgressEndFn (GWEN_GUI *gui, GWEN_GUI_PROGRESS_END_FN f)
GWENHYWFAR_API
GWEN_GUI_PROGRESS_LOG_FN 
GWEN_Gui_SetProgressLogFn (GWEN_GUI *gui, GWEN_GUI_PROGRESS_LOG_FN f)
GWENHYWFAR_API
GWEN_GUI_PROGRESS_START_FN 
GWEN_Gui_SetProgressStartFn (GWEN_GUI *gui, GWEN_GUI_PROGRESS_START_FN f)
GWENHYWFAR_API
GWEN_GUI_SETPASSWORDSTATUS_FN 
GWEN_Gui_SetSetPasswordStatusFn (GWEN_GUI *gui, GWEN_GUI_SETPASSWORDSTATUS_FN f)
GWENHYWFAR_API GWEN_GUI_SHOWBOX_FN GWEN_Gui_SetShowBoxFn (GWEN_GUI *gui, GWEN_GUI_SHOWBOX_FN f)
GWENHYWFAR_API
GWEN_GUI_WAITFORSOCKETS_FN 
GWEN_Gui_SetWaitForSocketsFn (GWEN_GUI *gui, GWEN_GUI_WAITFORSOCKETS_FN f)


Typedef Documentation

typedef int(* GWEN_GUI_CHECKCERT_FN)(GWEN_GUI *gui, const GWEN_SSLCERTDESCR *cert, GWEN_IO_LAYER *io, uint32_t guiid)

Definition at line 197 of file gui_be.h.

typedef int(* GWEN_GUI_GETPASSWORD_FN)(GWEN_GUI *gui, uint32_t flags, const char *token, const char *title, const char *text, char *buffer, int minLen, int maxLen, uint32_t guiid)

This function retrieves a pasword or pin.

Definition at line 155 of file gui_be.h.

typedef void(* GWEN_GUI_HIDEBOX_FN)(GWEN_GUI *gui, uint32_t id)

Please see GWEN_Gui_HideBox for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function.

Definition at line 95 of file gui_be.h.

typedef int(* GWEN_GUI_INPUTBOX_FN)(GWEN_GUI *gui, uint32_t flags, const char *title, const char *text, char *buffer, int minLen, int maxLen, uint32_t guiid)

Please see GWEN_Gui_InputBox for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function.

Definition at line 68 of file gui_be.h.

typedef int(* GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN)(GWEN_GUI *gui, const char *text, unsigned char *buffer, unsigned int bufLength)

Definition at line 202 of file gui_be.h.

typedef int(* GWEN_GUI_LOG_HOOK_FN)(GWEN_GUI *gui, const char *logDomain, GWEN_LOGGER_LEVEL priority, const char *s)

This function is called at the beginning of GWEN_Logger_Log() and my be used to intercept log messages in general (e.g. to divert them to an internal log mechanism of the application).

Returns:
1 if the message has been handled by the application, 0 if the message should be handled as usual
Parameters:
gui pointer to the gui which receives this call
logDomain name of the logging domain (e.g. GWEN_LOGDOMAIN)
priority see GWEN_Logger_Log
s the message to be logged (this is the raw message from the caller)

Definition at line 187 of file gui_be.h.

typedef int(* GWEN_GUI_MESSAGEBOX_FN)(GWEN_GUI *gui, uint32_t flags, const char *title, const char *text, const char *b1, const char *b2, const char *b3, uint32_t guiid)

Please see GWEN_Gui_MessageBox for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function. However, the recommended way is to use Gwenhywfars' heritage functions (see GWEN_INHERIT_SETDATA).

Definition at line 53 of file gui_be.h.

typedef int(* GWEN_GUI_PRINT_FN)(GWEN_GUI *gui, const char *docTitle, const char *docType, const char *descr, const char *text, uint32_t guiid)

This function is used to make the application print something. The same restrictions noted above apply to the text parameter (utf-8, maybe containing HTML). Please see GWEN_Gui_Print for details.

Definition at line 145 of file gui_be.h.

typedef int(* GWEN_GUI_PROGRESS_ADVANCE_FN)(GWEN_GUI *gui, uint32_t id, uint64_t progress)

Please see GWEN_Gui_ProgressAdvance for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function.

Definition at line 117 of file gui_be.h.

typedef int(* GWEN_GUI_PROGRESS_END_FN)(GWEN_GUI *gui, uint32_t id)

Please see GWEN_Gui_ProgressEnd for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function.

Definition at line 137 of file gui_be.h.

typedef int(* GWEN_GUI_PROGRESS_LOG_FN)(GWEN_GUI *gui, uint32_t id, GWEN_LOGGER_LEVEL level, const char *text)

Please see GWEN_Gui_ProgressLog for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function.

Definition at line 127 of file gui_be.h.

typedef uint32_t(* GWEN_GUI_PROGRESS_START_FN)(GWEN_GUI *gui, uint32_t progressFlags, const char *title, const char *text, uint64_t total, uint32_t guiid)

Please see GWEN_Gui_ProgressStart for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function.

Definition at line 104 of file gui_be.h.

typedef int(* GWEN_GUI_SETPASSWORDSTATUS_FN)(GWEN_GUI *gui, 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 168 of file gui_be.h.

typedef uint32_t(* GWEN_GUI_SHOWBOX_FN)(GWEN_GUI *gui, uint32_t flags, const char *title, const char *text, uint32_t guiid)

Please see GWEN_Gui_ShowBox for details.

One way of passing arbitrary additional data to this callback is by means of the GWEN_Gui_GetUserData function.

Definition at line 83 of file gui_be.h.

typedef int(* GWEN_GUI_WAITFORSOCKETS_FN)(GWEN_GUI *gui, GWEN_SOCKET_LIST2 *readSockets, GWEN_SOCKET_LIST2 *writeSockets, int msecs, uint32_t guiid)

Definition at line 191 of file gui_be.h.


Function Documentation

GWENHYWFAR_API GWEN_GUI_CHECKCERT_FN GWEN_Gui_SetCheckCertFn ( GWEN_GUI gui,
GWEN_GUI_CHECKCERT_FN  f 
)

Definition at line 257 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_GETPASSWORD_FN GWEN_Gui_SetGetPasswordFn ( GWEN_GUI gui,
GWEN_GUI_GETPASSWORD_FN  f 
)

Definition at line 206 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_HIDEBOX_FN GWEN_Gui_SetHideBoxFn ( GWEN_GUI gui,
GWEN_GUI_HIDEBOX_FN  f 
)

Definition at line 134 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_INPUTBOX_FN GWEN_Gui_SetInputBoxFn ( GWEN_GUI gui,
GWEN_GUI_INPUTBOX_FN  f 
)

Definition at line 110 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN GWEN_Gui_SetKeyDataFromTextOpenSslFn ( GWEN_GUI gui,
GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN  f 
)

Definition at line 270 of file gui.c.

GWENHYWFAR_API GWEN_GUI_LOG_HOOK_FN GWEN_Gui_SetLogHookFn ( GWEN_GUI gui,
GWEN_GUI_LOG_HOOK_FN  f 
)

Definition at line 231 of file gui.c.

GWENHYWFAR_API GWEN_GUI_MESSAGEBOX_FN GWEN_Gui_SetMessageBoxFn ( GWEN_GUI gui,
GWEN_GUI_MESSAGEBOX_FN  f 
)

Definition at line 98 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_PRINT_FN GWEN_Gui_SetPrintFn ( GWEN_GUI gui,
GWEN_GUI_PRINT_FN  f 
)

Definition at line 194 of file gui.c.

GWENHYWFAR_API GWEN_GUI_PROGRESS_ADVANCE_FN GWEN_Gui_SetProgressAdvanceFn ( GWEN_GUI gui,
GWEN_GUI_PROGRESS_ADVANCE_FN  f 
)

Definition at line 159 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_PROGRESS_END_FN GWEN_Gui_SetProgressEndFn ( GWEN_GUI gui,
GWEN_GUI_PROGRESS_END_FN  f 
)

Definition at line 183 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_PROGRESS_LOG_FN GWEN_Gui_SetProgressLogFn ( GWEN_GUI gui,
GWEN_GUI_PROGRESS_LOG_FN  f 
)

Definition at line 171 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_PROGRESS_START_FN GWEN_Gui_SetProgressStartFn ( GWEN_GUI gui,
GWEN_GUI_PROGRESS_START_FN  f 
)

Definition at line 147 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_SETPASSWORDSTATUS_FN GWEN_Gui_SetSetPasswordStatusFn ( GWEN_GUI gui,
GWEN_GUI_SETPASSWORDSTATUS_FN  f 
)

Definition at line 219 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_SHOWBOX_FN GWEN_Gui_SetShowBoxFn ( GWEN_GUI gui,
GWEN_GUI_SHOWBOX_FN  f 
)

Definition at line 122 of file gui.c.

Referenced by GWEN_Gui_CGui_new().

GWENHYWFAR_API GWEN_GUI_WAITFORSOCKETS_FN GWEN_Gui_SetWaitForSocketsFn ( GWEN_GUI gui,
GWEN_GUI_WAITFORSOCKETS_FN  f 
)

Definition at line 244 of file gui.c.


Generated on Wed Sep 3 15:22:00 2008 for gwenhywfar by  doxygen 1.5.6