|
gwenhywfar
5.4.1
|
#include <gwenhywfar/gui.h>
Go to the source code of this file.
Typedefs | |
Prototypes For Standard Virtual User Interaction Functions | |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_PRINT_FN) (GWEN_GUI *gui, const char *docTitle, const char *docType, const char *descr, const char *text, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | 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, GWEN_GUI_PASSWORD_METHOD methodId, GWEN_DB_NODE *methodParams, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_SETPASSWORDSTATUS_FN) (GWEN_GUI *gui, const char *token, const char *pin, GWEN_GUI_PASSWORD_STATUS status, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_LOG_HOOK_FN) (GWEN_GUI *gui, const char *logDomain, GWEN_LOGGER_LEVEL priority, const char *s) |
Prototypes For Virtual Helper Functions | |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_WAITFORSOCKETS_FN) (GWEN_GUI *gui, GWEN_SOCKET_LIST2 *readSockets, GWEN_SOCKET_LIST2 *writeSockets, int msecs, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_CHECKCERT_FN) (GWEN_GUI *gui, const GWEN_SSLCERTDESCR *cert, GWEN_SYNCIO *sio, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_GET_FILENAME_FN) (GWEN_GUI *gui, const char *caption, GWEN_GUI_FILENAME_TYPE fnt, uint32_t flags, const char *patterns, GWEN_BUFFER *pathBuffer, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_GETSYNCIO_FN) (GWEN_GUI *gui, const char *url, const char *defaultProto, int defaultPort, GWEN_SYNCIO **pSio) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN) (GWEN_GUI *gui, const char *text, unsigned char *buffer, unsigned int bufLength) |
Prototypes For Virtual Dialog Functions | |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_EXEC_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_OPEN_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_CLOSE_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_RUN_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg, int timeout) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_READ_DIALOG_PREFS_FN) (GWEN_GUI *gui, const char *groupName, const char *altName, GWEN_DB_NODE **pDb) |
| typedef int GWENHYWFAR_CB(* | GWEN_GUI_WRITE_DIALOG_PREFS_FN) (GWEN_GUI *gui, const char *groupName, GWEN_DB_NODE *db) |
Prototypes For Virtual Lowlevel User Interaction Functions | |
Please note that these virtual functions are now obsolete since the dialog framework is now able to handle them. If these functions are unchanged then the current dialog framework implementation will handle them. Currently there are implementations for FOX1.6, QT3 and QT4. | |
| 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_INPUTBOX_FN) (GWEN_GUI *gui, uint32_t flags, const char *title, const char *text, char *buffer, int minLen, int maxLen, 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 void(* | GWEN_GUI_HIDEBOX_FN) (GWEN_GUI *gui, uint32_t id) |
| 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_PROGRESS_ADVANCE_FN) (GWEN_GUI *gui, uint32_t id, uint64_t progress) |
| typedef int(* | GWEN_GUI_PROGRESS_SETTOTAL_FN) (GWEN_GUI *gui, uint32_t id, uint64_t total) |
| typedef int(* | GWEN_GUI_PROGRESS_LOG_FN) (GWEN_GUI *gui, uint32_t id, GWEN_LOGGER_LEVEL level, const char *text) |
| typedef int(* | GWEN_GUI_PROGRESS_END_FN) (GWEN_GUI *gui, uint32_t id) |
| typedef int GWENHYWFAR_CB(* GWEN_GUI_CHECKCERT_FN) (GWEN_GUI *gui, const GWEN_SSLCERTDESCR *cert, GWEN_SYNCIO *sio, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* GWEN_GUI_CLOSE_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg) |
| typedef int GWENHYWFAR_CB(* GWEN_GUI_EXEC_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* GWEN_GUI_GET_FILENAME_FN) (GWEN_GUI *gui, const char *caption, GWEN_GUI_FILENAME_TYPE fnt, uint32_t flags, const char *patterns, GWEN_BUFFER *pathBuffer, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* 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, GWEN_GUI_PASSWORD_METHOD methodId, GWEN_DB_NODE *methodParams, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* GWEN_GUI_GETSYNCIO_FN) (GWEN_GUI *gui, const char *url, const char *defaultProto, int defaultPort, GWEN_SYNCIO **pSio) |
| typedef void(* GWEN_GUI_HIDEBOX_FN) (GWEN_GUI *gui, uint32_t id) |
Please see GWEN_Gui_HideBox for details.
| 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.
| typedef int GWENHYWFAR_CB(* GWEN_GUI_KEYDATAFROMTEXT_OPENSSL_FN) (GWEN_GUI *gui, const char *text, unsigned char *buffer, unsigned int bufLength) |
| typedef int GWENHYWFAR_CB(* 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).
| 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) |
| 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.
| typedef int GWENHYWFAR_CB(* GWEN_GUI_OPEN_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* 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.
| typedef int(* GWEN_GUI_PROGRESS_ADVANCE_FN) (GWEN_GUI *gui, uint32_t id, uint64_t progress) |
Please see GWEN_Gui_ProgressAdvance for details.
| typedef int(* GWEN_GUI_PROGRESS_END_FN) (GWEN_GUI *gui, uint32_t id) |
Please see GWEN_Gui_ProgressEnd for details.
| 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.
| typedef int(* GWEN_GUI_PROGRESS_SETTOTAL_FN) (GWEN_GUI *gui, uint32_t id, uint64_t total) |
Please see GWEN_Gui_ProgressSetTotal for details.
| 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.
| typedef int GWENHYWFAR_CB(* GWEN_GUI_READ_DIALOG_PREFS_FN) (GWEN_GUI *gui, const char *groupName, const char *altName, GWEN_DB_NODE **pDb) |
| typedef int GWENHYWFAR_CB(* GWEN_GUI_RUN_DIALOG_FN) (GWEN_GUI *gui, GWEN_DIALOG *dlg, int timeout) |
| typedef int GWENHYWFAR_CB(* 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) |
Please see GWEN_Gui_ShowBox for details.
| typedef int GWENHYWFAR_CB(* GWEN_GUI_WAITFORSOCKETS_FN) (GWEN_GUI *gui, GWEN_SOCKET_LIST2 *readSockets, GWEN_SOCKET_LIST2 *writeSockets, int msecs, uint32_t guiid) |
| typedef int GWENHYWFAR_CB(* GWEN_GUI_WRITE_DIALOG_PREFS_FN) (GWEN_GUI *gui, const char *groupName, GWEN_DB_NODE *db) |
| GWENHYWFAR_API int GWEN_Gui_ConvertFromUtf8 | ( | const GWEN_GUI * | gui, |
| const char * | text, | ||
| int | len, | ||
| GWEN_BUFFER * | tbuf | ||
| ) |
This function converts the given text from UTF-8 to the character set selected by GWEN_Gui_SetCharSet before writing it to the given buffer.
Definition at line 244 of file gui.c.
References DBG_INFO, GWEN_Gui_ConvertString(), and GWEN_LOGDOMAIN.

| GWENHYWFAR_API int GWENHYWFAR_API void GWEN_Gui_GetRawText | ( | const GWEN_GUI * | gui, |
| const char * | text, | ||
| GWEN_BUFFER * | tbuf | ||
| ) |
This function extracts the raw text (i.e. the part outside a HTML element) so it can, for example, be fed to GWEN_Gui_StdPrintf afterwards.
| GWENHYWFAR_API int GWEN_Gui_ReadDialogPrefs | ( | const char * | groupName, |
| const char * | altName, | ||
| GWEN_DB_NODE ** | pDb | ||
| ) |
Let the application read a GWEN_DB. This function is used by the platform-independent dialogs to read GUI settings (e.g. width, height etc).
This is implemented by AB_Gui, an extension of the GWEN_GUI in AqBanking using AqBanking's shared configuration module to load/save dialog settings.
| groupName | name of the db to load |
| altName | alternative name in case there is no group of the name groupName |
| pDb | pointer to receive the GWEN_DB read |
Definition at line 1547 of file gui.c.
References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.
Referenced by GWEN_Dialog_new().

| GWENHYWFAR_API GWEN_GUI_CHECKCERT_FN GWEN_Gui_SetCheckCertFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_CHECKCERT_FN | f | ||
| ) |
Definition at line 568 of file gui.c.
Referenced by CppGui::CppGui().

