gui_template.h
Last updated: 17-Sep-2025
Go to the documentation of this file.
1Â // -*- Mode: C++; -*- 2Â #ifndef GUI_TEMPLATE_H_2014_11_17 3Â #define GUI_TEMPLATE_H_2014_11_17 4Â 10Â #include "gui.h" 11Â 12Â #if defined _WIN32 && defined VFI_GUIPRT_SHARED_EXPORT 13Â # define DllSpec __declspec(dllexport) 14Â #elif defined __GNUC__ && defined VFI_GUIPRT_SHARED_EXPORT 15Â # define DllSpec __attribute__((visibility ("default"))) 16Â #else 17Â # define DllSpec 18Â #endif 19Â 21Â #ifndef DOXYGEN 22Â namespace vfigui { 23Â #endif 24Â #if 0 25Â } // just to satisfy automatic indentation of the editor 26Â #endif 27Â 28Â 30Â enum UIMenuOptions { 31Â UI_MENU_DISABLED=1 32Â }; 33Â 43Â DllSpec int uiDisplay(int display, int region_id,const std::string &templateName, const std::string &text); 44Â DllSpec int uiDisplay(int region_id,const std::string &templateName, const std::string &text); 45Â inline int uiDisplay(const std::string &templateName, const std::string &text) 46Â { return uiDisplay(0,UI_REGION_DEFAULT,templateName,text); } 47Â 48Â 60Â DllSpec int uiDisplayAsync(int display,int region_id, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 61Â DllSpec int uiDisplayAsync(int region_id, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 62Â inline int uiDisplayAsync(const std::string &text, uiAsyncCallback cb=0, void *data=0 ) 63Â { return uiDisplayAsync(0,UI_REGION_DEFAULT,text,cb,data); } 64Â 78Â DllSpec int uiDisplayAsync(int display, int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 79Â DllSpec int uiDisplayAsync(int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 80Â inline int uiDisplayAsync(const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0 ) 81Â { return uiDisplayAsync(0,UI_REGION_DEFAULT,templateName,text,cb,data); } 82Â 83Â 90Â DllSpec int uiDisplayWait(int txn_id, int timeout_msec=-1); 91Â 103Â DllSpec int uiConfirm(int display, int region_id, const std::string &templateName, const std::string &text, uiCallback cb=0, void *cbdata=0); 104Â DllSpec int uiConfirm(int region_id, const std::string &templateName, const std::string &text, uiCallback cb=0, void *cbdata=0); 105Â inline int uiConfirm(const std::string &templateName, const std::string &text, uiCallback cb=0, void *cbdata=0) 106Â { return uiConfirm(0,UI_REGION_DEFAULT,templateName,text,cb,cbdata); } 107Â 121Â DllSpec int uiConfirmAsync(int display,int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 122Â DllSpec int uiConfirmAsync(int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 123Â inline int uiConfirmAsync(const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0 ) 124Â { return uiConfirmAsync(0,UI_REGION_DEFAULT, templateName, text,cb,data); } 125Â 132Â DllSpec int uiConfirmWait(int txn_id, int timeout_msec=-1); 133Â 171Â DllSpec int uiInput(int display, int region_id, const std::string &templateName, std::vector<std::string> &value, const std::string &text, uiCallback cb=0, void *cbdata=0); 172Â DllSpec int uiInput(int region_id, const std::string &templateName, std::vector<std::string> &value, const std::string &text, uiCallback cb=0, void *cbdata=0); 173Â inline int uiInput(const std::string &templateName, std::vector<std::string> &value, const std::string &text, uiCallback cb=0, void *cbdata=0) 174Â { return uiInput(0,UI_REGION_DEFAULT,templateName,value,text,cb,cbdata); } 175Â 191Â DllSpec int uiInputAsync(int display, int region_id, const std::string &templateName, const std::vector<std::string> &value, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 192Â DllSpec int uiInputAsync(int region_id, const std::string &templateName, const std::vector<std::string> &value, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 193Â inline int uiInputAsync(const std::string &templateName, const std::vector<std::string> &value, const std::string &text, uiAsyncCallback cb=0, void *data=0 ) 194Â { return uiInputAsync(0,UI_REGION_DEFAULT, templateName, value, text,cb,data); } 195Â 204Â DllSpec int uiInputWait(int txn_id, std::vector<std::string> &value, int timeout_msec=-1); 205Â 206Â 218Â DllSpec int uiInputPINCheck(int display, int region_id, const std::string &templateName, const std::string &referencePIN, const std::string &text, uiCallback cb=0, void *cbdata=0); 219Â DllSpec int uiInputPINCheck(int region_id, const std::string &templateName, const std::string &referencePIN, const std::string &text, uiCallback cb=0, void *cbdata=0); 220Â inline int uiInputPINCheck(const std::string &templateName, const std::string &referencePIN, const std::string &text, uiCallback cb=0, void *cbdata=0) 221Â { return uiInputPINCheck(0,UI_REGION_DEFAULT,templateName,referencePIN,text,cb,cbdata); } 222Â 223Â 237Â DllSpec int uiInputPINCheckAsync(int display, int region_id, const std::string &templateName, const std::string &referencePIN, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 238Â DllSpec int uiInputPINCheckAsync(int region_id, const std::string &templateName, const std::string &referencePIN, const std::string &text, uiAsyncCallback cb=0, void *data=0 ); 239Â inline int uiInputPINCheckAsync(const std::string &templateName, const std::string &referencePIN, const std::string &text, uiAsyncCallback cb=0, void *data=0) 240Â { return uiInputPINCheckAsync(0,UI_REGION_DEFAULT, templateName, referencePIN, text,cb,data); } 241Â 249Â DllSpec int uiInputPINCheckWait(int txn_id, int timeout_msec=-1); 250Â 251Â 253Â struct UIMenuEntry 254Â { 255Â std::string text; 256Â int value; 257Â unsigned options; 258Â }; 259Â 260Â 274Â DllSpec int uiMenu(int display, int region_id, const std::string &templateName, const std::string &text, const struct UIMenuEntry menu[], int menusize, int preselect, uiCallback cb=0, void *cbdata=0); 275Â DllSpec int uiMenu(int region_id, const std::string &templateName, const std::string &text, const struct UIMenuEntry menu[], int menusize, int preselect, uiCallback cb=0, void *cbdata=0); 276Â inline int uiMenu(const std::string &templateName, const std::string &text, const struct UIMenuEntry menu[], int menusize, int preselect, uiCallback cb=0, void *cbdata=0) 277Â { return uiMenu(0,UI_REGION_DEFAULT,templateName,text,menu,menusize,preselect,cb,cbdata); } 278Â 279Â 295Â DllSpec int uiMenuAsync(int display, int region_id, const std::string &templateName, const std::string &text, const struct UIMenuEntry menu[], int menusize, int preselect, uiAsyncCallback cb=0, void *data=0); 296Â DllSpec int uiMenuAsync(int region_id, const std::string &templateName, const std::string &text, const struct UIMenuEntry menu[], int menusize, int preselect, uiAsyncCallback cb=0, void *data=0); 297Â inline int uiMenuAsync(const std::string &template_name, const std::string &text, const struct UIMenuEntry menu[], int menusize, int preselect, uiAsyncCallback cb=0, void *data=0) 298Â { return uiMenuAsync(0,UI_REGION_DEFAULT, template_name, text, menu, menusize, preselect,cb,data); } 299Â 306Â DllSpec int uiMenuWait(int txn_id, int timeout_msec=-1); 307Â 308Â 309Â #ifndef DOXYGEN 310Â } // namespace vfigui 311Â #endif 312Â 313Â 316Â #undef DllSpec 317Â 318Â #endif
Rate this article: