gui.h File Reference
Last updated: 07-Oct-2025
#include <stdarg.h>#include <pthread.h>#include "jsobject.h"#include "timestamp.h"#include "gui_error.h"#include "types.h"#include "gui_template.h"
Include dependency graph for gui.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.
Data Structures |
|
| class | UICBData |
| struct | UIRegion |
| struct | UIErrorEntry |
| struct | UIStatistics |
| struct | UIBacklight |
| class | UIDrawing |
| struct | UITextWidth |
Namespaces |
|
| vfigui | |
Macros |
|
| #define | DllSpec |
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) |
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 > ®) |
| int | uiLayout (const std::vector< UIRegion > ®) |
| int | uiLayout (int display, const std::vector< UIRegion > ®, const std::vector< UIRegion > &oldreg) |
| int | uiLayout (const std::vector< UIRegion > ®, 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 > ®ion) |
| DllSpec int | uiGetLayout (std::vector< UIRegion > ®ion) |
| 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) |
Data Structure Documentation
◆ vfigui::UIRegion
| struct vfigui::UIRegion |
structure describing the position and size of an output region
◆ 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 |
◆ vfigui::UIBacklight
Rate this article: