构造游离原生元素,或包装内部原生句柄。
tagOrHandle原生标签,与具体原生类型相互独立。
attributes自有初始值;默认为空字典。
读取 GetAbsoluteLeft,单位为上下文像素。
相对上下文的水平偏移。
读取 GetAbsoluteTop,单位为上下文像素。
相对上下文的垂直偏移。
读取 GetBaseline:从下外边距边缘向上的像素偏移。
基线向上偏移,单位为像素。
读取 GetClientHeight:内边距区域高度减去水平滚动条。
客户区高度,单位为像素。
读取 GetClientLeft,即左边框宽度。
左边框宽度。
读取 GetClientTop,即顶部边框宽度。
顶部边框宽度。
读取 GetClientWidth:内边距区域宽度减去垂直滚动条。
客户区宽度,单位为像素。
元素 id。
元素 id;未设置时为空字符串。
通过 Rml::Element::SetId 设置元素 id。
id新元素 id。
内部 RML 标记。
内部标记字符串。
通过 Rml::Element::SetInnerRML 替换子元素标记。
rml新标记;现有子元素包装器随之失效。
读取 GetOffsetHeight:包含内容、内边距和边框,不包含外边距。
边框区域高度,单位为像素。
读取 GetOffsetLeft:相对偏移父元素的左边框偏移。
边框的水平偏移。
读取 GetOffsetTop:相对偏移父元素的顶部边框偏移。
边框的垂直偏移。
读取 GetOffsetWidth:包含内容、内边距和边框,不包含外边距。
边框区域宽度,单位为像素。
读取 GetScrollHeight,包含内边距和可滚动内容。
可滚动高度,单位为像素。
原生 GetScrollLeft/SetScrollLeft,保留取整与范围限制。 偏移变化时同步派发 scroll 事件。
水平滚动偏移。
通过 Rml::Element::SetScrollLeft 设置水平滚动偏移。
value水平像素偏移,由 RmlUi 限制范围。
原生 GetScrollTop/SetScrollTop,保留取整与范围限制。 偏移变化时同步派发 scroll 事件。
垂直滚动偏移。
通过 Rml::Element::SetScrollTop 设置垂直滚动偏移。
value垂直像素偏移,由 RmlUi 限制范围。
读取 GetScrollWidth,包含内边距和可滚动内容。
可滚动宽度,单位为像素。
文档的来源 URL。
原生源 URL,在解析 head 时记录。没有 head 时为空;内存加载未传 sourceUrl
且包含 head 时使用 "[document from memory]"。
元素标签名。
标签名。
文档标题。
当前标题。
通过 Rml::ElementDocument::SetTitle 设置文档标题。
title新标题,不修改 SFML 窗口标题。
读取原生 GetZIndex 的结果。
原生 z-index。
通过 Rml::Element::AddAnimationKey 追加关键帧副本。
property原生属性名或 ID。
target有类型的目标值。
duration新增的非负持续秒数。
tween可选缓动,默认原生 Linear/Out。
原生成功结果;没有现有动画时返回 false。
挂载事件监听器。
type事件名称或已注册的原生 EventId。
listener同步回调,可在不同注册项之间复用。
capture是否在捕获阶段监听,默认为 false。
按属性名或 ID 调用 Rml::Element::Animate,启动或替换动画。
property原生属性名或 ID。
target有类型的目标值,由 RmlUi 复制。
duration非负持续时间,单位秒。
tween可选缓动,默认原生 Linear/Out。
iterations迭代次数,默认 1;-1 无限重复。
alternate每隔一次迭代反向,默认 true。
delay延迟秒数,默认零。
start起始值副本;null 使用当前属性值。
原生成功结果;未知或不支持的属性返回 false。
使用 ArePseudoClassesSet 检查全部伪类。
names待检查名称;空列表返回 true。
是否全部启用。
通过 Rml::Element::Blur 释放焦点。
通过 Rml::Element::Click 模拟点击。
通过 Rml::Element::Closest 查找匹配的祖先,不包含自身。
selectorRCSS 选择器。
首个匹配祖先,不包含自身,不存在时为 null。
通过 Rml::Element::Contains 检查包含关系,包含自身。
element待检查节点或 null。
自身或后代返回 true,null 或无关节点返回 false。
通过 Rml::ElementDocument::CreateElement 创建脱离文档的原生节点。
name原生元素标签名。
持有所有权的脱离节点;工厂失败时为 null。
通过 Rml::ElementDocument::CreateTextNode 创建脱离文档的文本节点。
text字面文本,支持 Unicode 和标记字符。
持有所有权的脱离文本节点;工厂失败时为 null。
通过 Rml::Element::DispatchEvent 派发事件,允许嵌套派发。
type事件名称或已注册的原生 EventId。
parameters原生 Variant 参数,默认为空。
options可选省略时使用上游事件定义的默认值。
事件是否仍可传播。
通过 Rml::Element::Focus 请求焦点。
focusVisible激活 focus-visible 反馈,默认 false。
原生焦点请求是否成功。
复制 GetAbsoluteOffset,坐标相对元素根节点。
area具体盒区域,默认为 Content,不接受 Auto。
独立的像素坐标。
复制 GetActivePseudoClasses 的结果。
按原生顺序排列的独立快照。
使用 GetAddress 格式化地址,从当前叶节点指向父节点。
includePseudoClasses是否包含伪类,默认 false。
includeParents是否包含祖先地址,默认 true。
原生地址字符串,不是 CSS 选择器。
以字符串读取属性。
name属性名。
属性值;不存在时为 null。
按默认值的原生类型读取 GetAttribute
由默认值选择的原生转换类型。
name属性名。
defaultValue非空回退值,其类型决定原生转换方式。
原生转换结果,以回退值初始化。
复制 GetAttribute 返回的原始 Rml::Variant。
name属性名。
值快照;属性不存在或原生类型为 NONE 时返回 null。
复制 Rml::Element::GetBox(index, offset),包含输出偏移。
index盒索引;越界时返回主盒及零偏移。INT32_MIN 会被拒绝, 避免上游有符号溢出。
独立持有的盒及偏移。
返回 Rml::Element::GetChild,支持原生非 DOM 节点索引。
index从零开始的 int32 索引。
子节点,越界时为 null。
读取 GetClassNames,返回空格分隔的类名字符串。
原生类名列表。
读取 GetClosestScrollableContainer,查找范围包含当前元素。
最近的原生滚动容器;不存在时返回 null。
实时只读的 Rml::Element::GetComputedValues。
有效性受检查的视图;检查布局前调用 context.update()。
通过受检查的原生模型索引读取 Rml::Element::GetDataModel。
唯一的数据模型构造器包装;未绑定模型时为 null。
在所属文档中按 id 查找元素。
id元素 id。
匹配的元素;不存在时为 null。
广度优先搜索整个所属文档,包括兄弟元素;没有所属文档时从当前元素开始。
RmlUi 还接受 #self、#document、#parent。
仅搜索后代时使用 querySelector。
复制 Rml::Element::GetEventDispatcherSummary 的调试摘要。
原生事件类型和监听器数量;没有监听器时为空字符串。
从计算样式读取原生 GetLineHeight。
计算后的像素行高。
复制 GetLocalProperty,包含 RCSS 规则,不含继承值,且不解析变量。
name属性名或原生编号。
自有局部属性或 null。
获取元素的属性键数量。
原生属性键数量。
获取主布局盒和附加布局盒的总数。
主盒及附加盒的总数。
通过 Rml::Element::GetNumChildren 统计子节点。
includeNonDomElements包含内部子节点,默认为 false。
原生子节点数。
将 Rml::Element::GetProperty 结果复制为自有属性。
name属性名或原生编号。
自有属性;不存在时返回 null。
使用原生类型样本读取 Rml::Element::GetProperty
由样本选择的原生转换类型。
name属性名。
type原生转换类型样本。
转换值或原生类型的默认值。
复制 GetRelativeOffset,坐标相对偏移父元素的边框左上角。
area具体盒区域,默认为 Content,不接受 Auto。
独立的像素坐标。
调用原生 GetScriptObject;未注册实例返回 null。
已注册的脚本对象或 null。
读取 Rml::Element::GetStyleSheet,包含文档的重写实现。
只读编译视图;没有可用样式表时为 null。
保留 Rml::ElementDocument::GetStyleSheetContainer 的原生容器。
只读容器或 null;文档销毁后仍可使用。
获取元素计算变换状态的只读视图。
原生只读视图;不存在状态时返回 null。
查询 HasAttribute,包括值为 NONE 的属性。
name属性名。
键是否存在。
通过 Rml::Element::HasChildNodes 检查 DOM 子节点。
是否存在至少一个 DOM 子节点。
隐藏文档但不关闭。
通过 Rml::Element::IsClass 检查原生继承关系。
identifier从本模块 RTTI 方法取得的令牌。
此元素是否属于指定原生类或其子类。
返回 class 是否存在。
className类名。
class 存在时为 true。
查询此可见文档是否具有模态标志。
模态标志已设置且文档可见时返回 true;隐藏时返回 false。
调用原生 IsPointWithinElement 检测边框区域。 变换后的屏幕坐标应先调用 project。
point元素平面上的上下文像素坐标。
原生边框区域是否包含坐标。
查询 IsPseudoClassSet。
name伪类名。
伪类是否启用。
调用原生 IsReplaced,判断元素是否自行渲染。
是否为替换元素。
调用原生 IsVisible,可选择同时检查祖先。
includeAncestors同时检查祖先,默认 false。
原生可见性结果。
通过捕获的宿主执行 Rml::ElementDocument::LoadExternalScript。
sourcePath解析后的 RmlUi FileInterface 路径。
通过 Rml::Element::Matches 检查当前元素。
selectorRCSS 选择器。
当前元素是否匹配。
使用活事件调用虚方法 Rml::Element::ProcessDefaultAction。
event此元素当前执行中的监听器收到的事件。
使用原生文档头快照执行 Rml::ElementDocument::ProcessHeader。
header待处理的原生资源及元信息存储。
调用原生 Project,不修改传入坐标。 原生变换在渲染时刷新,修改变换后应先渲染再查询投影。
point以上下文像素计量的窗口坐标。
原生成功标志和投影坐标快照。
通过 Rml::ElementDocument::PullToFront 移至文档栈顶部。
通过 Rml::ElementDocument::PushToBack 移至文档栈底部。
通过 Rml::Element::QuerySelectorAll 获取后代快照。
selectorRCSS 选择器。
按原生深度优先顺序排列的实时包装器数组;数组成员不随树变动。
移除属性。
name属性名。
移除此前挂载的事件监听器。
type事件名称或已注册的原生 EventId。
listener挂载时使用的同一个回调引用。
capture挂载时使用的捕获阶段标志,默认为 false。
移除局部 CSS 覆盖值,对应 Rml::Element::RemoveProperty。
name原生编号或名称,支持 --accent 等自定义变量。
在元素当前样式和上下文中调用 Rml::Element::ResolveLength。
value原生数值;非长度单位返回零。
像素长度;字段无效或溢出时抛出异常。
使用原生单位转换调用 Rml::Element::ResolveNumericValue。
value数值。NUMBER 乘以基数,PERCENT 按 number / 100 缩放基数; 角度返回弧度,非数值单位返回零。
baseValueNUMBER 和 PERCENT 使用的有限基数。
原生解析结果;字段无效或溢出时抛出异常。
调用原生 ScrollIntoView 的布尔或选项重载。
options默认与顶部对齐,也可传入原生选项。
调用原生 ScrollTo;Smooth 和 Auto 需要持续更新上下文。
offset请求的像素滚动偏移。
behavior默认为 Instant。
通过 SetAttributes 合并属性。
attributes属性拥有的值;全部转换完成后才修改原生状态。
添加或移除一个 class。
className类名。
activate为 true 时添加,为 false 时移除。
通过 SetClassNames 替换全部类名。
names以空格分隔的原生类名。
通过 Rml::Element::SetOffset 设置原生布局基准偏移。
offset有限像素坐标;遵循原生 position 规则。
offsetParent严格祖先;null 使用独立基准。
offsetFixed忽略祖先滚动,默认 false。
通过 Rml::Element::SetProperty 设置局部 RCSS 属性。
nameRCSS 文本使用属性名,类型化值使用 PropertyId。
valueRCSS 文本或按值复制的原生 Property。
属性是否成功应用。
通过 Rml::Element::SetProperty 设置局部 RCSS 属性。
nameRCSS 文本使用属性名,类型化值使用 PropertyId。
valueRCSS 文本或按值复制的原生 Property。
属性是否成功应用。
通过 SetPseudoClass 设置原生伪类。
name不含冒号的伪类名。
active是否启用。
调用原生 SetScrollableOverflowRectangle。
size有限且非负的像素尺寸。
clampScrollOffset最终溢出尺寸确定后限制滚动范围。
调用 Rml::ElementDocument::SetStyleSheetContainer。
container共享原生容器;null 清除全部样式表规则。
显示文档。
modal原生 ModalFlag;false/true 对应 None/Modal,默认 None。
focus原生 FocusFlag,默认 Auto。
scroll原生 ScrollFlag,默认 Auto。
静态get读取此包装类对应的原生 GetStaticClassIdentifier。
不透明类型令牌,运行时初始化前也可获取。
已加载的 RmlUi 文档包装器。