Data Structures
struct	UIBacklight
class	UICBData
class	UIDrawing
struct	UIErrorEntry
struct	UIMenuEntry
struct	UIRegion
struct	UIStatistics
struct	UITextWidth

Typedefs
typedef bool(*	uiCallback) (void *data)
typedef void(*	uiAsyncCallback) (void *data, UICBType type, UICBData &uidata)
typedef void(*	uiDisconnectCallback) (int display)
typedef void(*	uiEventCallback) (void *data, UICanvasEvent event, int x, int y, int key, unsigned flags)

Enumerations
enum	UICBType { UI_CB_RESULT, UI_CB_UPDATE, UI_CB_LOAD, UI_CB_ERROR_LIST, UI_CB_STATISTICS, UI_CB_EVENT }
enum	{ UI_REGION_DEFAULT =0 }
enum	{ UI_REGION_FLAG_HIDDEN =1 }
enum	UIPropertyInt { UI_PROP_TIMEOUT =0, UI_PROP_PASSWORD_CHAR, UI_PROP_DEFAULT_FONT_SIZE, UI_PROP_PIN_AUTO_ENTER, UI_PROP_PIN_CLEAR_ALL, UI_PROP_PIN_BYPASS_KEY, UI_PROP_PIN_ALGORITHM, UI_PROP_PIN_INTERCHAR_TIMEOUT, UI_PROP_PASSWORD_SHOW_CHAR, UI_PROP_KEEP_DISPLAY, UI_PROP_UPDATE_EVENTS, UI_PROP_CIRCULAR_MENU, UI_PROP_TOUCH_ACTION_BEEP, UI_PROP_STATISTICS, UI_PROP_RESTRICTED, UI_PROP_CP_APP_MODE, UI_PROP_SCROLL_COLOR, UI_PROP_INPUT_ERROR_BEEP, UI_PROP_ZOOM_MAX, UI_PROP_SCROLL_DISPLAY, UI_PROP_JS_QUOTA_SIZE, UI_DEVICE_WIDTH =1000, UI_DEVICE_HEIGHT, UI_DEVICE_COLOR_DEPTH, UI_DEVICE_SUPPORTS_TOUCH, UI_DEVICE_SUPPORTS_BEEPER, UI_DEVICE_SUPPORTS_AUDIO, UI_DEVICE_SUPPORTS_VIDEO, UI_DEVICE_SUPPORTS_SIGCAP, UI_DEVICE_SUPPORTS_COLOR_DISPLAY, UI_DEVICE_HAS_CAP_TOUCH_KEYPAD, UI_DEVICE_SUPPORTS_NAVIGATOR_MODE, UI_DEVICE_KEY_COUNT }
enum	UIPropertyString { UI_PROP_DECIMAL_SEPARATOR =2000, UI_PROP_THOUSANDS_SEPARATOR, UI_PROP_DEFAULT_FONT, UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX, UI_PROP_KEYMAP, UI_PROP_CSS, UI_PROP_RESOURCE_DEFAULT_PATH, UI_PROP_GUI_EXTENSIONS, UI_PROP_HTTP_HEADER_FIELDS, UI_PROP_CP_APP_DIR, UI_PROP_LANGUAGE, UI_PROP_JS_ROOT, UI_PROP_PRINT_ROOT, UI_PROP_PRINT_CSS, UI_PROP_JS_QUOTA_ROOT, UI_DEVICE_MODEL =3000 }
enum	UIServerProperty { UI_SERVER_TOUCH_ACTION_BEEP, UI_SERVER_INPUT_ERROR_BEEP, UI_SERVER_KEYMAP }
enum	{ UI_TRANS_UP =0x1, UI_TRANS_RIGHT =0x2, UI_TRANS_DOWN =0x4, UI_TRANS_LEFT =0x8, UI_TRANS_DIRECTION_MASK =0xf, UI_TRANS_EASE_IN =0x10, UI_TRANS_EASE_OUT =0x20, UI_TRANS_EASE_INOUT =0x30, UI_TRANS_EASE_MASK =0x30, UI_TRANS_NONE =0x000, UI_TRANS_SLIDE =0x100, UI_TRANS_SLIDEON =0x200, UI_TRANS_SWAP =0x300, UI_TRANS_CROSSFADE =0x400, UI_TRANS_TYPE_MASK =0xfff00 }
enum	UILEDShape { UI_SHAPE_RECTANGLE, UI_SHAPE_ELLIPSE }
enum	UIEdge { UI_EDGE_TOP, UI_EDGE_RIGHT, UI_EDGE_BOTTOM, UI_EDGE_LEFT }
enum	UIScrollPosition { UI_SCROLL_TOP, UI_SCROLL_BOTTOM }
enum	UIBeep { UI_BEEP_NORMAL, UI_BEEP_ERROR }
enum	UINagScreenType { UI_NAG_TEST_DEVICE }
enum	UICanvasEvent { UI_PUSH, UI_DRAG, UI_RELEASE, UI_KEYDOWN, UI_KEYUP, UI_TERMINATE }
enum	UIMenuOptions { UI_MENU_DISABLED =1 }

Functions
DllSpec void	uiSetConnectAttempts (int num)
DllSpec int	uiGetConnectAttempts ()
DllSpec void	uiSetDisconnectCallback (uiDisconnectCallback cb)
DllSpec uiDisconnectCallback	uiGetDisconnectCallback ()
DllSpec void	uiSetKeepalive (int count, int interval)
DllSpec void	uiGetKeepalive (int &count, int &interval)
DllSpec void	uiDisconnect (int display)
DllSpec int	uiReadRuntimeID (int display, std::string &id, int timeout_msec=5000)
DllSpec std::string	uiPrint (const char *format,...)
DllSpec std::string	uiPrintV (const char *format, va_list va)
DllSpec int	uiDisplayCount ()
DllSpec int	uiDisplay (int display, int region_id, const std::string &text)
DllSpec int	uiDisplay (int region_id, const std::string &text)
int	uiDisplay (const std::string &text)
DllSpec int	uiInvoke (int display, int region_id, stringmap &value, const std::string &text, uiCallback cb=0, void *cbdata=0)
DllSpec int	uiInvoke (int region_id, stringmap &value, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvoke (stringmap &value, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvoke (int display, int region_id, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvoke (int region_id, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvoke (const std::string &text, uiCallback cb=0, void *cbdata=0)
DllSpec int	uiInvokeTemplate (int display, int region_id, stringmap &value, const std::string &template_name, const std::string &text, uiCallback cb=0, void *cbdata=0)
DllSpec int	uiInvokeTemplate (int region_id, stringmap &value, const std::string &template_name, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvokeTemplate (stringmap &value, const std::string &template_name, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvokeTemplate (int display, int region_id, const std::string &template_name, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvokeTemplate (int region_id, const std::string &template_name, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInvokeTemplate (const std::string &template_name, const std::string &text, uiCallback cb=0, void *cbdata=0)
DllSpec int	uiInvokeURL (int display, int region_id, stringmap &value, const char url, uiCallback cb=0, void cbdata=0)
DllSpec int	uiInvokeURL (int region_id, stringmap &value, const char url, uiCallback cb=0, void cbdata=0)
int	uiInvokeURL (stringmap &value, const char url, uiCallback cb=0, void cbdata=0)
int	uiInvokeURL (int display, int region_id, const char url, uiCallback cb=0, void cbdata=0)
int	uiInvokeURL (int region_id, const char url, uiCallback cb=0, void cbdata=0)
int	uiInvokeURL (const char url, uiCallback cb=0, void cbdata=0)
DllSpec int	uiInvokeURL (int display, int region_id, stringmap &value, const std::string &url, uiCallback cb=0, void *cbdata=0)
int	uiInvokeURL (int region_id, stringmap &value, const std::string &url, uiCallback cb=0, void *cbdata=0)
int	uiInvokeURL (stringmap &value, const std::string &url, uiCallback cb=0, void *cbdata=0)
int	uiInvokeURL (int display, int region_id, const std::string &url, uiCallback cb=0, void *cbdata=0)
int	uiInvokeURL (int region_id, const std::string &url, uiCallback cb=0, void *cbdata=0)
int	uiInvokeURL (const std::string &url, uiCallback cb=0, void *cbdata=0)
DllSpec int	uiInvokeAsync (int display, int region_id, const stringmap &value, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiInvokeAsync (int region_id, const stringmap &value, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeAsync (const stringmap &value, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeAsync (int display, int region_id, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeAsync (int region_id, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeAsync (const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiInvokeTemplateAsync (int display, int region_id, const stringmap &value, const std::string &template_name, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiInvokeTemplateAsync (int region_id, const stringmap &value, const std::string &template_name, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeTemplateAsync (const stringmap &value, const std::string &template_name, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeTemplateAsync (int display, int region_id, const std::string &template_name, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeTemplateAsync (int region_id, const std::string &template_name, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeTemplateAsync (const std::string &template_name, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiInvokeURLAsync (int display, int region_id, const stringmap &value, const char url, uiAsyncCallback cb=0, void data=0)
DllSpec int	uiInvokeURLAsync (int region_id, const stringmap &value, const char url, uiAsyncCallback cb=0, void data=0)
int	uiInvokeURLAsync (const stringmap &value, const char url, uiAsyncCallback cb=0, void data=0)
int	uiInvokeURLAsync (int display, int region_id, const char url, uiAsyncCallback cb=0, void data=0)
int	uiInvokeURLAsync (int region_id, const char url, uiAsyncCallback cb=0, void data=0)
int	uiInvokeURLAsync (const char url, uiAsyncCallback cb=0, void data=0)
DllSpec int	uiInvokeURLAsync (int display, int region_id, const stringmap &value, const std::string &url, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeURLAsync (int region_id, const stringmap &value, const std::string &url, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeURLAsync (const stringmap &value, const std::string &url, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeURLAsync (int display, int region_id, const std::string &url, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeURLAsync (int region_id, const std::string &url, uiAsyncCallback cb=0, void *data=0)
int	uiInvokeURLAsync (const std::string &url, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiInvokeWait (int txn_id, std::map< std::string, std::string > &value, int timeout_msec=-1)
int	uiInvokeWait (int txn_id, int timeout_msec=-1)
DllSpec int	uiInvokeCancel (int txn_id, std::map< std::string, std::string > &value)
int	uiInvokeCancel (int txn_id)
DllSpec int	uiInvokeCancelAsync (int txn_id)
DllSpec int	uiInvokeURLDetached (int display, int region_id, const char *url)
DllSpec int	uiInvokeURLDetached (int region_id, const char *url)
int	uiInvokeURLDetached (const char *url)
DllSpec int	uiClear (int display, int region_id)
int	uiClear (int region_id)
DllSpec int	uiSetPropertyInt (int display, enum UIPropertyInt property, int value)
DllSpec int	uiSetPropertyInt (enum UIPropertyInt property, int value)
DllSpec int	uiGetPropertyInt (int display, enum UIPropertyInt property, int *value)
DllSpec int	uiGetPropertyInt (enum UIPropertyInt property, int *value)
DllSpec int	uiSetPropertyString (int display, enum UIPropertyString property, const char *value)
DllSpec int	uiSetPropertyString (enum UIPropertyString property, const char *value)
int	uiSetPropertyString (int display, enum UIPropertyString property, const std::string &value)
int	uiSetPropertyString (enum UIPropertyString property, const std::string &value)
DllSpec int	uiGetPropertyString (int display, enum UIPropertyString property, char *value, int len)
DllSpec int	uiGetPropertyString (enum UIPropertyString property, char *value, int len)
DllSpec int	uiGetPropertyString (int display, enum UIPropertyString property, std::string &value)
DllSpec int	uiGetPropertyString (enum UIPropertyString property, std::string &value)
DllSpec int	uiSetServerProperty (int display, enum UIServerProperty property, const std::string &value)
DllSpec int	uiGetServerProperty (int display, enum UIServerProperty property, std::string &value)
DllSpec std::string	uiGetTerminalResourceDir (int display, const std::string &www_path)
DllSpec std::string	uiGetTerminalResourceDir (const std::string &www_path)
DllSpec std::string	uiGetKeypadType (int display)
DllSpec void	uiSetLocalProperties (bool local)
DllSpec bool	uiGetLocalProperties ()
DllSpec int	uiLayout (int display, const UIRegion region, int regcnt, const UIRegion oldreg, int oldregcnt)
DllSpec int	uiLayout (const UIRegion region, int regcnt, const UIRegion oldreg, int oldregcnt)
DllSpec int	uiLayout (int display, const UIRegion *region, int regcnt)
DllSpec int	uiLayout (const UIRegion *region, int regcnt)
int	uiLayout (int display, const std::vector< UIRegion > &reg)
int	uiLayout (const std::vector< UIRegion > &reg)
int	uiLayout (int display, const std::vector< UIRegion > &reg, const std::vector< UIRegion > &oldreg)
int	uiLayout (const std::vector< UIRegion > &reg, const std::vector< UIRegion > &oldreg)
DllSpec int	uiLayout (int display, const char *name)
DllSpec int	uiLayout (const char *name)
DllSpec int	uiGetLayout (int display, std::vector< UIRegion > &region)
DllSpec int	uiGetLayout (std::vector< UIRegion > &region)
DllSpec int	uiGetRegionSize (int display, int region_id, int &width, int &height)
int	uiGetRegionSize (int region_id, int &width, int &height)
DllSpec int	uiEnterRegion (int display, int region_id)
DllSpec int	uiEnterRegion (int region_id)
DllSpec int	uiLeaveRegion (int display)
DllSpec int	uiLeaveRegion ()
DllSpec std::string	uiCurrentRegionPath (int display)
DllSpec std::string	uiCurrentRegionPath ()
DllSpec int	uiSetCurrentRegionPath (int display, const std::string &path)
DllSpec int	uiSetCurrentRegionPath (const std::string &path)
DllSpec int	uiRegionIsVisible (int display, int region_id)
int	uiRegionIsVisible (int region_id)
DllSpec void	uiReadConfig (int display)
DllSpec void	uiReadConfig ()
DllSpec int	uiSetCatalog (int display, const std::string &filename)
DllSpec int	uiSetCatalog (const std::string &filename)
DllSpec std::string	uiGetCatalog (int display)
DllSpec std::string	uiGetCatalog ()
DllSpec void	uiCatalogSetDelayedRelease (unsigned num)
DllSpec unsigned	uiCatalogGetDelayedRelease ()
DllSpec std::string	uiGetText (int display, const std::string &name, const std::string &deflt="")
DllSpec std::string	uiGetText (const std::string &name, const std::string &deflt="")
DllSpec std::string	uiGetText (int display, const std::string &filename, const std::string &name, const std::string &deflt)
DllSpec std::string	uiGetText (const std::string &filename, const std::string &name, const std::string &deflt)
DllSpec int	uiGetHtml (int display, const std::map< std::string, std::string > &value, const std::string &text, std::string &html)
DllSpec int	uiGetHtml (const std::map< std::string, std::string > &value, const std::string &text, std::string &html)
DllSpec int	uiGetHtmlURL (int display, const std::map< std::string, std::string > &value, const std::string &url, std::string &html)
DllSpec int	uiGetHtmlURL (const std::map< std::string, std::string > &value, const std::string &url, std::string &html)
DllSpec std::string	uiGetURLPath (int display, const std::string &url)
DllSpec std::string	uiGetURLPath (const std::string &url)
DllSpec int	uiScreenshotPNG (int display, const char *filename)
DllSpec int	uiScreenshotPNG (const char *filename)
DllSpec int	uiScreenshotPNG (int display, const char *filename, int x, int y, int w, int h)
int	uiScreenshotPNG (const char *filename, int x, int y, int w, int h)
DllSpec int	uiScreenshotPNGData (int display, std::vector< unsigned char > &data)
DllSpec int	uiScreenshotPNGData (std::vector< unsigned char > &data)
DllSpec int	uiScreenshotPNGData (int display, std::vector< unsigned char > &data, int x, int y, int w, int h)
int	uiScreenshotPNGData (std::vector< unsigned char > &data, int x, int y, int w, int h)
DllSpec int	uiURL2PNG (const char *filename, int width, int height, const std::map< std::string, std::string > &value, const std::string &url)
DllSpec int	uiURL2PNGData (std::vector< unsigned char > &data, int width, int height, const std::map< std::string, std::string > &value, const std::string &url)
DllSpec int	uiHTML2PNG (const char *filename, int width, int height, const std::map< std::string, std::string > &value, const std::string &text)
DllSpec int	uiHTML2PNGData (std::vector< unsigned char > &data, int width, int height, const std::map< std::string, std::string > &value, const std::string &text)
const DllSpec char *	uiLibVersion ()
const DllSpec char *	gui_GetVersion ()
const DllSpec char *	gui_GetSvcVersion (int display)
const DllSpec char *	gui_GetSvcVersion ()
DllSpec int	uiSetTransition (int display, int region_id, unsigned transtype, int duration_ms)
DllSpec int	uiSetTransition (int region_id, unsigned transtype, int duration_ms)
int	uiSetTransition (unsigned transtype, int duration_ms)
const DllSpec std::vector< UIErrorEntry > &	uiErrorList ()
const DllSpec UIStatistics &	uiStatistics ()
DllSpec std::string	uiScriptError ()
DllSpec int	uiGetIdleTime (int display=0)
DllSpec void	uiSetLogMask (unsigned mask)
DllSpec unsigned	uiGetLogMask (void)
DllSpec int	uiConfigLEDs (int display, UILEDShape shape, int width, int height, unsigned off_rgba, unsigned on0_rgba, unsigned on1_rgba, unsigned on2_rgba, unsigned on3_rgba)
DllSpec int	uiConfigLEDs (UILEDShape shape, int width, int height, unsigned off_rgba, unsigned on0_rgba, unsigned on1_rgba, unsigned on2_rgba, unsigned on3_rgba)
DllSpec int	uiConfigLEDs (int display, const char *filename)
DllSpec int	uiConfigLEDs (const char *filename)
DllSpec int	uiShowLEDArea (int display, UIEdge edge, int width, int height, unsigned bg_rgba)
DllSpec int	uiShowLEDArea (UIEdge edge, int width, int height, unsigned bg_rgba)
DllSpec int	uiHideLEDArea (int display)
DllSpec int	uiHideLEDArea ()
DllSpec int	uiSetLED (int display, unsigned led, bool state)
DllSpec int	uiSetLED (unsigned led, bool state)
DllSpec int	uiSetBacklightConfig (int display, const std::vector< UIBacklight > &levels)
DllSpec int	uiGetBacklightConfig (int display, std::vector< UIBacklight > &levels)
DllSpec int	uiSetBacklightLevel (int display, int level)
DllSpec int	uiGetBacklightLevel (int display, int &level)
DllSpec int	uiSetInput (int display, int region_id, const std::string &name, const std::string &value)
int	uiSetInput (int region_id, const std::string &name, const std::string &value)
DllSpec int	uiRunAction (int display, int region_id, const std::string &name)
int	uiRunAction (int region_id, const std::string &name)
DllSpec int	uiRunAction2 (int display, int region_id, const std::string &name)
int	uiRunAction2 (int region_id, const std::string &name)
DllSpec int	uiAddOption (int display, int region_id, const std::string &name, const std::string &value, const std::string &text, const std::string &style="", const std::string &action="", int position=-1)
int	uiAddOption (int region_id, const std::string &name, const std::string &value, const std::string &text, const std::string &style="", const std::string &action="", int position=-1)
DllSpec int	uiScrollOption (int display, int region_id, const std::string &name, const std::string &value, UIScrollPosition pos)
int	uiScrollOption (int region_id, const std::string &name, const std::string &value, UIScrollPosition pos)
DllSpec int	uiRemoveOption (int display, int region_id, const std::string &name, const std::string &value)
int	uiRemoveOption (int region_id, const std::string &name, const std::string &value)
DllSpec int	uiDisablePINOK (int display=0)
DllSpec int	uiEnablePINOK (int display=0)
DllSpec int	uiUpdate (int display, int region_id, const std::string &name, const std::string &html)
int	uiUpdate (int region_id, const std::string &name, const std::string &html)
DllSpec int	uiBeep (int display, UIBeep beep)
int	uiBeep (UIBeep beep)
DllSpec int	uiNagScreen (int display, enum UINagScreenType type, int hide, int show)
DllSpec int	uiCanvas (int display, int region_id, uiEventCallback cb, void *data=0)
int	uiCanvas (int region_id, uiEventCallback cb, void *data=0)
DllSpec int	uiDraw (int display, int region_id, const UIDrawing &drawing)
int	uiDraw (int region_id, const UIDrawing &drawing)
DllSpec int	uiDrawAsync (int display, int region_id, const UIDrawing &drawing, uiAsyncCallback cb=0, void *data=0)
int	uiDrawAsync (int region_id, const UIDrawing &drawing, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiTextMetrics (int display, int region_id, const std::string &font, int size, unsigned style, std::vector< UITextWidth > &width, int &height, int &descent)
int	uiTextMetrics (int region_id, const std::string &font, int size, unsigned style, std::vector< UITextWidth > &width, int &height, int &descent)
const DllSpec char *	uiDataURLType (const std::string &in)
DllSpec bool	uiDataURLToString (std::string &out, const std::string &in)
DllSpec bool	uiDataURLToFile (const char *filename, const std::string &in)
DllSpec int	uiDisplay (int display, int region_id, const std::string &templateName, const std::string &text)
DllSpec int	uiDisplay (int region_id, const std::string &templateName, const std::string &text)
int	uiDisplay (const std::string &templateName, const std::string &text)
DllSpec int	uiDisplayAsync (int display, int region_id, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiDisplayAsync (int region_id, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiDisplayAsync (const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiDisplayAsync (int display, int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiDisplayAsync (int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiDisplayAsync (const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiDisplayWait (int txn_id, int timeout_msec=-1)
DllSpec int	uiConfirm (int display, int region_id, const std::string &templateName, const std::string &text, uiCallback cb=0, void *cbdata=0)
DllSpec int	uiConfirm (int region_id, const std::string &templateName, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiConfirm (const std::string &templateName, const std::string &text, uiCallback cb=0, void *cbdata=0)
DllSpec int	uiConfirmAsync (int display, int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiConfirmAsync (int region_id, const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiConfirmAsync (const std::string &templateName, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiConfirmWait (int txn_id, int timeout_msec=-1)
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)
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)
int	uiInput (const std::string &templateName, std::vector< std::string > &value, const std::string &text, uiCallback cb=0, void *cbdata=0)
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)
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)
int	uiInputAsync (const std::string &templateName, const std::vector< std::string > &value, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiInputWait (int txn_id, std::vector< std::string > &value, int timeout_msec=-1)
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)
DllSpec int	uiInputPINCheck (int region_id, const std::string &templateName, const std::string &referencePIN, const std::string &text, uiCallback cb=0, void *cbdata=0)
int	uiInputPINCheck (const std::string &templateName, const std::string &referencePIN, const std::string &text, uiCallback cb=0, void *cbdata=0)
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)
DllSpec int	uiInputPINCheckAsync (int region_id, const std::string &templateName, const std::string &referencePIN, const std::string &text, uiAsyncCallback cb=0, void *data=0)
int	uiInputPINCheckAsync (const std::string &templateName, const std::string &referencePIN, const std::string &text, uiAsyncCallback cb=0, void *data=0)
DllSpec int	uiInputPINCheckWait (int txn_id, int timeout_msec=-1)
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)
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)
int	uiMenu (const std::string &templateName, const std::string &text, const struct UIMenuEntry menu[], int menusize, int preselect, uiCallback cb=0, void *cbdata=0)
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)
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)
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)
DllSpec int	uiMenuWait (int txn_id, int timeout_msec=-1)

Detailed Description

Verifone GUI namespace

Data Structure Documentation

◆ vfigui::UIBacklight

struct vfigui::UIBacklight

backlight brightness level

Data Fields
unsigned	brightness	brightness level (0..100)
unsigned	timeout	timeout in milliseconds after which to switch to the next level (if there is another one)

◆ vfigui::UIMenuEntry

struct vfigui::UIMenuEntry

structure for menu entries

Examples: demo-sysinfo.cpp, mac_demo1.cpp, mac_demo2.cpp, and pm-demo.cpp.

Data Fields
unsigned	options	options, see vfigui::UIMenuOptions
string	text	text to be displayed
int	value	return value

◆ vfigui::UIRegion

struct vfigui::UIRegion

structure describing the position and size of an output region

Data Fields
int	bottom	bottom position in pixels (+=height if negative)
int	flags	flags: UI_REGION_FLAG_HIDDEN
int	id	region ID, 0 is the default region
int	left	left position in pixels (+=width if negative)
int	right	right position in pixels (+=width if negative)
int	top	top position in pixels (+=height if negative)

◆ vfigui::UIStatistics

struct vfigui::UIStatistics

Statistics information

Collaboration diagram for UIStatistics:

[legend]

Data Fields
TimeStamp	css	css loading and parsing has finished
TimeStamp	draw	sending drawing commands to gfx system has finished (initial drawing of the HTML page)
TimeStamp	html	html loading, parsing and layout has finished
TimeStamp	start	starting time

Typedef Documentation

◆ uiAsyncCallback

typedef void(* uiAsyncCallback) (void *data, UICBType type, UICBData &uidata)

callback function that is called when a dialog has returned some data. In case of dialog sequences (e.g. a dialog uses the load-URL action) the callback is invoked after each step of the sequence.

Parameters

[in]	data	data pointer provided by the application
[in]	type	type / reason why the callback was invoked
[in]	uidata	object to access data of the current transaction

The callback will be run within a different thread context, so make sure to use appropriate locking if required. All callback functions share the same thread. Therefore, do not use functions that block for a long time, in particular uiInvokeWait() must not be called.

◆ uiCallback

typedef bool(* uiCallback) (void *data)

Most functions take a display and region_id parameter. For convenience these functions are overloaded so that these parameters may be omitted when using the default display and region:

When the default display is to be used, display may be omitted
When the default region on the default display is to be used display and region_id may be omitted.

If the key-value map is not required for a specific purpose, an overloaded version is provided so that the key-value map can be omitted. callback function that is called at regular intervals while the dialog is displayed. If the callback returns false, the dialog is cancelled;

Parameters

[in]

data

data pointer provided by the application

◆ uiDisconnectCallback

typedef void(* uiDisconnectCallback) (int display)

callback function that is called when the contact to a server is lost. It runs in parallel to UI functions that will return UI_ERR_CONNECTION_LOST so the order of returning the error and invocation of the callback is unspecified.

Parameters

[in]

display

display number

◆ uiEventCallback

typedef void(* uiEventCallback) (void *data, UICanvasEvent event, int x, int y, int key, unsigned flags)

callback function for receiving Canvas events.

Parameters

[in]	data	data pointer provided by the application
[in]	event	event type
[in]	x	x-coordinate (for UI_PUSH, UI_DRAG and UI_RELEASE)
[in]	y	y-coordinate (for UI_PUSH, UI_DRAG and UI_RELEASE)
[in]	key	key code (for UI_KEYDOWN and UI_KEYUP) or return code (UI_TERMINATE)
[in]	flags	reserved for future use, currently always 0

The callback will be run within a different thread context, so make sure to use appropriate locking if required. All callback functions share the same thread. Therefore, do not use functions that block for a long time, in particular uiInvokeWait() must not be called.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
UI_REGION_DEFAULT	default region ID

◆ anonymous enum

anonymous enum

Enumerator
UI_REGION_FLAG_HIDDEN	do not show region: Hiding a region does not terminate the contained dialog

◆ anonymous enum

anonymous enum

bit mask constants for describing the transition

Enumerator
UI_TRANS_UP	movement direction: up, depending on the transition type horizontal an vertical movement may be combined.
UI_TRANS_RIGHT	movement direction: right, depending on the transition type horizontal an vertical movement may be combined.
UI_TRANS_DOWN	movement direction: down, depending on the transition type horizontal an vertical movement may be combined.
UI_TRANS_LEFT	movement direction: left, depending on the transition type horizontal an vertical movement may be combined.
UI_TRANS_DIRECTION_MASK	mask containing the movement direction bits
UI_TRANS_EASE_IN	transition accelerates after the start
UI_TRANS_EASE_OUT	transition decelerates before the end
UI_TRANS_EASE_INOUT	combination of UI_TRANS_EASE_IN and UI_TRANS_EASE_OUT
UI_TRANS_EASE_MASK	mask containing the acceleration bits
UI_TRANS_NONE	No transition
UI_TRANS_SLIDE	The dialog slides to the screen shifting out the old one
UI_TRANS_SLIDEON	The dialog slides to the screen covering the old one
UI_TRANS_SWAP	The new dialog starts behind the old one. Then both slide to opposite sides and then back, this time with the new dialog in front.
UI_TRANS_CROSSFADE	Crossfade between old and new dialog. The movement direction flags are ignored.
UI_TRANS_TYPE_MASK	mask containing the transition type bits

◆ UIBeep

enum UIBeep

Beep

Enumerator
UI_BEEP_NORMAL	normal beep
UI_BEEP_ERROR	error beep

◆ UICanvasEvent

enum UICanvasEvent

Canvas events

Enumerator
UI_PUSH	The user has touched the screen
UI_DRAG	The user is dragging the finger on the screen
UI_RELEASE	The user has released the screen
UI_KEYDOWN	The user has pressed a button on the keypad
UI_KEYUP	The user has released a button on the keypad
UI_TERMINATE	The dialog has terminated, the return code can be found in key

◆ UICBType

enum UICBType

Reason why the callback was invoked

Enumerator
UI_CB_RESULT	callback was invoked due to receiving the result
UI_CB_UPDATE	callback was invoked due to receiving an update event
UI_CB_LOAD	callback was invoked due to switching to a new dialog
UI_CB_ERROR_LIST	callback was invoked due to receiving error data
UI_CB_STATISTICS	callback was invoked due to receiving statistics data
UI_CB_EVENT	callback was invoked due to receiving a custom event

◆ UIEdge

enum UIEdge

Display edge selection

Enumerator
UI_EDGE_TOP	top edge of display
UI_EDGE_RIGHT	right edge of display
UI_EDGE_BOTTOM	bottom edge of display
UI_EDGE_LEFT	left edge of display

◆ UILEDShape

enum UILEDShape

LED shape

Enumerator
UI_SHAPE_RECTANGLE	rectangular shape
UI_SHAPE_ELLIPSE	elliptic shape

◆ UIMenuOptions

enum UIMenuOptions

menu options

Enumerator
UI_MENU_DISABLED	show the menu entry as disabled or leave it out (depending on device)

◆ UINagScreenType

enum UINagScreenType

Nag screen type

Enumerator
UI_NAG_TEST_DEVICE	device is a test device

◆ UIPropertyInt

enum UIPropertyInt

Int properties for configuring global GUI options

Enumerator
UI_PROP_TIMEOUT	Idle timeout in milliseconds, set to -1 to deactivate
UI_PROP_PASSWORD_CHAR	Password masking character
UI_PROP_DEFAULT_FONT_SIZE	Default font size
UI_PROP_PIN_AUTO_ENTER	Automatically terminate the PIN entry when the maximum number of digits has been reached
UI_PROP_PIN_CLEAR_ALL	The clear key deletes all entered digits instead of only the last one
UI_PROP_PIN_BYPASS_KEY	Key code that is used for PIN bypass. Setting it to 0 disables PIN bypass. Supported bypass keys are: 13 (enter/confirm key), 8 (clear/backspace key) Add 1000 to disable bypass as soon as a digit has been entered, e.g. using 1013 will use the enter key as bypass key but only if no digit has been entered in between.
UI_PROP_PIN_ALGORITHM	value used for iPS_SelectPINAlgo(), e.g. EMV_PIN, see "MX 900 Series Programmers Guide"
UI_PROP_PIN_INTERCHAR_TIMEOUT	if >0: inter character timeout for PIN entry in milliseconds
UI_PROP_PASSWORD_SHOW_CHAR	Time (in ms) to show last entered password character before masking it (ignored for PIN entry)
UI_PROP_KEEP_DISPLAY	Determines whether the display is cleared (0) or whether the display keeps displaying the old content (1) when updating the layout using uiLayout. Keeping the display on layout updates does not work on all platforms, therefore, default is to clear.
UI_PROP_UPDATE_EVENTS	if not 0 send update events each time the content of an input field changes or if the URL changes due to a load action (default: 0)
UI_PROP_CIRCULAR_MENU	if not 0 the actions "up" and "down" actions of the menu will not stop at the start/end of the menu but jump to the last/first element instead. (default: 0)
UI_PROP_TOUCH_ACTION_BEEP	if set (1) beep when an action was triggered from the touch screen. (default: 0) May be overwritten by server setting, see also UI_SERVER_TOUCH_ACTION_BEEP
UI_PROP_STATISTICS	if not 0 update statistics information that can be read using uiStatistics. (default: 0)
UI_PROP_RESTRICTED	if set (1) only up to three digit keys may be entered in a row. (default: 0)
UI_PROP_CP_APP_MODE	if set (1) activate CP app specific restrictions, (default: 0)
UI_PROP_SCROLL_COLOR	RGBA color value used for the scrollbar overlays, the value is an unsigned cast to an int (default: 0x00000060)
UI_PROP_INPUT_ERROR_BEEP	if set (1) beep when an input character cannot be inserted into an input field (input field full or invalid character) (default: 0) May be overwritten by server setting, see also UI_SERVER_INPUT_ERROR_BEEP
UI_PROP_ZOOM_MAX	maximum zoom in percent (multitouch enabled ADKGUI only, default:400, minimum:100)
UI_PROP_SCROLL_DISPLAY	time to show the scrollbar overlays in milliseconds. Scrollbar overlays are disabled by setting this to 0. When set to a negative value, overlays are displayed permanently
UI_PROP_JS_QUOTA_SIZE	If >0 filesystem quota in kilobytes for use by JavaScript, see also UI_PROP_JS_QUOTA_ROOT
UI_DEVICE_WIDTH	width of the display in pixels
UI_DEVICE_HEIGHT	height of the display in pixels
UI_DEVICE_COLOR_DEPTH	color depth in bits
UI_DEVICE_SUPPORTS_TOUCH	1 if the device supports touch, else 0
UI_DEVICE_SUPPORTS_BEEPER
UI_DEVICE_SUPPORTS_AUDIO	1 if the device supports audio output, else 0
UI_DEVICE_SUPPORTS_VIDEO	1 if the device supports video output, else 0
UI_DEVICE_SUPPORTS_SIGCAP	1 if the device supports signature capture, else 0
UI_DEVICE_SUPPORTS_COLOR_DISPLAY	1 if the device supports color display, else 0 (B/W display)
UI_DEVICE_HAS_CAP_TOUCH_KEYPAD	1 if the device has a capacitive touch keypad, else 0
UI_DEVICE_SUPPORTS_NAVIGATOR_MODE	1 if the device supports navigator mode
UI_DEVICE_KEY_COUNT	number of keypad keys

◆ UIPropertyString

enum UIPropertyString

String properties for configuring global GUI options

Enumerator
UI_PROP_DECIMAL_SEPARATOR	Decimal separator
UI_PROP_THOUSANDS_SEPARATOR	Thousands separator
UI_PROP_DEFAULT_FONT	Default font name
UI_PROP_RESOURCE_PATH	Resource path, default is www/<platform>
UI_PROP_FILE_PREFIX	prefix that is added in front of the URL in uiInvokeURL and to the template names, e.g. using "en/" would access the files in the subdirectory "en".
UI_PROP_KEYMAP	Keymap string of the format: "<key>=<char><char>...<char>\n<key>=<char>..."
UI_PROP_CSS	name of a CSS file
UI_PROP_RESOURCE_DEFAULT_PATH	Resource default path, default is www/default (or resource/default)
UI_PROP_GUI_EXTENSIONS	(removed)
UI_PROP_HTTP_HEADER_FIELDS	(removed)
UI_PROP_CP_APP_DIR	CP app directory, if set only dialogs from the app dir can be shown. It should point to the base app directory without platform, e.g. /home/sys14/www/<app-id> on V/OS
UI_PROP_LANGUAGE	ISO 639-1 language code (2 bytes, lowercase) or BCP 47 locale (5 bytes, 2 bytes lowercase language code, '-', 2 bytes uppercase country code, e.g. "en-US"). Setting the language loads catalog file <language>.ctlg. It is searched in the resource folder (e.g. www/VX820) and in the default resource folder (www/default) In case of a 5-byte locale if the file cannot be found, the country code is stripped and a catalog file just using the language code is searched. For example, using "de-AT", it would search for de-AT.ctlg in the resource and default resource folder and then it would search for de.ctlg in those two folders.
UI_PROP_JS_ROOT	Setting this path activates the JavaScript filesystem module. I/O is restricted to happen inside this path. Use "$APPDIR" to refer to this path from within JavaScript. Images and videos may also use "$APPDIR" to refer to files in this path.
UI_PROP_PRINT_ROOT	Setting this path activates JavaScript printing support. Receipts to be printed are looked up relative to this path. JavaScript printing may not be available for some platforms.
UI_PROP_PRINT_CSS	Name of the CSS file used for JavaScript printing. Default is "print.css"
UI_PROP_JS_QUOTA_ROOT	If not empty base directory for JavaScript quota calculation, default is "", see also UI_PROP_JS_QUOTA_SIZE
UI_DEVICE_MODEL	Terminal model name, e.g. "Razor" or "VX820"

◆ UIScrollPosition

enum UIScrollPosition

scroll position for uiScrollOption

Enumerator
UI_SCROLL_TOP	scroll element to top of menu
UI_SCROLL_BOTTOM	scroll element to bottom of menu

◆ UIServerProperty

enum UIServerProperty

Server properties

Enumerator
UI_SERVER_TOUCH_ACTION_BEEP	Configure action beep. "" use the application setting from UI_PROP_TOUCH_ACTION_BEEP, "on" ignore UI_PROP_TOUCH_ACTION_BEEP and play an action beep, "off" ignore UI_PROP_TOUCH_ACTION_BEEP and do not play an action beep
UI_SERVER_INPUT_ERROR_BEEP	Configure input error beep. "" use the application setting from UI_PROP_INPUT_ERROR_BEEP, "on" ignore UI_PROP_INPUT_ERROR_BEEP and play an input error beep, "off" ignore UI_PROP_INPUT_ERROR_BEEP and do not play an input error beep
UI_SERVER_KEYMAP	Configure global keymap that overrides application settings. The format is the same as for UI_PROP_KEYMAP. Set to "" to revert to application settings

Function Documentation

◆ gui_GetSvcVersion() [1/2]

const DllSpec char* vfigui::gui_GetSvcVersion

(

)

◆ gui_GetSvcVersion() [2/2]

const DllSpec char* vfigui::gui_GetSvcVersion

(

int

display

)

returns a zero-terminated string with version and build information of guiserver/guiprtserver in ADK version string format: <major>.<minor>.<patch>-<build>, e.g. "1.2.3-4"

Parameters

[in]

display

Returns: version string

◆ gui_GetVersion()

const DllSpec char* vfigui::gui_GetVersion

(

)

returns a zero-terminated string with version and build information of libvfiguiprt in ADK version string format: <major>.<minor>.<patch>-<build>, e.g. "1.2.3-4"

Returns: version string

◆ uiAddOption() [1/2]

DllSpec int vfigui::uiAddOption	(	int	display,
		int	region_id,
		const std::string &	name,
		const std::string &	value,
		const std::string &	text,
		const std::string &	style = `""`,
		const std::string &	action = `""`,
		int	position = `-1`
	)

Add an option to a <select> element. The option is added at the end of the list.

Parameters

[in]	display	display
[in]	region_id	region id
[in]	name	name of the <select> element
[in]	value	value of the element to be added
[in]	text	text to be displayed
[in]	style	CSS style, if empty use default style
[in]	action	optional action
[in]	position	position at which to insert the entry. Negative values refer to the position from the end, e.g. -1 adds the element to the end.

Returns: error code

Only a subset of the style settings is supported (setting style and color of text).

◆ uiAddOption() [2/2]

int vfigui::uiAddOption	(	int	region_id,
		const std::string &	name,
		const std::string &	value,
		const std::string &	text,
		const std::string &	style = `""`,
		const std::string &	action = `""`,
		int	position = `-1`
	)

inline

shortcut for uiAddOption(0,region_id,name,value,text,style,action,position);

◆ uiBeep() [1/2]

DllSpec int vfigui::uiBeep	(	int	display,
		UIBeep	beep
	)

play beep

Parameters

[in]	display	display
[in]	beep	kind of beep to play

Returns: error code

◆ uiBeep() [2/2]

int vfigui::uiBeep

(

UIBeep

beep

)

inline

shortcut for uiBeep(0,beep);

◆ uiCanvas() [1/2]

DllSpec int vfigui::uiCanvas	(	int	display,
		int	region_id,
		uiEventCallback	cb,
		void *	data = `0`
	)

install a canvas for drawing in the given region

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	cb	event callback function, it is invoked for touch and keyboard events.
[in]	data	data pointer that is passed on to the callback function

Returns: error code (see UIError) or transaction ID.

◆ uiCanvas() [2/2]

int vfigui::uiCanvas	(	int	region_id,
		uiEventCallback	cb,
		void *	data = `0`
	)

inline

shortcut for uiCanvas(0,region_id,cb,data);

◆ uiCatalogGetDelayedRelease()

DllSpec unsigned vfigui::uiCatalogGetDelayedRelease

(

)

Get the maximum number of unused catalogs that are kept in memory.

Returns: number of catalogs

Catalog storage is shared with the printer module, i.e. this setting may be changed by calls to prtCatalogSetDelayedRelease()

◆ uiCatalogSetDelayedRelease()

DllSpec void vfigui::uiCatalogSetDelayedRelease

(

unsigned

num

)

Set the maximum number of catalogs that are kept in memory although being unused. This improves load time when a catalog is used again, since when still in memory it does not need to be read from disk (default: 0)

Parameters

[in]

num

number of catalogs

Catalog storage is shared with the printer module, i.e. this setting may be changed by calls to prtCatalogSetDelayedRelease()

◆ uiClear() [1/2]

DllSpec int vfigui::uiClear	(	int	display,
		int	region_id
	)

Remove a dialog or sub-regions from a region. If the dialog is still active, it is cancelled. After the the dialog has been removed, the region is empty, i.e. it displays nothing and does not clear the region.

Parameters

[in]	display	display
[in]	region_id	region id

Returns: error code (see UIError)

◆ uiClear() [2/2]

int vfigui::uiClear

(

int

region_id

)

inline

shortcut for uiClear(0,region_id);

◆ uiConfigLEDs() [1/4]

DllSpec int vfigui::uiConfigLEDs

(

const char *

filename

)

shortcut for accessing display 0

◆ uiConfigLEDs() [2/4]

DllSpec int vfigui::uiConfigLEDs	(	int	display,
		const char *	filename
	)

set LED configuration from PNG file. The PNG file has to contain 5 LEDs next to each other. The first LED shows the off state, the remaining 4 LEDs show the on state of the 4 LEDs on screen. The alpha channel is supported to display non-rectangular LEDs. If present the LED area is cleared with the background color and the LEDs are drawn in off-state.

Parameters

[in]	display	display
[in]	filename	file name of the PNG image

Returns: error code (see UIError)

◆ uiConfigLEDs() [3/4]

DllSpec int vfigui::uiConfigLEDs	(	int	display,
		UILEDShape	shape,
		int	width,
		int	height,
		unsigned	off_rgba,
		unsigned	on0_rgba,
		unsigned	on1_rgba,
		unsigned	on2_rgba,
		unsigned	on3_rgba
	)

set LED configuration. If present the LED area is cleared with the background color and the LEDs are drawn in off-state.

Parameters

[in]	display	display
[in]	shape	LED shape
[in]	width	width of a single LED
[in]	height	height of a single LED
[in]	off_rgba	color of the LED when switched off
[in]	on0_rgba	color of LED 0 when switched on
[in]	on1_rgba	color of LED 1 when switched on
[in]	on2_rgba	color of LED 2 when switched on
[in]	on3_rgba	color of LED 3 when switched on

Returns: error code (see UIError)

◆ uiConfigLEDs() [4/4]

DllSpec int vfigui::uiConfigLEDs	(	UILEDShape	shape,
		int	width,
		int	height,
		unsigned	off_rgba,
		unsigned	on0_rgba,
		unsigned	on1_rgba,
		unsigned	on2_rgba,
		unsigned	on3_rgba
	)

shortcut for accessing display 0

◆ uiConfirm() [1/3]

int vfigui::uiConfirm	(	const std::string &	templateName,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiConfirm() [2/3]

DllSpec int vfigui::uiConfirm	(	int	display,
		int	region_id,
		const std::string &	templateName,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

Display an HTML confirmation dialog on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) or return value specified in the template

display and region_id are optional, see Parameter Overloading

Examples: demo-sysinfo.cpp, mac_demo1.cpp, mac_demo2.cpp, and pm-demo.cpp.

◆ uiConfirm() [3/3]

DllSpec int vfigui::uiConfirm	(	int	region_id,
		const std::string &	templateName,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

◆ uiConfirmAsync() [1/3]

int vfigui::uiConfirmAsync	(	const std::string &	templateName,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

◆ uiConfirmAsync() [2/3]

DllSpec int vfigui::uiConfirmAsync	(	int	display,
		int	region_id,
		const std::string &	templateName,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously display an HTML confirmation dialog on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: transaction ID or error code (see UIError)

display and region_id are optional, see Parameter Overloading

use uiConfirmWait() to wait for the dialog to finish or use uiInvokeCancel() to cancel the dialog

◆ uiConfirmAsync() [3/3]

DllSpec int vfigui::uiConfirmAsync	(	int	region_id,
		const std::string &	templateName,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

◆ uiConfirmWait()

DllSpec int vfigui::uiConfirmWait	(	int	txn_id,
		int	timeout_msec = `-1`
	)

Wait for the confirm dialog to finish

Parameters

[in]	txn_id	transaction id as returned by uiConfirmAsync()
[in]	timeout_msec	timeout in milliseconds. In case of a negative timeout wait forever.

Returns: error code (see UIError) or return value specified in the HTML fragment. In case of a timeout UI_ERR_WAIT_TIMEOUT is returned and uiConfirmWait() may be called again.

◆ uiCurrentRegionPath() [1/2]

DllSpec std::string vfigui::uiCurrentRegionPath

(

)

shortcut for uiCurrentRegionPath(0);

◆ uiCurrentRegionPath() [2/2]

DllSpec std::string vfigui::uiCurrentRegionPath

(

int

display

)

Return the current region path that was constructed using uiEnterRegion(). The region path contains the regions passed on to successive calls of uiEnterRegion() separated by '/', e.g calling the sequence uiEnterRegion(1); uiEnterRegion(2); uiEnterRegion(3); the region path would be "1/2/3". If no region path is used, the empty string is returned.

Parameters

[in]

display

Returns: current region path

display is optional, see Parameter Overloading

◆ uiDataURLToFile()

DllSpec bool vfigui::uiDataURLToFile	(	const char *	filename,
		const std::string &	in
	)

extract data from data URL to file

Parameters

[in]	filename	file name
[in]	in	data URL

Returns: true in case of success, else false

◆ uiDataURLToString()

DllSpec bool vfigui::uiDataURLToString	(	std::string &	out,
		const std::string &	in
	)

extract data from data URL to string

Parameters

[out]	out	extracted data
[in]	in	data URL

Returns: true in case of success, else false

◆ uiDataURLType()

const DllSpec char* vfigui::uiDataURLType

(

const std::string &

in

)

check if a string contains a data URL and return the type as string (e.g. "png" for a PNG image)

Parameters

[in]

s

string containing data

Returns: file type as string or NULL if s does not contain a known data URL type.

◆ uiDisablePINOK()

DllSpec int vfigui::uiDisablePINOK ( int display = 0 )

disable the OK button during PIN entry, e.g. since the amount has not yet been displayed. Use uiEnablePINOK() to re-enable the OK button. The dialog must already be displayed to disable the OK button, i.e. use it after uiInvokeAsync(). When invoked when no PIN entry is active UI_ERR_PARAMETER is returned.

Parameters

[in]

display

Returns: error code.

◆ uiDisconnect()

DllSpec void vfigui::uiDisconnect

(

int

display

)

disconnect from GUI server. The next call to another GUI function will implicitely reconnect to the server

Parameters

[in]

display

◆ uiDisplay() [1/6]

int vfigui::uiDisplay	(	const std::string &	templateName,
		const std::string &	text
	)

inline

◆ uiDisplay() [2/6]

int vfigui::uiDisplay

(

const std::string &

text

)

inline

◆ uiDisplay() [3/6]

DllSpec int vfigui::uiDisplay	(	int	display,
		int	region_id,
		const std::string &	templateName,
		const std::string &	text
	)

Display an HTML document on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).

Returns: error code (see UIError)

display and region_id are optional, see Parameter Overloading

◆ uiDisplay() [4/6]

DllSpec int vfigui::uiDisplay	(	int	display,
		int	region_id,
		const std::string &	text
	)

Display an HTML document on screen

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).

Returns: error code (see UIError)

display and region_id are optional, see Parameter Overloading

◆ uiDisplay() [5/6]

DllSpec int vfigui::uiDisplay	(	int	region_id,
		const std::string &	templateName,
		const std::string &	text
	)

◆ uiDisplay() [6/6]

DllSpec int vfigui::uiDisplay	(	int	region_id,
		const std::string &	text
	)

◆ uiDisplayAsync() [1/6]

int vfigui::uiDisplayAsync	(	const std::string &	templateName,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

◆ uiDisplayAsync() [2/6]

int vfigui::uiDisplayAsync	(	const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

◆ uiDisplayAsync() [3/6]

DllSpec int vfigui::uiDisplayAsync	(	int	display,
		int	region_id,
		const std::string &	templateName,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously display an HTML document on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: transaction ID or error code (see UIError)

display and region_id are optional, see Parameter Overloading

use uiDisplayWait() to wait for the dialog to finish or use uiInvokeCancl() to cancel the dialog

◆ uiDisplayAsync() [4/6]

DllSpec int vfigui::uiDisplayAsync	(	int	display,
		int	region_id,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously display an HTML document on screen

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: transaction ID or error code (see UIError)

display and region_id are optional, see Parameter Overloading

use uiDisplayWait() to wait for the dialog to finish or use uiInvokeCancel() to cancel the dialog

Examples: demo-sysinfo.cpp.

◆ uiDisplayAsync() [5/6]

DllSpec int vfigui::uiDisplayAsync	(	int	region_id,
		const std::string &	templateName,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

◆ uiDisplayAsync() [6/6]

DllSpec int vfigui::uiDisplayAsync	(	int	region_id,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

◆ uiDisplayCount()

DllSpec int vfigui::uiDisplayCount

(

)

determine the number of displays

Returns: number of displays

◆ uiDisplayWait()

DllSpec int vfigui::uiDisplayWait	(	int	txn_id,
		int	timeout_msec = `-1`
	)

Wait for the result of the display

Parameters

[in]	txn_id	transaction id as returned by uiDisplayAsync()
[in]	timeout_msec	timeout in milliseconds. In case of a negative timeout wait forever.

Returns: error code (see UIError) or return value specified in the HTML fragment. In case of a timeout UI_ERR_WAIT_TIMEOUT is returned and uiDisplayWait() may be called again.

◆ uiDraw() [1/2]

DllSpec int vfigui::uiDraw	(	int	display,
		int	region_id,
		const UIDrawing &	drawing
	)

draw to canvas

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	drawing	set of drawing primitives

Returns: error code (see UIError)

◆ uiDraw() [2/2]

int vfigui::uiDraw	(	int	region_id,
		const UIDrawing &	drawing
	)

inline

shortcut for uiDraw(0,region_id,drawing);

◆ uiDrawAsync() [1/2]

DllSpec int vfigui::uiDrawAsync	(	int	display,
		int	region_id,
		const UIDrawing &	drawing,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously draw to canvas

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	drawing	set of drawing primitives

Returns: error code (see UIError)

◆ uiDrawAsync() [2/2]

int vfigui::uiDrawAsync	(	int	region_id,
		const UIDrawing &	drawing,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiDraw(0,region_id,drawing);

◆ uiEnablePINOK()

DllSpec int vfigui::uiEnablePINOK ( int display = 0 )

enable the OK button when it has been disabled using uiDisablePINOK(). Use uiEnablePINOK() to re-enable the OK button

Parameters

[in]

display

Returns: error code.

Invocation of this function is only required if uiDisablePINOK has been used.

◆ uiEnterRegion() [1/2]

DllSpec int vfigui::uiEnterRegion	(	int	display,
		int	region_id
	)

Enter region region_id making it the parent region for all successive uiLayout() and uiGetLayout() commands. This is used to create a tree of regions.

Parameters

[in]	display	display
[in]	region_id	region ID

Returns: error code (see UIError)

display is optional, see Parameter Overloading

a new default region is created if required.

◆ uiEnterRegion() [2/2]

DllSpec int vfigui::uiEnterRegion

(

int

region_id

)

shortcut for uiEnterRegion(0,region_id);

◆ uiErrorList()

const DllSpec std::vector<UIErrorEntry>& vfigui::uiErrorList

(

)

obtain list of non-fatal errors that happened while displaying a dialog. In case of synchronous dialogs the error list is reset as part of displaying the dialog. In case of asynchronous dialogs this list is reset when displaying the dialog using one of the ui*Async functions and when calling uiInvokeWait (or one of the other ui*Wait functions)

Returns: reference to the error list of the last dialog shown in this thread.

◆ uiGetBacklightConfig()

DllSpec int vfigui::uiGetBacklightConfig	(	int	display,
		std::vector< UIBacklight > &	levels
	)

read backlight parameters

Parameters

[in]	display	display
[out]	levels	backlight brightness levels and timeouts

Returns: error code (see UIError)

◆ uiGetBacklightLevel()

DllSpec int vfigui::uiGetBacklightLevel	(	int	display,
		int &	level
	)

get backlight level

Parameters

[in]	display	display
[out]	level	current level in the range 0..levels.size()-1

Returns: error code (see UIError)

◆ uiGetCatalog() [1/2]

DllSpec std::string vfigui::uiGetCatalog

(

)

shortcut for uiGetCatalog(0);

◆ uiGetCatalog() [2/2]

DllSpec std::string vfigui::uiGetCatalog

(

int

display

)

Parameters

[in]

display

Returns: file name of the current catalog file or empty string in case none has been loaded

display is optional, see Parameter Overloading

◆ uiGetConnectAttempts()

DllSpec int vfigui::uiGetConnectAttempts

(

)

get the number of attempts to contact the server

Returns: Number of attempts

◆ uiGetDisconnectCallback()

DllSpec uiDisconnectCallback vfigui::uiGetDisconnectCallback

(

)

get callback that gets invoked if the contact to the server is lost

Returns: callback function as set with uiSetDisconnectCallback();

◆ uiGetHtml() [1/2]

DllSpec int vfigui::uiGetHtml	(	const std::map< std::string, std::string > &	value,
		const std::string &	text,
		std::string &	html
	)

shortcut for uiGetHtml(0,value,text,html);

◆ uiGetHtml() [2/2]

DllSpec int vfigui::uiGetHtml	(	int	display,
		const std::map< std::string, std::string > &	value,
		const std::string &	text,
		std::string &	html
	)

preprocess HTML code and return the resulting string

Parameters

[in]	display	display whose settings should be used (e.g. text catalog, css file, etc.)
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[out]	html	resulting HTML code

Returns: error code (see UIError)

display is optional, see Parameter Overloading

◆ uiGetHtmlURL() [1/2]

DllSpec int vfigui::uiGetHtmlURL	(	const std::map< std::string, std::string > &	value,
		const std::string &	url,
		std::string &	html
	)

shortcut for uiGetHtmlURL(0,value,url,html);

◆ uiGetHtmlURL() [2/2]

DllSpec int vfigui::uiGetHtmlURL	(	int	display,
		const std::map< std::string, std::string > &	value,
		const std::string &	url,
		std::string &	html
	)

preprocess HTML code and return the resulting string

Parameters

[in]	display	display whose settings should be used (e.g. text catalog, css file, etc.)
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX) unless an absolute path was provided.
[out]	html	resulting HTML code

Returns: error code (see UIError)

display is optional, see Parameter Overloading

◆ uiGetIdleTime()

DllSpec int vfigui::uiGetIdleTime ( int display = 0 )

Determine the amount of time passed since the last user interaction.

Returns: Idle time in milliseconds (>=0) or error code (<0).

◆ uiGetKeepalive()

DllSpec void vfigui::uiGetKeepalive	(	int &	count,
		int &	interval
	)

get keepalive settings

Parameters

[out]	count	number of keepalive probes to send before dropping the link
[out]	interval	time in seconds between sending keepalive probes

◆ uiGetKeypadType()

DllSpec std::string vfigui::uiGetKeypadType

(

int

display

)

determine the keypad type

Returns: keypad type

◆ uiGetLayout() [1/2]

DllSpec int vfigui::uiGetLayout	(	int	display,
		std::vector< UIRegion > &	region
	)

read the current layout setting

Parameters

[in]	display	display
[out]	region	returned region layout

Returns: error code (see UIError)

display is optional, see Parameter Overloading

◆ uiGetLayout() [2/2]

DllSpec int vfigui::uiGetLayout

(

std::vector< UIRegion > &

region

)

shortcut for uiGetLayout(0,region);

◆ uiGetLocalProperties()

DllSpec bool vfigui::uiGetLocalProperties

(

)

Returns: true if thread local properties are used, else return false

◆ uiGetLogMask()

DllSpec unsigned vfigui::uiGetLogMask

(

void

)

Get log mask

Returns: current log mask

◆ uiGetPropertyInt() [1/2]

DllSpec int vfigui::uiGetPropertyInt	(	enum UIPropertyInt	property,
		int *	value
	)

shortcut for uiGetPropertyInt(0,property,value);

◆ uiGetPropertyInt() [2/2]

DllSpec int vfigui::uiGetPropertyInt	(	int	display,
		enum UIPropertyInt	property,
		int *	value
	)

get int property

Parameters

[in]	display	display
[in]	property	property to be set
[out]	value	current value

Returns: error code (see UIError)

display is optional, see Parameter Overloading

Examples: demo-sysinfo.cpp.

◆ uiGetPropertyString() [1/4]

DllSpec int vfigui::uiGetPropertyString	(	enum UIPropertyString	property,
		char *	value,
		int	len
	)

shortcut for uiGetPropertyString(0,property,value,len);

◆ uiGetPropertyString() [2/4]

DllSpec int vfigui::uiGetPropertyString	(	enum UIPropertyString	property,
		std::string &	value
	)

shortcut for uiGetPropertyString(0,property,value);

◆ uiGetPropertyString() [3/4]

DllSpec int vfigui::uiGetPropertyString	(	int	display,
		enum UIPropertyString	property,
		char *	value,
		int	len
	)

get string property

Parameters

[in]	display	display
[in]	property	property to be set
[out]	value	current value
[in]	len	size ouf output buffer value in bytes

Returns: error code (see UIError)

display is optional, see Parameter Overloading

◆ uiGetPropertyString() [4/4]

DllSpec int vfigui::uiGetPropertyString	(	int	display,
		enum UIPropertyString	property,
		std::string &	value
	)

get string property

Parameters

[in]	display	display
[in]	property	property to be set
[out]	value	current value

Returns: error code (see UIError)

display is optional, see Parameter Overloading

◆ uiGetRegionSize() [1/2]

DllSpec int vfigui::uiGetRegionSize	(	int	display,
		int	region_id,
		int &	width,
		int &	height
	)

Determine size of a region in pixels

Parameters

[in]	display	display;
[in]	region_id	region ID;
[out]	width	width in pixels
[out]	height	height in pixels

Returns: error code

◆ uiGetRegionSize() [2/2]

int vfigui::uiGetRegionSize	(	int	region_id,
		int &	width,
		int &	height
	)

inline

shortcut for uiGetRegionSize(0,region_id,width,height);

◆ uiGetServerProperty()

DllSpec int vfigui::uiGetServerProperty	(	int	display,
		enum UIServerProperty	property,
		std::string &	value
	)

get global server property

Parameters

[in]	display	display
[in]	property	property to be set
[out]	value	current value

Returns: error code (see UIError)

◆ uiGetTerminalResourceDir() [1/2]

DllSpec std::string vfigui::uiGetTerminalResourceDir

(

const std::string &

www_path

)

shortcut for uiGetTerminalResourceDir(0,www_path);

◆ uiGetTerminalResourceDir() [2/2]

DllSpec std::string vfigui::uiGetTerminalResourceDir	(	int	display,
		const std::string &	www_path
	)

determine the HW dependent terminal specific subdirectory inside the 'www' directory

Parameters

[in]	display	display
[in]	www_path	path of the www directory containing the resource files

Returns: path to the terminal specific subdirectory

display is optional, see Parameter Overloading

The environment variable GUIPRT_APPNAME is not considered.

◆ uiGetText() [1/4]

DllSpec std::string vfigui::uiGetText	(	const std::string &	filename,
		const std::string &	name,
		const std::string &	deflt
	)

shortcut for uiGetText(0,filename,name,deflt);

◆ uiGetText() [2/4]

DllSpec std::string vfigui::uiGetText	(	const std::string &	name,
		const std::string &	deflt = `""`
	)

shortcut for uiGetText(0,name,deflt);

◆ uiGetText() [3/4]

DllSpec std::string vfigui::uiGetText	(	int	display,
		const std::string &	filename,
		const std::string &	name,
		const std::string &	deflt
	)

lookup a text from a catalog file referred by filename. In difference to uiGetText() functions above, the catalog need not to be loaded with uiSetCatalog(), thus, is not applied to UI property context.

Applications must call uiSetCatalog() before HTML documents can use XML processing instructions <?text name?>. Parameter display is ignored, if filename contains an absolute file path. In case of a relative file path, the function looks up the file relative to UI_PROP_RESOURCE_PATH and UI_PROP_RESOURCE_DEFAULT_PATH, therefore, parameter display is required to get the related UI resource paths from the UI property context.

This function might delete another unused catalog, which was kept in internal catalog cache. For more details, see uiCatalogSetDelayedRelease().

Parameters

[in]	filename	of the catalog
[in]	display	display
[in]	name	of key used to lookup the text in calalog
[in]	deflt	text that is returned, if text is not found in calalog

Returns: text from catalog for success, else value in parameter default

display is optional, see Parameter Overloading

◆ uiGetText() [4/4]

DllSpec std::string vfigui::uiGetText	(	int	display,
		const std::string &	name,
		const std::string &	deflt = `""`
	)

lookup a text from current loaded catalog by key name. If text is not found in catalog or no catalog is loaded the function returns value in in parameter default.

Parameters

[in]	display	display
[in]	name	of key used to lookup the text in calalog
[in]	deflt	text that is returned, if text is not found in calalog

Returns: text from catalog for success, else value in parameter default

display is optional, see Parameter Overloading

◆ uiGetURLPath() [1/2]

DllSpec std::string vfigui::uiGetURLPath

(

const std::string &

url

)

shortcut for uiGetURLPath(0,url);

◆ uiGetURLPath() [2/2]

DllSpec std::string vfigui::uiGetURLPath	(	int	display,
		const std::string &	url
	)

determine the full path of an url taking into account all settings and rules for looking up files

Parameters

[in]	display	display whose settings should be used (e.g. text catalog, css file, etc.)
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX) unless an absolute path was provided.

Returns: full path of the HTML file or empty string if not found.

display is optional, see Parameter Overloading

◆ uiHideLEDArea() [1/2]

DllSpec int vfigui::uiHideLEDArea

(

)

shortcut for accessing display 0

◆ uiHideLEDArea() [2/2]

DllSpec int vfigui::uiHideLEDArea

(

int

display

)

Decrement the LED area reference counter and hide the LED area if the counter reaches 0.

Parameters

[in]

display

Returns: error code (see UIError)

◆ uiHTML2PNG()

DllSpec int vfigui::uiHTML2PNG	(	const char *	filename,
		int	width,
		int	height,
		const std::map< std::string, std::string > &	value,
		const std::string &	text
	)

convert a dialog to a PNG image

Parameters

[in]	filename	file name of the PNG file
[in]	width	width of the image
[in]	height	height of the image
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	text	HTML code

Returns: error code (see UIError)

◆ uiHTML2PNGData()

DllSpec int vfigui::uiHTML2PNGData	(	std::vector< unsigned char > &	data,
		int	width,
		int	height,
		const std::map< std::string, std::string > &	value,
		const std::string &	text
	)

convert a dialog to a PNG image

Parameters

[out]	data	data of PNG file
[in]	width	width of the image
[in]	height	height of the image
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	text	HTML code

Returns: error code (see UIError)

◆ uiInput() [1/3]

int vfigui::uiInput	(	const std::string &	templateName,
		std::vector< std::string > &	value,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInput() [2/3]

DllSpec int vfigui::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`
	)

Display an HTML input dialog on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in,out]	value	initial value and returned value of the input fields. The first value refers to the first input field, the second to the second, etc.
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>). The input fields have to be specified as HTML input fields (e.g. <input type='text' ...>). The following input types are supported: text: text input password: password input checkbox: checkbox number: numeric input (HTML extension) mask: masked input (HTML extension) pin: PIN input The following attributes are supported: allowed_chars: list of allowed characters mask: input mask (HTML extension): '' is used as place holder for filling in characters maxlengh:* maximum input length name: name of the input field precision: number of decimal places size: size of the input field in characters for display on screen
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) or return value specified in the template

display and region_id are optional, see Parameter Overloading

PIN input cannot be combined with other input types since the keyboard is exclusively locked by the PIN entry function. In case of PIN entry the value returned in value is the number of digits entered or "error" in case of an error, "cancel" if the user pressed CANCEL, "clear" if the user pressed CLEAR, "bypass" in case of PIN bypass and "timeout" in case of timeout.

Radio buttons will not behave as expected since these use more than one input element to represent a single input value.

◆ uiInput() [3/3]

DllSpec int vfigui::uiInput	(	int	region_id,
		const std::string &	templateName,
		std::vector< std::string > &	value,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

◆ uiInputAsync() [1/3]

int vfigui::uiInputAsync	(	const std::string &	templateName,
		const std::vector< std::string > &	value,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

◆ uiInputAsync() [2/3]

DllSpec int vfigui::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`
	)

Asynchronously display an HTML input dialog on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	value	initial value of the input fields. The first value refers to the first input field, the second to the second, etc.
[in]	text	string containing an HTML fragment
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: transaction ID or error code (see UIError)

display and region_id are optional, see Parameter Overloading

◆ uiInputAsync() [3/3]

DllSpec int vfigui::uiInputAsync	(	int	region_id,
		const std::string &	templateName,
		const std::vector< std::string > &	value,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

◆ uiInputPINCheck() [1/3]

int vfigui::uiInputPINCheck	(	const std::string &	templateName,
		const std::string &	referencePIN,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInputPINCheck() [2/3]

DllSpec int vfigui::uiInputPINCheck	(	int	display,
		int	region_id,
		const std::string &	templateName,
		const std::string &	referencePIN,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

Display a PIN check dialog: The entered PIN is checkec against a known PIN

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	referencePIN	reference PIN
[in]	text	string containing an HTML fragment
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) (UI_ERR_WRON_PIN in case of a wrong PIN, UI_ERR_OK in case the PIN was OK)

display and region_id are optional, see Parameter Overloading

◆ uiInputPINCheck() [3/3]

DllSpec int vfigui::uiInputPINCheck	(	int	region_id,
		const std::string &	templateName,
		const std::string &	referencePIN,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

◆ uiInputPINCheckAsync() [1/3]

int vfigui::uiInputPINCheckAsync	(	const std::string &	templateName,
		const std::string &	referencePIN,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

◆ uiInputPINCheckAsync() [2/3]

DllSpec int vfigui::uiInputPINCheckAsync	(	int	display,
		int	region_id,
		const std::string &	templateName,
		const std::string &	referencePIN,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously display a PIN check dialog: The entered PIN is checkec against a known PIN

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	text	string containing an HTML fragment
[in]	referencePIN	reference PIN
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: transaction ID or error code (see UIError)

display and region_id are optional, see Parameter Overloading

use uiInputPINCheckWait() to wait for the dialog to finish or use uiInvokeCancel() to cancel the dialog

◆ uiInputPINCheckAsync() [3/3]

DllSpec int vfigui::uiInputPINCheckAsync	(	int	region_id,
		const std::string &	templateName,
		const std::string &	referencePIN,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

◆ uiInputPINCheckWait()

DllSpec int vfigui::uiInputPINCheckWait	(	int	txn_id,
		int	timeout_msec = `-1`
	)

Wait for the PIN check dialog to finish

Parameters

[in]	txn_id	transaction id as returned by uiInputPINCheckAsync()
[in]	timeout_msec	timeout in milliseconds. In case of a negative timeout wait forever.

Returns: error code (see UIError) or return value specified in the HTML fragment. In case of a timeout UI_ERR_WAIT_TIMEOUT is returned and uiInputPINCheckWait() may be called again.

update events are currently not supported for uiInputPINCheckWait().

◆ uiInputWait()

DllSpec int vfigui::uiInputWait	(	int	txn_id,
		std::vector< std::string > &	value,
		int	timeout_msec = `-1`
	)

Wait for the input dialog to finish

Parameters

[in]	txn_id	transaction id as returned by uiInputAsync()
[in]	value	returned value of the input fields. The first value refers to the first input field, the second to the second, etc.
[in]	timeout_msec	timeout in milliseconds. In case of a negative timeout wait forever.

Returns: error code (see UIError) or return value specified in the HTML fragment. In case of a timeout UI_ERR_WAIT_TIMEOUT is returned and uiInputWait() may be called again.

◆ uiInvoke() [1/6]

int vfigui::uiInvoke	(	const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvoke() [2/6]

int vfigui::uiInvoke	(	int	display,
		int	region_id,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvoke() [3/6]

DllSpec int vfigui::uiInvoke	(	int	display,
		int	region_id,
		stringmap &	value,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

Invoke an HTML dialog.

Parameters

[in]	display	display
[in]	region_id	region ID
[in,out]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values.
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) or return value specified in the HTML fragment

display, region_id and value are optional, see Parameter Overloading

Examples: demo-sysinfo.cpp.

◆ uiInvoke() [4/6]

int vfigui::uiInvoke	(	int	region_id,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvoke() [5/6]

DllSpec int vfigui::uiInvoke	(	int	region_id,
		stringmap &	value,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

◆ uiInvoke() [6/6]

int vfigui::uiInvoke	(	stringmap &	value,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvokeAsync() [1/6]

int vfigui::uiInvokeAsync	(	const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeAsync(0,UI_REGION_DEFAULT, dummy_value, text,cb,data);

◆ uiInvokeAsync() [2/6]

int vfigui::uiInvokeAsync	(	const stringmap &	value,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeAsync(0,UI_REGION_DEFAULT, value, text,cb,data);

◆ uiInvokeAsync() [3/6]

int vfigui::uiInvokeAsync	(	int	display,
		int	region_id,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeAsync(display, region_id,dummy_value,text,cb,data);

◆ uiInvokeAsync() [4/6]

DllSpec int vfigui::uiInvokeAsync	(	int	display,
		int	region_id,
		const stringmap &	value,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously invoke an HTML dialog.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: error code (see UIError) or transaction ID. The transaction ID is required for obtaining the dialog result using uiInvokeWait()

display, region_id and value are optional, see Parameter Overloading

If no callback was provided, uiInvokeWait() must be called to obtain the result and release allocated memory or uiInvokeCancel() needs to be called to cancel the dialog. If a callback was provided uiInvokeWait() cannot be used and will return UI_ERR_INVALID.

◆ uiInvokeAsync() [5/6]

int vfigui::uiInvokeAsync	(	int	region_id,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeAsync(0,region_id,dummy_value,text,cb,data);

◆ uiInvokeAsync() [6/6]

DllSpec int vfigui::uiInvokeAsync	(	int	region_id,
		const stringmap &	value,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

shortcut for uiInvokeAsync(0,region_id,value,text,cb,data);

◆ uiInvokeCancel() [1/2]

int vfigui::uiInvokeCancel

(

int

txn_id

)

inline

the same as uiInvokeCancel(int txn_id, std::map<std::string,std::string> &value) but discards returned input values

◆ uiInvokeCancel() [2/2]

DllSpec int vfigui::uiInvokeCancel	(	int	txn_id,
		std::map< std::string, std::string > &	value
	)

Cancel dialog. This may be called whenever uiInvokeWait() can be called and cancels the dialog.

Parameters

[in]	txn_id	Request ID of the dialog
[out]	value	entered values are added to this map

Returns: error code (see UIError). For asynchronous calls with callback function the return value cannot be obtained since it is delivered to the callback function. In this case always UI_ERR_OK is returned. Normally the error code will be UI_ERR_CANCELLED, however, the returncode reflects the true result of the dialog, i.e. if the user terminated the dialog just before cancelling it, the returncode will contain the result of the dialog.

◆ uiInvokeCancelAsync()

DllSpec int vfigui::uiInvokeCancelAsync

(

int

txn_id

)

Cancel dialog without reading the result, i.e. uiInvokeWait() will have to be called afterwards.

Parameters

[in]

txn_id

Request ID of the dialog

Returns: error code

◆ uiInvokeTemplate() [1/6]

int vfigui::uiInvokeTemplate	(	const std::string &	template_name,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvokeTemplate() [2/6]

int vfigui::uiInvokeTemplate	(	int	display,
		int	region_id,
		const std::string &	template_name,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvokeTemplate() [3/6]

DllSpec int vfigui::uiInvokeTemplate	(	int	display,
		int	region_id,
		stringmap &	value,
		const std::string &	template_name,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

Invoke an HTML dialog with template: The provided text is inserted into the template file and then displayed.

Parameters

[in]	display	display
[in]	region_id	region ID
[in,out]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values.
[in]	template_name	file name of template into which text is inserted
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) or return value specified in the HTML fragment

display, region_id and value are optional, see Parameter Overloading

◆ uiInvokeTemplate() [4/6]

int vfigui::uiInvokeTemplate	(	int	region_id,
		const std::string &	template_name,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvokeTemplate() [5/6]

DllSpec int vfigui::uiInvokeTemplate	(	int	region_id,
		stringmap &	value,
		const std::string &	template_name,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

◆ uiInvokeTemplate() [6/6]

int vfigui::uiInvokeTemplate	(	stringmap &	value,
		const std::string &	template_name,
		const std::string &	text,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiInvokeTemplateAsync() [1/6]

int vfigui::uiInvokeTemplateAsync	(	const std::string &	template_name,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeTemplateAsync(0,UI_REGION_DEFAULT, dummy_value, template_name, text, cb,data);

◆ uiInvokeTemplateAsync() [2/6]

int vfigui::uiInvokeTemplateAsync	(	const stringmap &	value,
		const std::string &	template_name,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeTemplateAsync(0, UI_REGION_DEFAULT, value, template_name, text, cb,data);

◆ uiInvokeTemplateAsync() [3/6]

int vfigui::uiInvokeTemplateAsync	(	int	display,
		int	region_id,
		const std::string &	template_name,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeTemplateAsync(display,region_id,dummy_value,template_name,text, cb,data);

◆ uiInvokeTemplateAsync() [4/6]

DllSpec int vfigui::uiInvokeTemplateAsync	(	int	display,
		int	region_id,
		const stringmap &	value,
		const std::string &	template_name,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously invoke an HTML dialog. The provided text is inserted into the template file and then the dialog is displayed

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	template_name	template file
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: error code (see UIError) or transaction ID. The transaction ID is required for obtaining the dialog result using uiInvokeWait()

display, region_id and value are optional, see Parameter Overloading

If no callback was provided, uiInvokeWait() must be called to obtain the result and release allocated memory or uiInvokeCancel() needs to be called to cancel the dialog. If a callback was provided uiInvokeWait() cannot be used and will return UI_ERR_INVALID.

◆ uiInvokeTemplateAsync() [5/6]

int vfigui::uiInvokeTemplateAsync	(	int	region_id,
		const std::string &	template_name,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeTemplateAsync(0,region_id,dummy_value,template_name,text, cb,data);

◆ uiInvokeTemplateAsync() [6/6]

DllSpec int vfigui::uiInvokeTemplateAsync	(	int	region_id,
		const stringmap &	value,
		const std::string &	template_name,
		const std::string &	text,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

shortcut for uiInvokeTemplateAsync(0,region_id,value,template_name,text,cb,data);

◆ uiInvokeURL() [1/12]

int vfigui::uiInvokeURL	(	const char *	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for uiInvokeURL(0,UI_REGION_DEFAULT,dummy_value,url,cb,cbdata);

◆ uiInvokeURL() [2/12]

int vfigui::uiInvokeURL	(	const std::string &	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for uiInvokeURL(0,UI_REGION_DEFAULT, dummy_value,url,cb,cbdata);

◆ uiInvokeURL() [3/12]

int vfigui::uiInvokeURL	(	int	display,
		int	region_id,
		const char *	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for uiInvokeURL(display, region_id, dummy_value,url,cb,cbdata);

◆ uiInvokeURL() [4/12]

int vfigui::uiInvokeURL	(	int	display,
		int	region_id,
		const std::string &	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for uiInvokeURL(display,region_id,dummy_value,url,cb,cbdata);

◆ uiInvokeURL() [5/12]

DllSpec int vfigui::uiInvokeURL	(	int	display,
		int	region_id,
		stringmap &	value,
		const char *	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

display a dialog

Parameters

[in]	display	display
[in]	region_id	region ID
[in,out]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values.
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX)
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) or return value specified in the HTML fragment

display, region_id and value are optional, see Parameter Overloading

Examples: demo-sysinfo.cpp, and mac_demo1.cpp.

◆ uiInvokeURL() [6/12]

DllSpec int vfigui::uiInvokeURL	(	int	display,
		int	region_id,
		stringmap &	value,
		const std::string &	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

display a dialog

Parameters

[in]	display	display
[in]	region_id	region ID
[in,out]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values.
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX)
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) or return value specified in the HTML fragment

display, region_id and value are optional, see Parameter Overloading

◆ uiInvokeURL() [7/12]

int vfigui::uiInvokeURL	(	int	region_id,
		const char *	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for uiInvokeURL(0,region_id,dummy_value,url,cb,cbdata);

◆ uiInvokeURL() [8/12]

int vfigui::uiInvokeURL	(	int	region_id,
		const std::string &	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for uiInvokeURL(0,region_id,dummy_value,url,cb,cbdata);

◆ uiInvokeURL() [9/12]

DllSpec int vfigui::uiInvokeURL	(	int	region_id,
		stringmap &	value,
		const char *	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

shortcut for uiInvokeURL(0,region_id,value,url,cb,cbdata);

◆ uiInvokeURL() [10/12]

int vfigui::uiInvokeURL	(	int	region_id,
		stringmap &	value,
		const std::string &	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for iInvokeURL(0,region_id,value,url,cb,cbdata);

◆ uiInvokeURL() [11/12]

int vfigui::uiInvokeURL	(	stringmap &	value,
		const char *	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for uiInvokeURL(0,UI_REGION_DEFAULT,value,url,cb,cbdata);

◆ uiInvokeURL() [12/12]

int vfigui::uiInvokeURL	(	stringmap &	value,
		const std::string &	url,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

shortcut for iInvokeURL(0,UI_REGION_DEFAULT,value,url,cb,cbdata);

◆ uiInvokeURLAsync() [1/12]

int vfigui::uiInvokeURLAsync	(	const char *	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(0, UI_REGION_DEFAULT, dummy_value, url,cb,data);

◆ uiInvokeURLAsync() [2/12]

int vfigui::uiInvokeURLAsync	(	const std::string &	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(0, UI_REGION_DEFAULT, dummy_value, url,cb,data);

◆ uiInvokeURLAsync() [3/12]

int vfigui::uiInvokeURLAsync	(	const stringmap &	value,
		const char *	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(0, UI_REGION_DEFAULT, value, url,cb,data);

◆ uiInvokeURLAsync() [4/12]

int vfigui::uiInvokeURLAsync	(	const stringmap &	value,
		const std::string &	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(0, UI_REGION_DEFAULT, value, url,cb,data);

◆ uiInvokeURLAsync() [5/12]

int vfigui::uiInvokeURLAsync	(	int	display,
		int	region_id,
		const char *	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(display, region_id,dummy_value,url,cb,data);

◆ uiInvokeURLAsync() [6/12]

int vfigui::uiInvokeURLAsync	(	int	display,
		int	region_id,
		const std::string &	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(display, region_id,dummy_value,url,cb,data);

◆ uiInvokeURLAsync() [7/12]

DllSpec int vfigui::uiInvokeURLAsync	(	int	display,
		int	region_id,
		const stringmap &	value,
		const char *	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously invoke an HTML dialog

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX)
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: error code (see UIError) or transaction ID. The transaction ID is required for obtaining the dialog result using uiInvokeWait()

display, region_id and value are optional, see Parameter Overloading

If no callback was provided, uiInvokeWait() must be called to obtain the result and release allocated memory or uiInvokeCancel() needs to be called to cancel the dialog. If a callback was provided uiInvokeWait() cannot be used and will return UI_ERR_INVALID.

◆ uiInvokeURLAsync() [8/12]

DllSpec int vfigui::uiInvokeURLAsync	(	int	display,
		int	region_id,
		const stringmap &	value,
		const std::string &	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

Asynchronously invoke an HTML dialog

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX)
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: error code (see UIError) or transaction ID. The transaction ID is required for obtaining the dialog result using uiInvokeWait()

display, region_id and value are optional, see Parameter Overloading

If no callback was provided, uiInvokeWait() must be called to obtain the result and release allocated memory or uiInvokeCancel() needs to be called to cancel the dialog. If a callback was provided uiInvokeWait() cannot be used and will return UI_ERR_INVALID.

◆ uiInvokeURLAsync() [9/12]

int vfigui::uiInvokeURLAsync	(	int	region_id,
		const char *	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(0,region_id,dummy_value,url,cb,data);

◆ uiInvokeURLAsync() [10/12]

int vfigui::uiInvokeURLAsync	(	int	region_id,
		const std::string &	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(0,region_id,dummy_value,url,cb,data);

◆ uiInvokeURLAsync() [11/12]

DllSpec int vfigui::uiInvokeURLAsync	(	int	region_id,
		const stringmap &	value,
		const char *	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

shortcut for uiInvokeURLAsync(0,region_id,value,url,cb,data);

◆ uiInvokeURLAsync() [12/12]

int vfigui::uiInvokeURLAsync	(	int	region_id,
		const stringmap &	value,
		const std::string &	url,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

shortcut for uiInvokeURLAsync(0, region_id, value, url,cb,data);

◆ uiInvokeURLDetached() [1/3]

int vfigui::uiInvokeURLDetached

(

const char *

url

)

inline

shortcut for uiInvokeURLDetached(0,UI_REGION_DEFAULT,url);

◆ uiInvokeURLDetached() [2/3]

DllSpec int vfigui::uiInvokeURLDetached	(	int	display,
		int	region_id,
		const char *	url
	)

Create a new thread and display a dialog from within this thread. The thread terminates when the dialog terminates. Dialog return values are discarded.

Parameters

[in]	display	display
[in]	region_id	region id
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX)

Returns: error code (see UIError) (but no result from dialog)

display and region_id are optional, see Parameter Overloading

This function is useful for example for displaying some kind of virtual keyboard.

◆ uiInvokeURLDetached() [3/3]

DllSpec int vfigui::uiInvokeURLDetached	(	int	region_id,
		const char *	url
	)

shortcut for uiInvokeURLDetached(0,region_id,url);

◆ uiInvokeWait() [1/2]

int vfigui::uiInvokeWait	(	int	txn_id,
		int	timeout_msec = `-1`
	)

inline

the same as uiInvokeWait(int txn_id, std::map<std::string,std::string> &value, int timeout_msec=-1) but discards returned input values

◆ uiInvokeWait() [2/2]

DllSpec int vfigui::uiInvokeWait	(	int	txn_id,
		std::map< std::string, std::string > &	value,
		int	timeout_msec = `-1`
	)

Wait for a dialog to finish

Parameters

[in]	txn_id	Request ID of the dialog
[out]	value	entered values are added to this map
[in]	timeout_msec	timeout in milliseconds. In case of a negative timeout wait forever.

Returns: error code (see UIError) or return value specified in the HTML fragment. In case of a timeout UI_ERR_WAIT_TIMEOUT is returned and uiInvokeWait() has to be called again or memory may be leaked. As an alternative uiInvokeCancel() may be called to cancel the dialog.

uiInvokeWait cannot be called if a callback function has been provided when invoking the dialog.

When displaying dialog sequences (e.g. using load url in an action) uiInvokeWait() handles the switching to the next dialog in the sequence.

◆ uiLayout() [1/10]

DllSpec int vfigui::uiLayout

(

const char *

name

)

shortcut for uiLayout(0,name);

◆ uiLayout() [2/10]

int vfigui::uiLayout

(

const std::vector< UIRegion > &

reg

)

inline

shortcut for uiLayout(0,reg);

◆ uiLayout() [3/10]

int vfigui::uiLayout	(	const std::vector< UIRegion > &	reg,
		const std::vector< UIRegion > &	oldreg
	)

inline

shortcut for uiLayout(0,reg,oldreg);

◆ uiLayout() [4/10]

DllSpec int vfigui::uiLayout	(	const UIRegion *	region,
		int	regcnt
	)

shortcut for uiLayout(0,region,regcnt,0,0);

◆ uiLayout() [5/10]

DllSpec int vfigui::uiLayout	(	const UIRegion *	region,
		int	regcnt,
		const UIRegion *	oldreg,
		int	oldregcnt
	)

shortcut for uiLayout(0,region,regcnt,oldreg,oldregcnt);

◆ uiLayout() [6/10]

DllSpec int vfigui::uiLayout	(	int	display,
		const char *	name
	)

define output regions of the display. The layout definition is read from section name of gui.ini

Parameters

[in]	display	display
[in]	name	name of the layout section in gui.ini

Returns: error code (see UIError), in case the section is not found in gui.ini or it is does not contain a valid configuration, then UI_ERR_REGION is returned.

display is optional, see Parameter Overloading

changing the layout may cancel all currently active dialogs

◆ uiLayout() [7/10]

int vfigui::uiLayout	(	int	display,
		const std::vector< UIRegion > &	reg
	)

inline

define output regions on the display. Region with id==0 is the default region.

Parameters

[in]	display	display
[in]	reg	vector containing the regions, at least one region must be provided

Returns: error code (see UIError)

display is optional, see Parameter Overloading

If a region is removed that still contains a dialog this dialog is cancelled.

◆ uiLayout() [8/10]

int vfigui::uiLayout	(	int	display,
		const std::vector< UIRegion > &	reg,
		const std::vector< UIRegion > &	oldreg
	)

inline

define output regions on the display. Region with id==0 is the default region. The old layout provided in oldreg must match the current layout in guiserver or the layout will not be updated and UI_ERR_MODIFIED will be returned.

Parameters

[in]	display	display
[in]	reg	vector containing the regions, at least one region must be provided
[in]	oldreg	vector containing the previous set of regions.

Returns: error code (see UIError)

display is optional, see Parameter Overloading

If a region is removed that still contains a dialog this dialog is cancelled.

◆ uiLayout() [9/10]

DllSpec int vfigui::uiLayout	(	int	display,
		const UIRegion *	region,
		int	regcnt
	)

shortcut for uiLayout(display, region,regcnt,0,0);

◆ uiLayout() [10/10]

DllSpec int vfigui::uiLayout	(	int	display,
		const UIRegion *	region,
		int	regcnt,
		const UIRegion *	oldreg,
		int	oldregcnt
	)

define output regions on the display. Region with id==0 is the default region. For incremental layout updates the previous layout may be provided to be checked before applying the new layout. If the previous layout does not match the current layout in guiserver, UI_ERR_MODIFIED is returned. This feature can be used to detect and prevent race conditions if several processes concurrently try to update a layout.

Parameters

[in]	display	display
[in]	region	array containing the regions, at least one region must be provided
[in]	regcnt	number of entries in region
[in]	oldreg	optional: if not NULL array containing the previous set of regions
[in]	oldregcnt	optional: number of entries in oldreg

Returns: error code (see UIError)

display is optional, see Parameter Overloading

If a region is removed that still contains a dialog this dialog is cancelled.

Examples: demo-sysinfo.cpp.

◆ uiLeaveRegion() [1/2]

DllSpec int vfigui::uiLeaveRegion

(

)

shortcut for uiLeaveRegion(0);

◆ uiLeaveRegion() [2/2]

DllSpec int vfigui::uiLeaveRegion

(

int

display

)

Ascend one level in the tree of regions.

Returns: error code: UI_ERR_OK if region was left, UI_ERR_REGION if already at the highest level

display is optional, see Parameter Overloading

◆ uiLibVersion()

const DllSpec char* vfigui::uiLibVersion

(

)

read library version

Returns: string containing the version

◆ uiMenu() [1/3]

int vfigui::uiMenu	(	const std::string &	templateName,
		const std::string &	text,
		const struct UIMenuEntry	menu[],
		int	menusize,
		int	preselect,
		uiCallback	cb = `0`,
		void *	cbdata = `0`
	)

inline

◆ uiMenu() [2/3]

DllSpec int vfigui::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`
	)

Display an HTML menu dialog on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	text	string containing an HTML fragment (i.e. the part between <body> and lt;/body>).
[in]	menu	array containing menu entries
[in]	menusize	number of entries in the array
[in]	preselect	value of the menu entry to be preselected.
[in]	cb	optional callback function
[in]	cbdata	data pointer passed on to the callback function

Returns: error code (see UIError) or value of selected menu entry.

display and region_id are optional, see Parameter Overloading

Examples: demo-sysinfo.cpp, mac_demo1.cpp, mac_demo2.cpp, and pm-demo.cpp.

◆ uiMenu() [3/3]

DllSpec int vfigui::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`
	)

◆ uiMenuAsync() [1/3]

int vfigui::uiMenuAsync	(	const std::string &	template_name,
		const std::string &	text,
		const struct UIMenuEntry	menu[],
		int	menusize,
		int	preselect,
		uiAsyncCallback	cb = `0`,
		void *	data = `0`
	)

inline

◆ uiMenuAsync() [2/3]

DllSpec int vfigui::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`
	)

Asynchronously display an HTML menu dialog on screen using a template file.

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	templateName	name of a template file. The HTML code found in text is inserted into the template
[in]	text	string containing an HTML fragment (i.e. the part between <body> and </body>).
[in]	menu	array containing menu entries
[in]	menusize	number of entries in the array
[in]	preselect	value of the menu entry to be preselected.
[in]	cb	optional callback function that is called when the dialog has returned
[in]	data	data pointer that is passed on to the callback function

Returns: transaction ID or error code (see UIError)

display and region_id are optional, see Parameter Overloading

use uiMenuWait() to wait for the dialog to finish or use uiInvokeCancel() to cancel the dialog

◆ uiMenuAsync() [3/3]

DllSpec int vfigui::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`
	)

◆ uiMenuWait()

DllSpec int vfigui::uiMenuWait	(	int	txn_id,
		int	timeout_msec = `-1`
	)

Wait for the menu dialog to finish

Parameters

[in]	txn_id	transaction id as returned by uiMenuAsync()
[in]	timeout_msec	timeout in milliseconds. In case of a negative timeout wait forever.

Returns: error code (see UIError) or value of selected menu entry. In case of a timeout UI_ERR_WAIT_TIMEOUT is returned and uiMenuWait() may be called again.

◆ uiNagScreen()

DllSpec int vfigui::uiNagScreen	(	int	display,
		enum UINagScreenType	type,
		int	hide,
		int	show
	)

trigger display of a nag screen. The nag screen is hidden and shown in a loop hide and show times can be configured. Once triggered, the nag screen cannot be disabled for security reasons until next reboot. Currently only useful on VOS3

Parameters

[in]	display	display
[in]	type	nag screen type
[in]	hide	hide time in seconds
[in]	show	show time in seconds

Returns: error code;

◆ uiPrint()

DllSpec std::string vfigui::uiPrint	(	const char *	format,
			...
	)

perform printf-like formatting.

Parameters

[in]

format

printf-like format string. It supports the commonly known format specifiers 's', 'i', 'd', 'u', 'o', 'x', 'X', 'p', 'c', 'f', 'e', 'g'. In addition the following format specifiers are supported:

'S': format as string and substitute the special HTML characters '&', '<', '>', '"' and '\'' by character references (e.g. '&', '<' ...).
'C': format as character and sustitute HTML characters

Returns: formatted string

Examples: demo-sysinfo.cpp, mac_demo1.cpp, mac_demo2.cpp, and pm-demo.cpp.

◆ uiPrintV()

DllSpec std::string vfigui::uiPrintV	(	const char *	format,
		va_list	va
	)

perfom printf-like formatting. This is the same as uiPrint() just taking a va_list instead of a variable number of arguments

◆ uiReadConfig() [1/2]

DllSpec void vfigui::uiReadConfig

(

)

shortcut for uiReadConfig(0);

◆ uiReadConfig() [2/2]

DllSpec void vfigui::uiReadConfig

(

int

display

)

re-read configuration from file gui.ini from within the resource directory associated with a display

Parameters

[in]

display

display is optional, see Parameter Overloading

gui.ini is read automatically on startup. Invoking uiReadConfig() is required if gui.ini has been modified by the application or the resource path has been changed by updating UI_PROP_RESOURCE_PATH and re-reading of the file is required.

◆ uiReadRuntimeID()

DllSpec int vfigui::uiReadRuntimeID	(	int	display,
		std::string &	id,
		int	timeout_msec = `5000`
	)

read runtime ID: This is a random string, that remains the same during the runtime of the server and changes, if the server has been restarted

Parameters

[in]	display	display
[out]	id	runtime ID string
[in]	timeout_msec	timeout in milliseconds. In case of a negative timeout wait forever.

Returns: error code

◆ uiRegionIsVisible() [1/2]

DllSpec int vfigui::uiRegionIsVisible	(	int	display,
		int	region_id
	)

check if region is visible on screen or hidden

Parameters

[in]	display	display
[in]	region_id	region ID

Returns: 1 if visible, 0 if not visible, <0 if error

◆ uiRegionIsVisible() [2/2]

int vfigui::uiRegionIsVisible

(

int

region_id

)

inline

check if region is visible on screen or hidden

Parameters

[in]

region_id

region ID

Returns: 1 if visible, 0 if not visible, <0 if error

◆ uiRemoveOption() [1/2]

DllSpec int vfigui::uiRemoveOption	(	int	display,
		int	region_id,
		const std::string &	name,
		const std::string &	value
	)

Remove an option from a <select> element

Parameters

[in]	display	display
[in]	region_id	region id
[in]	name	name of the <select> element
[in]	value	value of the element to be removed

Returns: error code

◆ uiRemoveOption() [2/2]

int vfigui::uiRemoveOption	(	int	region_id,
		const std::string &	name,
		const std::string &	value
	)

inline

shortcut for uiRemoveOption(0,region_id,name,value);

◆ uiRunAction() [1/2]

DllSpec int vfigui::uiRunAction	(	int	display,
		int	region_id,
		const std::string &	name
	)

Run the action of an input element on screen. This covers <input>, <select> and <button>

Parameters

[in]	display	display
[in]	region_id	region id
[in]	name	name of the input element

Returns: error code

◆ uiRunAction() [2/2]

int vfigui::uiRunAction	(	int	region_id,
		const std::string &	name
	)

inline

shortcut for uiRunAction(0,region_id,name);

◆ uiRunAction2() [1/2]

DllSpec int vfigui::uiRunAction2	(	int	display,
		int	region_id,
		const std::string &	name
	)

Run the action2 of an input element on screen. This covers <input>, <select> and <button>

Parameters

[in]	display	display
[in]	region_id	region id
[in]	name	name of the input element

Returns: error code

◆ uiRunAction2() [2/2]

int vfigui::uiRunAction2	(	int	region_id,
		const std::string &	name
	)

inline

shortcut for uiRunAction2(0,region_id,name);

◆ uiScreenshotPNG() [1/4]

DllSpec int vfigui::uiScreenshotPNG

(

const char *

filename

)

shortcut for uiScreenshotPNG(0,filename);

◆ uiScreenshotPNG() [2/4]

int vfigui::uiScreenshotPNG	(	const char *	filename,
		int	x,
		int	y,
		int	w,
		int	h
	)

inline

shortcut for uiScreenshotPNG(0,filename,x,y,w,h);

◆ uiScreenshotPNG() [3/4]

DllSpec int vfigui::uiScreenshotPNG	(	int	display,
		const char *	filename
	)

take a screenshot and save as PNG file

Parameters

[in]	display	display
[in]	filename	file name

Returns: error code (see UIError)

display is optional, see Parameter Overloading

Only supported by DirectGUI

Examples: mac_demo1.cpp.

◆ uiScreenshotPNG() [4/4]

DllSpec int vfigui::uiScreenshotPNG	(	int	display,
		const char *	filename,
		int	x,
		int	y,
		int	w,
		int	h
	)

take a screenshot of a screen area and save as PNG file

Parameters

[in]	display	display
[in]	filename	file name
[in]	x	x-coordinate of the screen area
[in]	y	y-coordinate of the screen area
[in]	w	width of the screen area
[in]	h	height of the screen area

Returns: error code (see UIError)

If the position/size does not fit on the screen it will be cropped

display is optional, see Parameter Overloading

Only supported by DirectGUI

◆ uiScreenshotPNGData() [1/4]

DllSpec int vfigui::uiScreenshotPNGData	(	int	display,
		std::vector< unsigned char > &	data
	)

take a screenshot and return PNG data in vector

Parameters

[in]	display	display
[out]	data	data of PNG file

Returns: error code (see UIError)

display is optional, see Parameter Overloading

Only supported by DirectGUI

◆ uiScreenshotPNGData() [2/4]

DllSpec int vfigui::uiScreenshotPNGData	(	int	display,
		std::vector< unsigned char > &	data,
		int	x,
		int	y,
		int	w,
		int	h
	)

take a screenshot of a screen area and return PNG data in vector

Parameters

[in]	display	display
[out]	data	data of PNG file
[in]	x	x-coordinate of the screen area
[in]	y	y-coordinate of the screen area
[in]	w	width of the screen area
[in]	h	height of the screen area

Returns: error code (see UIError)

If the position/size does not fit on the screen it will be cropped

display is optional, see Parameter Overloading

Only supported by DirectGUI

◆ uiScreenshotPNGData() [3/4]

DllSpec int vfigui::uiScreenshotPNGData

(

std::vector< unsigned char > &

data

)

shortcut for uiScreenshotPNGData(0,data);

◆ uiScreenshotPNGData() [4/4]

int vfigui::uiScreenshotPNGData	(	std::vector< unsigned char > &	data,
		int	x,
		int	y,
		int	w,
		int	h
	)

inline

shortcut for uiScreenshotPNGData(0,data,x,y,w,h);

◆ uiScriptError()

DllSpec std::string vfigui::uiScriptError

(

)

Obtain script error message

Returns: string containing information about errors that were reported during last script processing in this thread.

◆ uiScrollOption() [1/2]

DllSpec int vfigui::uiScrollOption	(	int	display,
		int	region_id,
		const std::string &	name,
		const std::string &	value,
		UIScrollPosition	pos
	)

scroll an entry in a <select> element to the top or bottom position

Parameters

[in]	display	display
[in]	region_id	region id
[in]	name	name of the <select> element
[in]	value	value of the element to be scrolled
[in]	pos	position

Scrolling is only supported if the content is larger than the containing element. Scrolling is limited to the amount the user could scroll using the touch screen.

◆ uiScrollOption() [2/2]

int vfigui::uiScrollOption	(	int	region_id,
		const std::string &	name,
		const std::string &	value,
		UIScrollPosition	pos
	)

inline

shortcut for uiScrollOption(0,region_id,name,value,pos)

◆ uiSetBacklightConfig()

DllSpec int vfigui::uiSetBacklightConfig	(	int	display,
		const std::vector< UIBacklight > &	levels
	)

set up backlight parameters

Parameters

[in]	display	display
[in]	levels	backlight brightness levels and timeouts. The entries in the vector are considered to represent decreasing brightness, i.e. levels[0] represents maximum brighness and levels[levels.size()-1] represents minimum brightness.

Returns: error code (see UIError)

If more than one brightness level is configured, the first level is considered to be the on state. This level is activated as soon as there is some user interaction. The last level is considered to be the off state. In this state, if the brighness is 0, the first touch or keypress is used to wake up the device and is otherwise dropped to not inadvertedly trigger an action.

◆ uiSetBacklightLevel()

DllSpec int vfigui::uiSetBacklightLevel	(	int	display,
		int	level
	)

set backlight level to one of the levels defined using uiSetBacklightParam

Parameters

[in]	display	display
[in]	level	new level in the range 0..levels.size()-1

Returns: error code (see UIError)

The level is evaluated modulus the number of configured levels, i.e. setting it to -1 can be used to select the level with lowest brightness.

◆ uiSetCatalog() [1/2]

DllSpec int vfigui::uiSetCatalog

(

const std::string &

filename

)

shortcut for uiSetCatalog(0,filename);

◆ uiSetCatalog() [2/2]

DllSpec int vfigui::uiSetCatalog	(	int	display,
		const std::string &	filename
	)

load and set a catalog file containing name-value text pairs to be inserted with HTML placeholder <?text name?>. The current catalog is unloaded with filename=="" or by loading another catalog file.

Parameters

[in]	display	display
[in]	filename	of the catalog, empty string to unload the current dialog

Returns: UI_ERR_OK if file was successfully loaded, else error code (see UIError)

display is optional, see Parameter Overloading

Setting the catalog file resets UI_PROP_LANGUAGE

◆ uiSetConnectAttempts()

DllSpec void vfigui::uiSetConnectAttempts

(

int

num

)

set the number of attempts to contact the server. After a failed attempt the library waits for about 1s.

Parameters

[in]

num

number of attempts, if 0 use an infinite number of attempts (default: 30).

This takes effect on the next attempt to connect to the server, therefore, it should be invoked before any other function.

◆ uiSetCurrentRegionPath() [1/2]

DllSpec int vfigui::uiSetCurrentRegionPath

(

const std::string &

path

)

shortcut for uiSetCurrentRegionPath(0,path);

◆ uiSetCurrentRegionPath() [2/2]

DllSpec int vfigui::uiSetCurrentRegionPath	(	int	display,
		const std::string &	path
	)

set region path.

Parameters

[in]	display	display
[in]	path	absolute region path to be set

Returns: error code

display is optional, see Parameter Overloading

◆ uiSetDisconnectCallback()

DllSpec void vfigui::uiSetDisconnectCallback

(

uiDisconnectCallback

cb

)

set callback that gets invoked if the contact to the server is lost

Parameters

[in]

cb

callback function or NULLThe callback is invoked with the display number.

◆ uiSetInput() [1/2]

DllSpec int vfigui::uiSetInput	(	int	display,
		int	region_id,
		const std::string &	name,
		const std::string &	value
	)

set the value of an input element on screen. This covers <input> and <select> elements

Parameters

[in]	display	display
[in]	region_id	region id
[in]	name	name of the input element
[in]	value	new value

Returns: error code

◆ uiSetInput() [2/2]

int vfigui::uiSetInput	(	int	region_id,
		const std::string &	name,
		const std::string &	value
	)

inline

shortcut for uiSetInput(0,region_id,name,value);

◆ uiSetKeepalive()

DllSpec void vfigui::uiSetKeepalive	(	int	count,
		int	interval
	)

set keepalive settings for the next connection setup.

Parameters

[in]	count	number of keepalive probes to send before dropping the link
[in]	interval	time in seconds between sending keepalive probes

This needs to be invoked before any other functions that might establish a connection to the GUI server.

◆ uiSetLED() [1/2]

DllSpec int vfigui::uiSetLED	(	int	display,
		unsigned	led,
		bool	state
	)

switch led on/off

Parameters

[in]	display	display
[in]	led	led number (0..3)
[in]	state	on (true) or off (false)

Returns: error code (see UIError)

◆ uiSetLED() [2/2]

DllSpec int vfigui::uiSetLED	(	unsigned	led,
		bool	state
	)

shortcut for accessing display 0

◆ uiSetLocalProperties()

DllSpec void vfigui::uiSetLocalProperties

(

bool

local

)

de-/activate thread local properties for the current thread. Activating thread local properties initially copies the global properties to the current thread.

Parameters

[in]

local

if true activate thread local properties, if false discard them

Switching affects all displays.

◆ uiSetLogMask()

DllSpec void vfigui::uiSetLogMask

(

unsigned

mask

)

Set log mask

Parameters

[in]

mask

logging mask (see GUI_LOGMASK)

◆ uiSetPropertyInt() [1/2]

DllSpec int vfigui::uiSetPropertyInt	(	enum UIPropertyInt	property,
		int	value
	)

shortcut for uiSetPropertyInt(0,property,value);

◆ uiSetPropertyInt() [2/2]

DllSpec int vfigui::uiSetPropertyInt	(	int	display,
		enum UIPropertyInt	property,
		int	value
	)

set int property

Parameters

[in]	display	display
[in]	property	property to be set
[in]	value	new value

Returns: error code (see UIError)

display is optional, see Parameter Overloading

Examples: demo-sysinfo.cpp, mac_demo1.cpp, mac_demo2.cpp, and pm-demo.cpp.

◆ uiSetPropertyString() [1/4]

DllSpec int vfigui::uiSetPropertyString	(	enum UIPropertyString	property,
		const char *	value
	)

shortcut for uiSetPropertyString(0,property,value);

◆ uiSetPropertyString() [2/4]

int vfigui::uiSetPropertyString	(	enum UIPropertyString	property,
		const std::string &	value
	)

inline

shortcut for uiSetPropertyString(0,property,value);

◆ uiSetPropertyString() [3/4]

DllSpec int vfigui::uiSetPropertyString	(	int	display,
		enum UIPropertyString	property,
		const char *	value
	)

set string property

Parameters

[in]	display	display
[in]	property	property to be set
[in]	value	new value

Returns: error code (see UIError)

display is optional, see Parameter Overloading

◆ uiSetPropertyString() [4/4]

int vfigui::uiSetPropertyString	(	int	display,
		enum UIPropertyString	property,
		const std::string &	value
	)

inline

set string property

Parameters

[in]	display	display
[in]	property	property to be set
[in]	value	new value

Returns: error code (see UIError)

display is optional, see Parameter Overloading

◆ uiSetServerProperty()

DllSpec int vfigui::uiSetServerProperty	(	int	display,
		enum UIServerProperty	property,
		const std::string &	value
	)

set global server property

Parameters

[in]	display	display
[in]	property	property to be set
[in]	value	new value

Returns: error code (see UIError)

◆ uiSetTransition() [1/3]

DllSpec int vfigui::uiSetTransition	(	int	display,
		int	region_id,
		unsigned	transtype,
		int	duration_ms
	)

set the transition type for a region

Parameters

[in]	display	display
[in]	region_id	region id
[in]	transtype	transition type
[in]	duration_ms	duration for the transition in milliseconds, ignored for UI_TRANS_NONE which is the default transition type.

Returns: error code (see UIError)

display is optional, see Parameter Overloading

Configured transitions are reset when changing the layout

◆ uiSetTransition() [2/3]

DllSpec int vfigui::uiSetTransition	(	int	region_id,
		unsigned	transtype,
		int	duration_ms
	)

shortcut for accessing display 0

◆ uiSetTransition() [3/3]

int vfigui::uiSetTransition	(	unsigned	transtype,
		int	duration_ms
	)

inline

shortcut for accessing UI_REGION_DEFAULT on display 0

◆ uiShowLEDArea() [1/2]

DllSpec int vfigui::uiShowLEDArea	(	int	display,
		UIEdge	edge,
		int	width,
		int	height,
		unsigned	bg_rgba
	)

show virtual LEDs on the display and/or increment the LED area reference counter. The LED area is cleared with the background color and the LEDs are drawn in off-state.

Parameters

[in]	display	display
[in]	edge	selects edge of the display at which to reserve some room. UI_EDGE_OFF removes the LED area
[in]	width	width of the area
[in]	height	height of the area
[in]	bg_rgba	background color in RGBA format (alpha channel is ignored)

Returns: error code (see UIError)

The size of the LED area determines how much room is available for distributing the contactless LEDs. It does not need to fit the width (or height depending on the edge) of the display, clearing the background happens using the full width (height).

If uiShowLEDArea is called more than once, then the later calls do not update the parameters but only increase a reference counter. uiHideLEDArea() has to be called the same number of times to remove the area.

uiConfigLEDs should be called before calling uiShowLEDArea().

◆ uiShowLEDArea() [2/2]

DllSpec int vfigui::uiShowLEDArea	(	UIEdge	edge,
		int	width,
		int	height,
		unsigned	bg_rgba
	)

shortcut for accessing display 0

◆ uiStatistics()

const DllSpec UIStatistics& vfigui::uiStatistics

(

)

obtain statistics information for the last completed dialog. In case of synchronous dialogs the statistics information is reset as part of displaying the dialog. In case of asynchronous dialogs this information is reset as part of calling uiInvokeWait (or one of the other ui*Wait functions)

Returns: reference to statistics information of the last dialog shown in this thread.

◆ uiTextMetrics() [1/2]

DllSpec int vfigui::uiTextMetrics	(	int	display,
		int	region_id,
		const std::string &	font,
		int	size,
		unsigned	style,
		std::vector< UITextWidth > &	width,
		int &	height,
		int &	descent
	)

determine size of text in pixels

Parameters

[in]	display	display
[in]	region_id	region ID
[in]	font	font name
[in]	size	nominal font height
[in]	style	font style
[in,out]	width	array with the texts for which the width should be determined, the widths are filled in on return.
[out]	height	font height, may be different from nominal font height
[out]	descent	number of pixels below line

Returns: error code (see UIError)

◆ uiTextMetrics() [2/2]

int vfigui::uiTextMetrics	(	int	region_id,
		const std::string &	font,
		int	size,
		unsigned	style,
		std::vector< UITextWidth > &	width,
		int &	height,
		int &	descent
	)

inline

shortcut for uiTextMetrics(0,region_id,font,size,style,width,height,descent);

◆ uiUpdate() [1/2]

DllSpec int vfigui::uiUpdate	(	int	display,
		int	region_id,
		const std::string &	name,
		const std::string &	html
	)

Update HTML code

Parameters

[in]	display	display
[in]	region_id	region id
[in]	name	name of the div element, whose HTML content is to be replaced
[in]	html	new HTML code, which replaces the old one

Returns: error code

IMPORTANT: Neither the old nor the new HTML code must use the CSS position attribute or the behavior is undefined (e.g. elements may not be removed from screen)

Preprocessing is not supported by this command.

◆ uiUpdate() [2/2]

int vfigui::uiUpdate	(	int	region_id,
		const std::string &	name,
		const std::string &	html
	)

inline

shortcut for uiUpdate(0,region_id,name,html);

◆ uiURL2PNG()

DllSpec int vfigui::uiURL2PNG	(	const char *	filename,
		int	width,
		int	height,
		const std::map< std::string, std::string > &	value,
		const std::string &	url
	)

convert a dialog to a PNG image

Parameters

[in]	filename	file name of the PNG file
[in]	width	width of the image
[in]	height	height of the image
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX) unless an absolute path was provided.

Returns: error code (see UIError)

◆ uiURL2PNGData()

DllSpec int vfigui::uiURL2PNGData	(	std::vector< unsigned char > &	data,
		int	width,
		int	height,
		const std::map< std::string, std::string > &	value,
		const std::string &	url
	)

convert a dialog to a PNG image

Parameters

[out]	data	data of PNG file
[in]	width	width of the image
[in]	height	height of the image
[in]	value	name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing.
[in]	url	location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI_PROP_RESOURCE_PATH, UI_PROP_FILE_PREFIX) unless an absolute path was provided.

Returns: error code (see UIError)

2Checkout API Reference 6.0

vfigui Namespace ReferenceGraphical User Interface

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ vfigui::UIBacklight

◆ vfigui::UIMenuEntry

◆ vfigui::UIRegion

◆ vfigui::UIStatistics

Typedef Documentation

◆ uiAsyncCallback

◆ uiCallback

◆ uiDisconnectCallback

◆ uiEventCallback

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ UIBeep

◆ UICanvasEvent

◆ UICBType

◆ UIEdge

◆ UILEDShape

◆ UIMenuOptions

◆ UINagScreenType

◆ UIPropertyInt

◆ UIPropertyString

◆ UIScrollPosition

◆ UIServerProperty

Function Documentation

◆ gui_GetSvcVersion() [1/2]

◆ gui_GetSvcVersion() [2/2]

◆ gui_GetVersion()

◆ uiAddOption() [1/2]

◆ uiAddOption() [2/2]

◆ uiBeep() [1/2]

◆ uiBeep() [2/2]

◆ uiCanvas() [1/2]

◆ uiCanvas() [2/2]

◆ uiCatalogGetDelayedRelease()

◆ uiCatalogSetDelayedRelease()

◆ uiClear() [1/2]

◆ uiClear() [2/2]

◆ uiConfigLEDs() [1/4]

◆ uiConfigLEDs() [2/4]

◆ uiConfigLEDs() [3/4]

◆ uiConfigLEDs() [4/4]

◆ uiConfirm() [1/3]

◆ uiConfirm() [2/3]

◆ uiConfirm() [3/3]

◆ uiConfirmAsync() [1/3]

◆ uiConfirmAsync() [2/3]

◆ uiConfirmAsync() [3/3]

◆ uiConfirmWait()

◆ uiCurrentRegionPath() [1/2]

◆ uiCurrentRegionPath() [2/2]

◆ uiDataURLToFile()

◆ uiDataURLToString()

◆ uiDataURLType()

◆ uiDisablePINOK()

◆ uiDisconnect()

◆ uiDisplay() [1/6]

◆ uiDisplay() [2/6]

◆ uiDisplay() [3/6]

◆ uiDisplay() [4/6]

◆ uiDisplay() [5/6]

◆ uiDisplay() [6/6]

◆ uiDisplayAsync() [1/6]

◆ uiDisplayAsync() [2/6]

◆ uiDisplayAsync() [3/6]

◆ uiDisplayAsync() [4/6]

◆ uiDisplayAsync() [5/6]

◆ uiDisplayAsync() [6/6]

◆ uiDisplayCount()

◆ uiDisplayWait()

◆ uiDraw() [1/2]

◆ uiDraw() [2/2]