| GWENHYWFAR_API GWEN_GUI_CLOSE_DIALOG_FN GWEN_Gui_SetCloseDialogFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_CLOSE_DIALOG_FN | f | ||
| ) |
Definition at line 607 of file gui.c.
Referenced by Cocoa_Gui_new(), CppGui::CppGui(), Gtk2_Gui_new(), and Gtk3_Gui_new().

| GWENHYWFAR_API GWEN_GUI_EXEC_DIALOG_FN GWEN_Gui_SetExecDialogFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_EXEC_DIALOG_FN | f | ||
| ) |
Definition at line 581 of file gui.c.
Referenced by Cocoa_Gui_new(), CppGui::CppGui(), Gtk2_Gui_new(), and Gtk3_Gui_new().

| GWENHYWFAR_API GWEN_GUI_GET_FILENAME_FN GWEN_Gui_SetGetFileNameFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_GET_FILENAME_FN | f | ||
| ) |
Definition at line 659 of file gui.c.
Referenced by Cocoa_Gui_new(), CppGui::CppGui(), Gtk2_Gui_new(), and Gtk3_Gui_new().

| GWENHYWFAR_API GWEN_GUI_GETPASSWORD_FN GWEN_Gui_SetGetPasswordFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_GETPASSWORD_FN | f | ||
| ) |
Definition at line 514 of file gui.c.
Referenced by CppGui::CppGui().

| GWENHYWFAR_API GWEN_GUI_GETSYNCIO_FN GWEN_Gui_SetGetSyncIoFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_GETSYNCIO_FN | f | ||
| ) |
| GWENHYWFAR_API GWEN_GUI_HIDEBOX_FN GWEN_Gui_SetHideBoxFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_HIDEBOX_FN | f | ||
| ) |
Definition at line 428 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 402 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 | ||
| ) |
| GWENHYWFAR_API GWEN_GUI_LOG_HOOK_FN GWEN_Gui_SetLogHookFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_LOG_HOOK_FN | f | ||
| ) |
Definition at line 540 of file gui.c.
Referenced by CppGui::CppGui(), TestGui_Extend(), and TestGui_Unextend().

| GWENHYWFAR_API GWEN_GUI_MESSAGEBOX_FN GWEN_Gui_SetMessageBoxFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_MESSAGEBOX_FN | f | ||
| ) |
Definition at line 389 of file gui.c.
Referenced by GWEN_Gui_CGui_new().

| GWENHYWFAR_API void GWEN_Gui_SetName | ( | GWEN_GUI * | gui, |
| const char * | name | ||
| ) |
Definition at line 732 of file gui.c.
References NULL.
Referenced by FOX16_Gui::FOX16_Gui(), QT4_Gui::QT4_Gui(), and QT5_Gui::QT5_Gui().

| GWENHYWFAR_API GWEN_GUI_OPEN_DIALOG_FN GWEN_Gui_SetOpenDialogFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_OPEN_DIALOG_FN | f | ||
| ) |
Definition at line 594 of file gui.c.
Referenced by Cocoa_Gui_new(), CppGui::CppGui(), Gtk2_Gui_new(), and Gtk3_Gui_new().

| GWENHYWFAR_API GWEN_GUI_PRINT_FN GWEN_Gui_SetPrintFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_PRINT_FN | f | ||
| ) |
Definition at line 501 of file gui.c.
Referenced by CppGui::CppGui().

| GWENHYWFAR_API GWEN_GUI_PROGRESS_ADVANCE_FN GWEN_Gui_SetProgressAdvanceFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_PROGRESS_ADVANCE_FN | f | ||
| ) |
Definition at line 453 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 489 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 477 of file gui.c.
Referenced by GWEN_Gui_CGui_new().

| GWENHYWFAR_API GWEN_GUI_PROGRESS_SETTOTAL_FN GWEN_Gui_SetProgressSetTotalFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_PROGRESS_SETTOTAL_FN | f | ||
| ) |
Definition at line 465 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 441 of file gui.c.
Referenced by GWEN_Gui_CGui_new().

| GWENHYWFAR_API GWEN_GUI_READ_DIALOG_PREFS_FN GWEN_Gui_SetReadDialogPrefsFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_READ_DIALOG_PREFS_FN | f | ||
| ) |
| GWENHYWFAR_API GWEN_GUI_RUN_DIALOG_FN GWEN_Gui_SetRunDialogFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_RUN_DIALOG_FN | f | ||
| ) |
Definition at line 620 of file gui.c.
Referenced by Cocoa_Gui_new(), CppGui::CppGui(), Gtk2_Gui_new(), and Gtk3_Gui_new().

| GWENHYWFAR_API GWEN_GUI_SETPASSWORDSTATUS_FN GWEN_Gui_SetSetPasswordStatusFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_SETPASSWORDSTATUS_FN | f | ||
| ) |
Definition at line 527 of file gui.c.
Referenced by CppGui::CppGui().

| GWENHYWFAR_API GWEN_GUI_SHOWBOX_FN GWEN_Gui_SetShowBoxFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_SHOWBOX_FN | f | ||
| ) |
Definition at line 415 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 | ||
| ) |
| GWENHYWFAR_API GWEN_GUI_WRITE_DIALOG_PREFS_FN GWEN_Gui_SetWriteDialogPrefsFn | ( | GWEN_GUI * | gui, |
| GWEN_GUI_WRITE_DIALOG_PREFS_FN | f | ||
| ) |
| GWENHYWFAR_API int GWEN_Gui_StdPrintf | ( | const GWEN_GUI * | gui, |
| FILE * | stream, | ||
| const char * | fmt, | ||
| ... | |||
| ) |
This function converts the given text from UTF-8 to the character set selected by GWEN_Gui_SetCharSet before writing it to the specified stream. It is intended to be used instead of fprintf() for all output to the terminal (stdout, stderr).
| GWENHYWFAR_API void GWEN_Gui_UseDialogs | ( | GWEN_GUI * | gui | ) |
The implementation should call this function if it implements the dialog framework. It sets the obsoleted callbacks to use the GWEN_DIALOG framework.
Definition at line 130 of file gui.c.
References DBG_INFO, GWEN_Gui_Internal_HideBox(), GWEN_Gui_Internal_InputBox(), GWEN_Gui_Internal_MessageBox(), GWEN_Gui_Internal_ProgressAdvance(), GWEN_Gui_Internal_ProgressEnd(), GWEN_Gui_Internal_ProgressLog(), GWEN_Gui_Internal_ProgressSetTotal(), GWEN_Gui_Internal_ProgressStart(), GWEN_Gui_Internal_ShowBox(), and GWEN_LOGDOMAIN.
Referenced by Cocoa_Gui_new(), CppGui::CppGui(), FOX16_Gui::FOX16_Gui(), Gtk2_Gui_new(), Gtk3_Gui_new(), QT4_Gui::QT4_Gui(), and QT5_Gui::QT5_Gui().


| GWENHYWFAR_API int GWEN_Gui_WriteDialogPrefs | ( | const char * | groupName, |
| GWEN_DB_NODE * | db | ||
| ) |
Let the application write a GWEN_DB. This function is used by the platform-independent dialogs to write GUI settings (e.g. width, height etc).
| groupName | name of the db to save |
| pDb | pointer to receive the GWEN_DB read |
Definition at line 1558 of file gui.c.
References GWEN_ERROR_NOT_IMPLEMENTED, and gwenhywfar_gui.
Referenced by GWEN_Dialog_free().

1.8.14