Index

Modules: webui, webui/bindings.

API symbols

`bind`:

• webui: proc `bind`(window: Window; element: string; func: proc (e: Event))
• webui: proc `bind`(window: Window; element: string; func: proc (e: Event): string)
• webui: proc `bind`(window: Window; element: string; func: proc (e: Event): int)
• webui: proc `bind`(window: Window; element: string; func: proc (e: Event): float)
• webui: proc `bind`(window: Window; element: string; func: proc (e: Event): bool)
• webui: proc `bind`(window: Window; element: string; func: proc ())
• webui: proc `bind`(window: Window; element: string; func: proc (): string)
• webui: proc `bind`(window: Window; element: string; func: proc (): int)
• webui: proc `bind`(window: Window; element: string; func: proc (): float)
• webui: proc `bind`(window: Window; element: string; func: proc (): bool)
• bindings: proc `bind`(window: csize_t; element: cstring; func: proc (e: ptr Event) {.cdecl.}): csize_t

bindCb:

• webui: macro bindCb(window: untyped; cbFuncName: untyped; cbFunc: typed): untyped

bindId:

• webui: proc bindId(event: Event): int

browserExist:

• webui: proc browserExist(browser: bindings.WebuiBrowser): bool

browser_exist:

• bindings: proc browser_exist(browser: csize_t): bool

childProcessId:

• webui: proc childProcessId(window: Window): int

clean:

• webui: proc clean()
• bindings: proc clean()

clientId:

• webui: proc clientId(event: Event): int

close:

• webui: proc close(window: Window)
• bindings: proc close(window: csize_t)

closeClient:

• webui: proc closeClient(event: Event)

close_client:

• bindings: proc close_client(e: ptr Event)

connectionId:

• webui: proc connectionId(event: Event): int

cookies:

• webui: proc cookies(event: Event): string

decode:

• webui: proc decode(str: string): string
• bindings: proc decode(str: cstring): cstring

deleteAllProfiles:

• webui: proc deleteAllProfiles()

delete_all_profiles:

• bindings: proc delete_all_profiles()

deleteProfile:

• webui: proc deleteProfile(window: Window)

delete_profile:

• bindings: proc delete_profile(window: csize_t)

destroy:

• webui: proc destroy(window: Window)
• bindings: proc destroy(window: csize_t)

element:

• webui: proc element(event: Event): string

encode:

• webui: proc encode(str: string): string
• bindings: proc encode(str: cstring): cstring

Event:

• webui: type Event
• bindings: object Event

eventBlocking=:

• webui: proc eventBlocking=(window: Window; status: bool)

eventNumber:

• webui: proc eventNumber(event: Event): int

eventType:

• webui: proc eventType(event: Event): bindings.WebuiEvent

exit:

• webui: proc exit()
• bindings: proc exit()

fileHandler=:

• webui: proc fileHandler=(window: Window; handler: proc (filename: string): string)

free:

• bindings: proc free(ptr: pointer)

getBestBrowser:

• webui: proc getBestBrowser(window: Window): bindings.WebuiBrowser

get_best_browser:

• bindings: proc get_best_browser(window: csize_t): csize_t

getBool:

• webui: proc getBool(event: Event): bool
• webui: proc getBool(event: Event; index: int): bool

get_bool:

• bindings: proc get_bool(e: ptr Event): bool

get_bool_at:

• bindings: proc get_bool_at(e: ptr Event; index: csize_t): bool

get_child_process_id:

• bindings: proc get_child_process_id(window: csize_t): csize_t

get_context:

• bindings: proc get_context(e: ptr Event): pointer

getCount:

• webui: proc getCount(event: Event): int

get_count:

• bindings: proc get_count(e: ptr Event): csize_t

getFloat:

• webui: proc getFloat(event: Event): float
• webui: proc getFloat(event: Event; index: int): float

get_float:

• bindings: proc get_float(e: ptr Event): cdouble

get_float_at:

• bindings: proc get_float_at(e: ptr Event; index: csize_t): cdouble

getFreePort:

• webui: proc getFreePort(): int

get_free_port:

• bindings: proc get_free_port(): csize_t

get_hwnd:

• bindings: proc get_hwnd(window: csize_t): pointer

getInt:

• webui: proc getInt(event: Event): int
• webui: proc getInt(event: Event; index: int): int

get_int:

• bindings: proc get_int(e: ptr Event): clonglong

get_int_at:

• bindings: proc get_int_at(e: ptr Event; index: csize_t): clonglong

get_last_error_message:

• bindings: proc get_last_error_message(): cstring

get_last_error_number:

• bindings: proc get_last_error_number(): csize_t

getMimeType:

• webui: proc getMimeType(file: string): string

get_mime_type:

• bindings: proc get_mime_type(file: cstring): cstring

getNewWindowId:

• webui: proc getNewWindowId(): int

get_new_window_id:

• bindings: proc get_new_window_id(): csize_t

get_parent_process_id:

• bindings: proc get_parent_process_id(window: csize_t): csize_t

get_port:

• bindings: proc get_port(window: csize_t): csize_t

getSize:

• webui: proc getSize(event: Event): int
• webui: proc getSize(event: Event; index: int): int

get_size:

• bindings: proc get_size(e: ptr Event): csize_t

get_size_at:

• bindings: proc get_size_at(e: ptr Event; index: csize_t): csize_t

getString:

• webui: proc getString(event: Event): string
• webui: proc getString(event: Event; index: int): string

get_string:

• bindings: proc get_string(e: ptr Event): cstring

get_string_at:

• bindings: proc get_string_at(e: ptr Event; index: csize_t): cstring

get_url:

• bindings: proc get_url(window: csize_t): cstring

hidden=:

• webui: proc hidden=(window: Window; status: bool)

highContrast=:

• webui: proc highContrast=(window: Window; status: bool)

impl:

• webui: proc impl(event: Event): ptr bindings.Event

impl=:

• webui: proc impl=(event: Event; be: ptr bindings.Event)

interface_bind:

• bindings: proc interface_bind(window: csize_t; element: cstring; func: proc (a1: csize_t; a2: csize_t; a3: cstring; a4: csize_t; a5: csize_t) {.cdecl.}): csize_t

interface_close_client:

• bindings: proc interface_close_client(window: csize_t; event_number: csize_t)

interface_get_bool_at:

• bindings: proc interface_get_bool_at(window: csize_t; event_number: csize_t; index: csize_t): bool

interface_get_float_at:

• bindings: proc interface_get_float_at(window: csize_t; event_number: csize_t; index: csize_t): cdouble

interface_get_int_at:

• bindings: proc interface_get_int_at(window: csize_t; event_number: csize_t; index: csize_t): clonglong

interface_get_size_at:

• bindings: proc interface_get_size_at(window: csize_t; event_number: csize_t; index: csize_t): csize_t

interface_get_string_at:

• bindings: proc interface_get_string_at(window: csize_t; event_number: csize_t; index: csize_t): cstring

interface_get_window_id:

• bindings: proc interface_get_window_id(window: csize_t): csize_t

interface_is_app_running:

• bindings: proc interface_is_app_running(): bool

interface_navigate_client:

• bindings: proc interface_navigate_client(window: csize_t; event_number: csize_t; url: cstring)

interface_run_client:

• bindings: proc interface_run_client(window: csize_t; event_number: csize_t; script: cstring)

interface_script_client:

• bindings: proc interface_script_client(window: csize_t; event_number: csize_t; script: cstring; timeout: csize_t; buffer: cstring; buffer_length: csize_t): bool

interface_send_raw_client:

• bindings: proc interface_send_raw_client(window: csize_t; event_number: csize_t; function: cstring; raw: pointer; size: csize_t)

interface_set_response:

• bindings: proc interface_set_response(window: csize_t; event_number: csize_t; response: cstring)

interface_set_response_file_handler:

• bindings: proc interface_set_response_file_handler(window: csize_t; response: pointer; length: cint)

interface_show_client:

• bindings: proc interface_show_client(window: csize_t; event_number: csize_t; content: cstring): bool

isHighContrast:

• webui: proc isHighContrast(): bool

is_high_contrast:

• bindings: proc is_high_contrast(): bool

is_shown:

• bindings: proc is_shown(window: csize_t): bool

kiosk=:

• webui: proc kiosk=(window: Window; status: bool)

malloc:

• bindings: proc malloc(size: csize_t): pointer

maximize:

• bindings: proc maximize(window: csize_t)

memcpy:

• bindings: proc memcpy(dest: pointer; src: pointer; count: csize_t)

minimize:

• bindings: proc minimize(window: csize_t)

navigate:

• webui: proc navigate(window: Window; url: string)
• bindings: proc navigate(window: csize_t; url: cstring)

navigateClient:

• webui: proc navigateClient(event: Event; url: string)

navigate_client:

• bindings: proc navigate_client(e: ptr Event; url: cstring)

newWindow:

• webui: proc newWindow(): Window
• webui: proc newWindow(windowNumber: int): Window

new_window:

• bindings: proc new_window(): csize_t

new_window_id:

• bindings: proc new_window_id(window_number: csize_t): csize_t

openUrl:

• webui: proc openUrl(url: string)

open_url:

• bindings: proc open_url(url: cstring)

parentProcessId:

• webui: proc parentProcessId(window: Window): int

port:

• webui: proc port(window: Window): int

port=:

• webui: proc port=(window: Window; port: int)

pos=:

• webui: proc pos=(window: Window; pos: tuple[x, y: int])

proxy=:

• webui: proc proxy=(window: Window; proxyServer: string)

public=:

• webui: proc public=(window: Window; status: bool)

returnBool:

• webui: proc returnBool(event: Event; b: bool)

return_bool:

• bindings: proc return_bool(e: ptr Event; b: bool)

returnFloat:

• webui: proc returnFloat(event: Event; f: float)

return_float:

• bindings: proc return_float(e: ptr Event; f: cdouble)

returnInt:

• webui: proc returnInt(event: Event; integer: int)

return_int:

• bindings: proc return_int(e: ptr Event; n: clonglong)

returnString:

• webui: proc returnString(event: Event; str: string)

return_string:

• bindings: proc return_string(e: ptr Event; s: cstring)

rootFolder=:

• webui: proc rootFolder=(window: Window; path: string): bool

run:

• webui: proc run(window: Window; script: string)
• bindings: proc run(window: csize_t; script: cstring)

runClient:

• webui: proc runClient(event: Event; script: string)

run_client:

• bindings: proc run_client(e: ptr Event; script: cstring)

runtime=:

• webui: proc runtime=(window: Window; runtime: bindings.WebuiRuntime)

script:

• webui: proc script(window: Window; script: string; timeout: int = 0; bufferLen: static[int] = 1024 * 8): tuple[data: string, error: bool]
• bindings: proc script(window: csize_t; script: cstring; timeout: csize_t; buffer: cstring; buffer_length: csize_t): bool

scriptClient:

• webui: proc scriptClient(event: Event; script: string; timeout: int = 0; bufferLen: static[int] = 1024 * 8): tuple[data: string, error: bool]

script_client:

• bindings: proc script_client(e: ptr Event; script: cstring; timeout: csize_t; buffer: cstring; buffer_length: csize_t): bool

sendRaw:

• webui: proc sendRaw(window: Window; function: string; raw: pointer; size: uint)

send_raw:

• bindings: proc send_raw(window: csize_t; function: cstring; raw: pointer; size: csize_t)

sendRawClient:

• webui: proc sendRawClient(event: Event; function: string; raw: pointer; size: uint)

send_raw_client:

• bindings: proc send_raw_client(e: ptr Event; function: cstring; raw: pointer; size: csize_t)

set_browser_folder:

• bindings: proc set_browser_folder(path: cstring)

set_center:

• bindings: proc set_center(window: csize_t)

set_close_handler_wv:

• bindings: proc set_close_handler_wv(window: csize_t; close_handler: proc (window: csize_t): bool {.cdecl.})

setConfig:

• webui: proc setConfig(option: bindings.WebuiConfig; status: bool)
• webui: proc setConfig(options: openArray[bindings.WebuiConfig] or set[bindings.WebuiConfig]; status: bool)

set_config:

• bindings: proc set_config(option: WebuiConfig; status: bool)

set_context:

• bindings: proc set_context(window: csize_t; element: cstring; context: pointer)

set_custom_parameters:

• bindings: proc set_custom_parameters(window: csize_t; params: cstring)

setDefaultRootFolder:

• webui: proc setDefaultRootFolder(path: string): bool

set_default_root_folder:

• bindings: proc set_default_root_folder(path: cstring): bool

set_event_blocking:

• bindings: proc set_event_blocking(window: csize_t; status: bool)

setFileHandler:

• webui: proc setFileHandler(window: Window; handler: proc (filename: string): string)

set_file_handler:

• bindings: proc set_file_handler(window: csize_t; handler: proc (filename: cstring; length: ptr cint): pointer {.cdecl.})

set_file_handler_window:

• bindings: proc set_file_handler_window(window: csize_t; handler: proc (window: csize_t; filename: cstring; length: ptr cint): pointer {.cdecl.})

set_frameless:

• bindings: proc set_frameless(window: csize_t; status: bool)

set_hide:

• bindings: proc set_hide(window: csize_t; status: bool)

set_high_contrast:

• bindings: proc set_high_contrast(window: csize_t; status: bool)

setIcon:

• webui: proc setIcon(window: Window; icon, mime: string)

set_icon:

• bindings: proc set_icon(window: csize_t; icon: cstring; icon_type: cstring)

set_kiosk:

• bindings: proc set_kiosk(window: csize_t; status: bool)

set_logger:

• bindings: proc set_logger(func: proc (level: csize_t; log: cstring; user_data: pointer) {.cdecl.}; user_data: pointer)

set_minimum_size:

• bindings: proc set_minimum_size(window: csize_t; width: cuint; height: cuint)

set_port:

• bindings: proc set_port(window: csize_t; port: csize_t): bool

setPos:

• webui: proc setPos(window: Window; x, y: int)

setPosition:

• webui: proc setPosition(window: Window; x, y: int)

set_position:

• bindings: proc set_position(window: csize_t; x: cuint; y: cuint)

setProfile:

• webui: proc setProfile(window: Window; name, path: string)

set_profile:

• bindings: proc set_profile(window: csize_t; name: cstring; path: cstring)

set_proxy:

• bindings: proc set_proxy(window: csize_t; proxy_server: cstring)

set_public:

• bindings: proc set_public(window: csize_t; status: bool)

set_resizable:

• bindings: proc set_resizable(window: csize_t; status: bool)

set_root_folder:

• bindings: proc set_root_folder(window: csize_t; path: cstring): bool

set_runtime:

• bindings: proc set_runtime(window: csize_t; runtime: csize_t)

setSize:

• webui: proc setSize(window: Window; width, height: int)

set_size:

• bindings: proc set_size(window: csize_t; width: cuint; height: cuint)

setTimeout:

• webui: proc setTimeout(timeout: int)

set_timeout:

• bindings: proc set_timeout(second: csize_t)

setTlsCertificate:

• webui: proc setTlsCertificate(certificate_pem, private_key_pem: string): bool

set_tls_certificate:

• bindings: proc set_tls_certificate(certificate_pem: cstring; private_key_pem: cstring): bool

set_transparent:

• bindings: proc set_transparent(window: csize_t; status: bool)

show:

• webui: proc show(window: Window; content: string): bool
• webui: proc show(window: Window; content: string; browser: bindings.WebuiBrowser): bool
• webui: proc show(window: Window; content: string; browsers: openArray[bindings.WebuiBrowser] or set[bindings.WebuiBrowser]): bool
• bindings: proc show(window: csize_t; content: cstring): bool

show_browser:

• bindings: proc show_browser(window: csize_t; content: cstring; browser: csize_t): bool

showClient:

• webui: proc showClient(event: Event; content: string): bool

show_client:

• bindings: proc show_client(e: ptr Event; content: cstring): bool

shown:

• webui: proc shown(window: Window): bool

showWv:

• webui: proc showWv(window: Window; content: string): bool

show_wv:

• bindings: proc show_wv(window: csize_t; content: cstring): bool

size=:

• webui: proc size=(window: Window; size: tuple[width, height: int])

startServer:

• webui: proc startServer(window: Window; path: string): string

start_server:

• bindings: proc start_server(window: csize_t; content: cstring): cstring

url:

• webui: proc url(window: Window): string

useWebuiDll:

• bindings: const useWebuiDll

useWebuiStaticLib:

• bindings: const useWebuiStaticLib

wait:

• webui: proc wait()
• bindings: proc wait()

WebuiBrowser:

• bindings: type WebuiBrowser

webuiCb:

• webui: macro webuiCb(procDef: untyped): untyped

WebuiConfig:

• bindings: type WebuiConfig

WebuiEvent:

• bindings: type WebuiEvent

WebuiLoggerLevel:

• bindings: type WebuiLoggerLevel

WEBUI_MAX_ARG:

• bindings: const WEBUI_MAX_ARG

WEBUI_MAX_IDS:

• bindings: const WEBUI_MAX_IDS

WebuiRuntime:

• bindings: type WebuiRuntime

WEBUI_VERSION:

• bindings: const WEBUI_VERSION

win32_get_hwnd:

• bindings: proc win32_get_hwnd(window: csize_t): pointer

Window:

• webui: type Window

window:

• webui: proc window(event: Event): Window