REFERENCE
C API
195 个条目 · 第 1/2 页
kui_devtools_dispatch_command仅在主线程直接执行以 NUL 结尾的 CDP JSON 命令并复制 JSON 响应。响应缓冲不足会截断并报告所需长度;再次调用会再次执行命令,需考虑命令副作用。
kui_devtools_dispatch_key_event仅在主线程向当前焦点元素注入 keydown、keyup 或字符事件。key 为语义键名,code 为可空物理代码,text 用于字符输入,is_auto_repeat 表示按住重复。
kui_devtools_dispatch_mouse_event仅在主线程向文档注入鼠标移动、按下、释放或滚轮事件;坐标为视口相对 CSS 像素。修饰键位为 Alt=1、Ctrl=2、Meta=4、Shift=8,delta 仅用于滚轮。
kui_devtools_get_box_model仅在主线程查询选择器命中元素的盒模型;输出 content、padding、border、margin 各 8 个 float,共 32 个,并输出 CSS 像素宽高。无匹配返回 NOT_FOUND。
kui_document_add_stylesheet向文档添加 CSS 样式表源码;在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_document_body取得文档 body 元素的计数引用,使用后须 release。
kui_document_clear_stylesheets清除文档样式表;在主线程调用。
kui_document_create创建独立文档并返回一个计数引用,使用后须 release;该接口不把文档附加到窗口。
kui_document_create_element按标签名创建文档元素并返回计数引用;使用后须 release,创建本身不等于插入 DOM。在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_document_custom_element_is_defined检查文档的自定义元素注册表是否已定义指定标签;没有注册表返回 NOT_SUPPORTED。
kui_document_define_custom_element在主线程定义自定义元素标签及连接、断开、指定属性变化回调;observed 属性名在注册时复制。回调中的元素和文本为借用,需自行 retain 或复制后才可留存;没有注册表返回 NOT_SUPPORTED。
kui_document_extension_get_perf_stats按扩展标签名读取 tick 与 paint 的最近、最大、累计耗时及调用次数,时间字段单位为毫秒;无扩展管理器返回 NOT_SUPPORTED。
kui_document_extension_invoke在主线程调用目标扩展元素的方法,传入带类型参数和最大返回数量;返回结果句柄需 release,调用的扩展状态另从结果读取。缺少扩展管理器返回 NOT_SUPPORTED。
kui_document_extension_is_loaded按标签名检查文档是否已加载对应 DOM 元素扩展;没有扩展管理器返回 NOT_SUPPORTED。
kui_document_extension_reset_perf_stats重置文档扩展管理器的性能统计;没有扩展管理器返回 NOT_SUPPORTED。
kui_document_get_element_by_id按 ID 查找文档元素;返回的元素引用归调用者释放,查找结果同样遵守引用计数规则。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_document_head取得文档 head 元素的计数引用,使用后须 release。
kui_document_init_extensions在主线程从指定目录初始化文档的 DOM 元素扩展并可返回已加载数量;扩展管理器不可用时返回 NOT_SUPPORTED。这属于 kuiext 元素扩展协议。
kui_document_load_html从 HTML 源字符串加载文档内容;DOM 修改须在主线程执行。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_document_load_html_file从指定文件路径加载 HTML 文档;DOM 修改须在主线程执行。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_document_print_to_pdf在主线程将文档输出到指定 PDF 路径,可配置元数据、点单位纸张宽高、字体栅格化和大纲;out_written 报告实际写入结果。无窗口文档会临时附加离屏渲染后端,后端不可用返回 NOT_SUPPORTED。
kui_document_query_selector在文档中查找首个匹配 CSS 选择器的元素;返回计数引用,须 release。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_document_query_selector_all在文档中查询所有匹配选择器的元素,将结果写入调用者提供的句柄数组并报告数量;每个实际返回的元素引用都须 release。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_document_release减少文档引用计数,最后一个引用消失时才销毁对象。NULL 为错误,释放后不得再用该引用;引用操作为原子操作,可跨线程调用。
kui_document_retain增加文档引用计数,每次 retain 都须配对 release;引用操作为原子操作,可跨线程调用。
kui_document_root取得文档根元素的计数引用,使用后须 release。
kui_element_add_event_listener注册指定类型的事件监听器并返回监听 ID;回调在主线程派发期间运行且可修改 DOM。evt 仅在回调内借用,不能保存或释放;user_data 由调用者管理。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_append_child向父元素追加子元素;调用者持有的元素引用仍须自行释放。在主线程修改 DOM。
kui_element_blur移除元素焦点;在主线程调用。
kui_element_child_count读取子元素数量,不把文本等非元素节点计入。
kui_element_class_list_add向 class 列表加入指定 token;在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_class_list_contains判断 class 列表是否含指定 token。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_class_list_remove从 class 列表移除指定 token;在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_class_list_toggle切换指定 class token 的有无;在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_dispatch_event向元素同步派发合成事件,经过正常捕获及冒泡路径;元素必须连接到文档,否则 INVALID_ARG。可选 out_not_canceled 在无人 preventDefault 时为 1;不携带鼠标坐标或键盘状态。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_first_child取得第一个子元素的计数引用,跳过非元素节点;使用后须 release。
kui_element_focus使元素获得焦点;在主线程调用。
kui_element_get_attribute读取指定名称的元素属性值。 输出为调用者缓冲区中的 UTF-8:可先以 NULL/0 查询长度,再分配 out_len+1;长度不含 NUL。容量不足返回 BUFFER_TOO_SMALL 并报告所需长度;容量大于 0 时仍写入 NUL 结尾的截断结果。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_get_bounding_rect在主线程读取已布局元素的边界矩形,保留亚像素信息;从未布局的文档可成功返回零尺寸。
kui_element_get_class_name读取元素完整 class 名称字符串。 输出为调用者缓冲区中的 UTF-8:可先以 NULL/0 查询长度,再分配 out_len+1;长度不含 NUL。容量不足返回 BUFFER_TOO_SMALL 并报告所需长度;容量大于 0 时仍写入 NUL 结尾的截断结果。
kui_element_get_client_metrics读取 padding box 的 client 指标:left/top 是边框宽度,width/height 排除已绘制滚动条。四值按 floor(x+0.5) 取整;可省略部分输出,不能全为 NULL。 在主线程读取,须先完成布局;从未布局时可成功返回零值。
kui_element_get_id读取元素 ID。 输出为调用者缓冲区中的 UTF-8:可先以 NULL/0 查询长度,再分配 out_len+1;长度不含 NUL。容量不足返回 BUFFER_TOO_SMALL 并报告所需长度;容量大于 0 时仍写入 NUL 结尾的截断结果。
kui_element_get_inner_html读取元素 innerHTML 序列化文本。 输出为调用者缓冲区中的 UTF-8:可先以 NULL/0 查询长度,再分配 out_len+1;长度不含 NUL。容量不足返回 BUFFER_TOO_SMALL 并报告所需长度;容量大于 0 时仍写入 NUL 结尾的截断结果。
kui_element_get_offset_metrics读取相对 offset parent 的 border box 位置和尺寸,四值按 floor(x+0.5) 取整;需要亚像素时使用 bounding rect。可省略部分输出,不能全为 NULL。 在主线程读取,须先完成布局;从未布局时可成功返回零值。
kui_element_get_scroll_metrics读取当前滚动偏移及完整可滚动范围;left/top 保留小数,width/height 按 floor(x+0.5) 取整。可省略部分输出,不能全为 NULL。 在主线程读取,须先完成布局;从未布局时可成功返回零值。
kui_element_get_style_property读取元素自身内联声明中指定属性的序列化值;未设置时返回 KUI_ERR_NOT_FOUND。color:red 可能读回 #ff0000,不能假定与输入文本相同。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_element_get_style_property_count统计元素内联声明中实际设置的属性,用于枚举检查。
kui_element_get_style_property_name按索引读取元素内联声明中的属性名;声明一旦修改,枚举索引就可能变化。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_element_get_style_text读取完整内联 style 声明的序列化文本,对应 style 属性的值。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_element_get_tag_name读取元素标签名。 输出为调用者缓冲区中的 UTF-8:可先以 NULL/0 查询长度,再分配 out_len+1;长度不含 NUL。容量不足返回 BUFFER_TOO_SMALL 并报告所需长度;容量大于 0 时仍写入 NUL 结尾的截断结果。
kui_element_get_text_content读取元素 textContent。 输出为调用者缓冲区中的 UTF-8:可先以 NULL/0 查询长度,再分配 out_len+1;长度不含 NUL。容量不足返回 BUFFER_TOO_SMALL 并报告所需长度;容量大于 0 时仍写入 NUL 结尾的截断结果。
kui_element_has_attribute判断元素是否包含指定属性。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_last_child取得最后一个子元素的计数引用,跳过非元素节点;使用后须 release。
kui_element_next_sibling取得下一个兄弟元素的计数引用,跳过非元素节点;使用后须 release。
kui_element_parent取得父元素的计数引用,使用后须 release。
kui_element_position_relative_to在主线程将元素相对 anchor 定位,使用 placement 和可选翻转、视口限制、偏移及视口边距设置。两个元素句柄都必须有效。
kui_element_previous_sibling取得上一个兄弟元素的计数引用,跳过非元素节点;使用后须 release。
kui_element_query_selector在元素查询范围内查找首个匹配 CSS 选择器的元素;返回计数引用,须 release。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_query_selector_all在元素查询范围内查找全部匹配元素,写入调用者的句柄数组并报告数量;逐个释放实际返回的计数引用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_release释放一个元素引用;元素移出 DOM 后仍由其他引用保活。每个引用恰好释放一次,释放后不可再使用;原子引用操作可跨线程调用。
kui_element_remove把元素从所在 DOM 树移除;已有句柄仍由引用计数保活,须在主线程调用。
kui_element_remove_attribute删除指定名称的元素属性;在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_remove_child从指定父元素移除子元素;未找到该子元素返回 NOT_FOUND,现有计数引用可继续保活。须在主线程调用。
kui_element_remove_event_listener用事件名称和监听 ID 删除单个监听器;ID 按事件类型分组,仅凭 ID 不足以确定监听器。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_remove_event_listeners删除元素上指定事件名称的全部监听器。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_remove_style_property在主线程移除元素自身的一条内联 style 属性。
kui_element_retain额外增加一个元素引用;常规返回值已自带引用,无须重复 retain。每次 retain 配对 release,原子引用操作可跨线程调用。
kui_element_scroll_by按 dx/dy 增量滚动元素;在主线程调用。
kui_element_set_attribute按名称设置元素属性值;在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_set_class_name替换元素 class 名称字符串;在主线程调用。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_set_inner_html用 HTML 源替换元素 innerHTML;在主线程修改 DOM。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_set_scroll_position设置元素的绝对滚动位置 left/top;在主线程调用。
kui_element_set_style_property在主线程设置元素的一条内联 style 声明;important 非零表示 !important。此处修改元素自己的声明。
kui_element_set_style_text在主线程用 CSS 文本设置元素的完整内联 style 声明。
kui_element_set_text_content设置元素 textContent;在主线程修改 DOM。 输入字符串采用 UTF-8 和显式字节长度;长度 0 表示 strlen,必填名称、选择器、路径及源码不可为 NULL。
kui_element_style_property_is_important检查元素指定内联声明是否带 !important,并通过整数输出结果。
kui_event_drag_get_file按索引读取拖放文件路径;非拖放事件或没有 DataTransfer 时返回 NOT_SUPPORTED,越界返回 NOT_FOUND。须在事件回调结束前复制需要的信息。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_event_drag_get_file_count读取拖放事件 DataTransfer 中的文件数量;非拖放事件或没有 DataTransfer 时返回 NOT_SUPPORTED。事件仅在回调中借用。
kui_event_get_current_target取得事件当前派发目标元素的计数引用,使用后须 release。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_get_flags读取事件的 bubbles、cancelable 和 defaultPrevented 标记。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_get_target取得事件目标元素的计数引用,使用后须 release;若目标是文本等非元素节点,返回 NOT_FOUND。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_get_type读取当前事件类型名称。 输出为调用者缓冲区中的 UTF-8:可先以 NULL/0 查询长度,再分配 out_len+1;长度不含 NUL。容量不足返回 BUFFER_TOO_SMALL 并报告所需长度;容量大于 0 时仍写入 NUL 结尾的截断结果。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_get_type_tag读取借用事件的运行时类型标签,区分基础、鼠标、滚轮、指针、键盘、焦点、输入和拖放。仅在回调有效期内访问事件。
kui_event_key_get_code读取键盘事件的物理键代码,如 KeyA;非键盘事件返回 KUI_ERR_NOT_SUPPORTED。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。 事件仅在回调内借用,不可保存或释放。
kui_event_key_get_key读取键盘事件的语义按键名,如 a、Enter、ArrowUp;非键盘事件返回 KUI_ERR_NOT_SUPPORTED。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。 事件仅在回调内借用,不可保存或释放。
kui_event_key_get_modifiers读取键盘事件的 Ctrl、Shift、Alt、Meta 状态;不关心的输出可传 NULL。非键盘事件返回 KUI_ERR_NOT_SUPPORTED。 事件仅在回调内借用,不可保存或释放。
kui_event_mouse_get_button读取鼠标事件的按键枚举值 KuiCMouseButton;非鼠标事件返回 KUI_ERR_NOT_SUPPORTED。事件仅在当前回调中有效,不可保存或释放。
kui_event_mouse_get_client_xy读取鼠标事件的视口相对 client 坐标;非鼠标事件返回 NOT_SUPPORTED。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_mouse_get_offset_xy读取鼠标事件相对目标 padding box 的 offset 坐标;非鼠标事件返回 NOT_SUPPORTED。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_mouse_get_page_xy读取鼠标事件的 page 坐标,包含滚动偏移;非鼠标事件返回 NOT_SUPPORTED。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_prevent_default在当前事件回调中阻止默认行为。 evt 仅在当前回调期间有效,不可保存或释放。
kui_event_stop_propagation在当前事件回调中停止后续传播。 evt 仅在当前回调期间有效,不可保存或释放。
kui_extension_result_get_count读取扩展调用实际返回值的数量,用于按索引访问结果。
kui_extension_result_get_error读取扩展调用结果中的错误文本。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_extension_result_get_status读取扩展方法调用自身的状态码;它与获取结果接口返回的 KuiStatus 是不同层次。
kui_extension_result_get_string按索引复制扩展字符串结果;索引越界返回 NOT_FOUND,结果不是字符串则返回 NOT_SUPPORTED。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_extension_result_get_value按索引读取扩展结果的类型和标量字段;越界返回 NOT_FOUND。字符串只报告 string_len,string_value 被置 NULL,正文须用 get_string 复制。
kui_extension_result_release释放扩展调用结果句柄,仅释放一次;需要的值和错误文本应在释放前读取。
kui_get_version读取已加载动态库的运行时版本,可能与编译时版本宏不同。
kui_http_client_cancel_all取消该客户端所有尚未完成的异步请求。
kui_http_client_create创建 HTTP 客户端句柄,用于同步或异步请求;使用后由 kui_http_client_release 释放。
kui_http_client_fetch_async异步请求 URL 并在完成时回调;回调可能运行在工作线程,不能直接修改 DOM。回调取得响应所有权并负责 release;分配失败时响应可为 NULL,回调不得抛异常。
kui_http_client_fetch_sync同步请求 URL,阻塞至完成或超时;返回的响应句柄须单独 release。KUI_OK 仅说明调用完成,HTTP 状态和网络错误要从响应读取。
kui_http_client_release释放并销毁 HTTP 客户端句柄;仅释放一次,不可在释放后继续发起请求。
kui_http_client_set_user_agent设置该 HTTP 客户端的 User-Agent 请求标识;输入 UTF-8 指针必须非 NULL,len 为零时按 NUL 结尾读取。
kui_http_response_get_body复制响应正文原始字节,可含 NUL;先查询所需字节数,再分配 need+1 的缓冲,当前桥接还写入结束 NUL,正文长度不含这个结束符。
kui_http_response_get_content_type读取 HTTP 响应的 Content-Type 字符串。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_http_response_get_error读取 HTTP 响应的网络错误说明字符串,供调用方判断和显示请求失败原因。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_http_response_get_status读取 HTTP 响应状态码;网络传输错误还应另查错误文本。
kui_http_response_release释放 HTTP 响应句柄;同步请求返回的响应和异步回调获得的响应均由调用方负责释放一次。
kui_lottie_get_complete查询 Lottie 资源是否加载完成,以 0/1 输出;此处 complete 检查 LoadState::Complete,不是动画播完标志。非 Lottie 元素返回 NOT_SUPPORTED。
kui_lottie_get_natural_size读取 Lottie 动画自然宽高;可省略一个输出,但不能全部为 NULL。非 Lottie 元素返回 NOT_SUPPORTED。
kui_lottie_pause在主线程暂停 Lottie 元素动画;非 Lottie 元素返回 NOT_SUPPORTED。
kui_lottie_play在主线程请求 Lottie 元素播放;非 Lottie 元素返回 NOT_SUPPORTED。
kui_lottie_set_src在主线程设置 Lottie 元素资源地址;src 必须非 NULL,非 Lottie 元素返回 NOT_SUPPORTED。
kui_media_get_current_time读取媒体元素当前播放时间,单位为秒;非媒体元素返回 NOT_SUPPORTED。
kui_media_get_duration读取媒体资源时长,单位为秒;非媒体元素返回 NOT_SUPPORTED。
kui_media_get_muted读取媒体元素是否静音,以 0/1 输出;非媒体元素返回 NOT_SUPPORTED。
kui_media_get_network_state读取媒体元素网络状态的整数枚举值;非媒体元素返回 NOT_SUPPORTED。
kui_media_get_paused读取媒体元素是否暂停,以 0/1 输出;非媒体元素返回 NOT_SUPPORTED。
kui_media_get_ready_state读取媒体元素就绪状态的整数枚举值;非媒体元素返回 NOT_SUPPORTED。
kui_media_get_volume读取媒体元素当前音量;非媒体元素返回 NOT_SUPPORTED。
kui_media_is_available查询媒体元素的媒体能力是否可用,以 0/1 输出;非媒体元素返回 NOT_SUPPORTED,不等同于资源已播放成功。
kui_media_pause在主线程暂停媒体元素;非媒体元素返回 NOT_SUPPORTED。
kui_media_play在主线程请求媒体元素播放;传入非媒体元素返回 NOT_SUPPORTED,实际播放还依赖媒体后端与资源状态。
kui_media_set_controls在主线程设置媒体元素是否显示播放控件;enabled 非零表示开启,非媒体元素返回 NOT_SUPPORTED。
kui_media_set_current_time在主线程按秒设置媒体元素播放位置;非媒体元素返回 NOT_SUPPORTED。
kui_media_set_muted在主线程设置媒体元素静音状态;muted 非零表示静音,非媒体元素返回 NOT_SUPPORTED。
kui_media_set_src在主线程设置媒体元素的资源地址;src 必须非 NULL,非媒体元素返回 NOT_SUPPORTED。
kui_media_set_volume在主线程设置媒体元素音量;非媒体元素返回 NOT_SUPPORTED。取值行为由媒体元素实现决定。
kui_platform_clear_timer按计时器 ID 清除等待中的超时或间隔任务。
kui_platform_get_clipboard_text复制系统剪贴板中的文本到调用方缓冲。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_platform_get_monitor按索引读取显示器边界、工作区、缩放比例及是否主屏;名称写入调用方 UTF-8 缓冲。索引不存在返回 NOT_FOUND。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_platform_get_monitor_count读取当前显示器数量,为后续按索引查询显示器信息提供范围。
kui_platform_get_os_name读取当前操作系统名称,复制到调用方缓冲。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_platform_get_os_version读取当前操作系统版本字符串,复制到调用方缓冲。 输出 UTF-8 可先以 NULL/0 查询长度,再分配 need+1;长度不含结束 NUL,缓冲不足返回 BUFFER_TOO_SMALL 并报告完整所需长度。
kui_platform_get_primary_monitor读取主显示器的边界、工作区、缩放比例及主屏标记。
kui_platform_get_primary_monitor_physical_size读取主显示器的物理尺寸;宽、高可只取一项,但不能两个输出都为 NULL。
kui_platform_has_clipboard_text检查系统剪贴板当前是否含文本,以整数输出结果。
kui_platform_init初始化进程级平台服务;应在创建 GUI 窗口和运行事件循环前调用。
kui_platform_open_file_dialog打开文件选择对话框,支持标题、默认路径、过滤器与多选选项。必须一次提供有效输出缓冲,Windows 建议 32768 字节;取消返回 NOT_FOUND,不能先空缓冲探测再打开。
kui_platform_poll_events立即处理当前待办事件后返回,用于宿主拥有自己事件循环的嵌入场景。
kui_platform_quit请求平台事件循环退出,并指定退出码。
kui_platform_request_idle安排下一次事件循环空闲时执行一次回调;在主线程执行,user_data 不由 KUI 释放。
kui_platform_run阻塞运行平台事件循环,直到请求退出,并输出退出码。
kui_platform_save_file_dialog打开保存文件对话框并返回选定路径。必须一次提供有效输出缓冲,Windows 建议 32768 字节;取消返回 NOT_FOUND,输出路径不会自动保存文件内容。
kui_platform_select_folder_dialog打开带标题的文件夹选择对话框并复制路径。需一次提供有效缓冲,Windows 建议 32768 字节;取消返回 NOT_FOUND。
kui_platform_set_clipboard_text将 UTF-8 文本写入系统剪贴板;text 必须非 NULL,len 为零时按 NUL 结尾读取。
kui_platform_set_f12_devtools_enabled启用或禁用 F12 打开 DevTools 的平台行为。
kui_platform_set_interval按毫秒间隔安排重复回调并返回计时器 ID;须显式清除。回调仅在事件循环活跃时于主线程执行;user_data 由调用者管理,至少活到计时器清除。