Construct a detached native element, or wrap an internal native handle.
tagOrHandleNative tag, independent of the concrete native class.
attributesOwned initial values; defaults to an empty dictionary.
Read Rml::Element::GetAbsoluteLeft in context pixels.
The horizontal context offset.
Read Rml::Element::GetAbsoluteTop in context pixels.
The vertical context offset.
Read GetBaseline: upward pixel offset from the bottom margin edge.
The upward baseline offset in pixels.
Read GetClientHeight: padding height minus the horizontal scrollbar.
The client height in pixels.
Read Rml::Element::GetClientLeft (left border width).
The left border width.
Read Rml::Element::GetClientTop (top border width).
The top border width.
Read GetClientWidth: padding width minus the vertical scrollbar.
The client width in pixels.
Native GetClipArea/SetClipArea; Auto selects automatic clipping.
The clipping area.
Set the box area used for clipping.
areaNative clip box area.
Element id.
Element id, empty when unset.
Set the element id through Rml::Element::SetId.
idNew element id.
Inner RML markup.
Inner markup string.
Replace child markup through Rml::Element::SetInnerRML.
rmlNew markup; existing child wrappers become invalid.
Read GetOffsetHeight: content, padding and borders, excluding margins.
The border height in pixels.
Read GetOffsetLeft: border offset relative to the offset parent.
The horizontal border offset.
Read GetOffsetParent; null when no native offset parent exists.
The live offset parent or null.
Read GetOffsetTop: border offset relative to the offset parent.
The vertical border offset.
Read GetOffsetWidth: content, padding and borders, excluding margins.
The border width in pixels.
Read GetScrollHeight, including padding and scrollable content.
The scrollable height in pixels.
Native GetScrollLeft/SetScrollLeft with native rounding and clamping. Changing the offset synchronously dispatches a scroll event.
The horizontal scroll offset.
Set the horizontal scroll offset through Rml::Element::SetScrollLeft.
valueHorizontal offset in pixels, clamped by RmlUi.
Native GetScrollTop/SetScrollTop with native rounding and clamping. Changing the offset synchronously dispatches a scroll event.
The vertical scroll offset.
Set the vertical scroll offset through Rml::Element::SetScrollTop.
valueVertical offset in pixels, clamped by RmlUi.
Read GetScrollWidth, including padding and scrollable content.
The scrollable width in pixels.
Tag name of the element.
Tag name.
Read the native GetZIndex result.
The native z-index.
Append a copied key with Rml::Element::AddAnimationKey.
propertyNative property name or id.
targetTyped target value.
durationAdditional nonnegative duration in seconds.
tweenOptionalEasing; defaults to native Linear/Out.
Native success, including false when no animation exists.
Copy an additional box into Rml::Element::AddBox.
boxFinite box value.
offsetFinite offset from the main box.
Attach an event listener.
typeEvent name or registered native EventId.
listenerSynchronous callback, shareable between registrations.
captureListen in capture phase; defaults to false.
Identical element/type/callback/capture registrations are idempotent. Removing the registration or destroying the element releases its callback. Listeners may remove themselves or other listeners during dispatch. Exceptions propagate from the native entry that dispatched the event. Classes, styles, target-local ordinary attributes, titles and unrelated subtrees may change synchronously. Removing active event targets or native call receivers is rejected, as are teardown and recursive update/input. Attribute set/removal also rejects ancestors of active targets. Setting or removing an active input's type is rejected to protect its widget. Schedule those operations after dispatch, for example with queueMicrotask.
Start or replace Rml::Element::Animate for a property name or id.
propertyNative property name or id.
targetTyped target value, copied by RmlUi.
durationNonnegative duration in seconds.
tweenOptionalEasing; defaults to native Linear/Out.
iterationsIteration count; defaults to 1; -1 repeats forever.
alternateReverse every second iteration; defaults to true.
delayDelay in seconds; defaults to zero.
startCopied start value; null uses the current property value.
Native success; false for unknown or unsupported properties.
Transfer a detached child through Rml::Element::AppendChild.
childOwned detached node; remove an attached node first.
domElementInclude in DOM traversal; defaults to true.
The same child wrapper.
Rejects cycles, context roots and active native/event subtrees. Documents retain their context and can move only within that live context. A context root accepts only its own documents as DOM children. Ownership transfers once; listeners survive detaching and reinsertion. Native widget internals are readable but cannot be removed or replaced; non-DOM children inserted through these APIs remain transferable.
Query Rml::Element::ArePseudoClassesSet for every name.
namesNames to check; an empty list returns true.
Whether all names are active.
Release focus through Rml::Element::Blur.
Simulate a click through Rml::Element::Click.
Clone attributes, styles and content through Rml::Element::Clone.
Owned detached clone, or null on factory failure; no JS listeners.
Find a matching ancestor through Rml::Element::Closest.
selectorRCSS selector.
First matching ancestor, excluding this element, or null.
Test ancestry through Rml::Element::Contains, including this element.
elementCandidate node, or null.
True for self or descendants, false for null or unrelated nodes.
Dispatch through Rml::Element::DispatchEvent, allowing nested dispatch.
typeEvent name or registered native EventId.
parametersTyped native Variant values; defaults to empty.
optionsOptionalOmit to use the upstream event specification defaults.
Whether the event remains propagating.
Request focus through Rml::Element::Focus.
focusVisibleActivate focus-visible feedback; default false.
Whether the native focus request succeeded.
Copy GetAbsoluteOffset relative to the element root.
areaConcrete box area; defaults to Content, not Auto.
An independent pixel coordinate.
Copy Rml::Element::GetActivePseudoClasses.
Independent snapshot in native order.
Format Rml::Element::GetAddress, from this leaf toward its parents.
includePseudoClassesInclude pseudo-classes; defaults to false.
includeParentsInclude ancestor addresses; defaults to true.
Native address string, not a CSS selector.
Read an attribute as a string.
nameAttribute name.
Attribute value or null when absent.
Read Rml::Element::GetAttribute
Native conversion type selected by the default value.
nameAttribute name.
defaultValueNon-null fallback, selecting native conversion.
Native converted value, initialized with the fallback.
Copy all values from Rml::Element::GetAttributes.
Independent snapshot with own data properties.
Copy the raw Rml::Variant returned by Rml::Element::GetAttribute.
nameAttribute name.
Copied value; null for an absent attribute or native NONE.
Copy the main Rml::Element::GetBox into independent native storage.
Writable box snapshot; apply changes with setBox.
Copy Rml::Element::GetBox(index, offset), including its output offset.
indexBox index; out of range returns the main box and zero offset. INT32_MIN is rejected to avoid upstream signed overflow.
Independently owned box and offset.
Return Rml::Element::GetChild, including native non-DOM indices.
indexZero-based int32 index.
Child, or null outside the native child range.
Read the actual native Rml::Element::GetClassIdentifier.
Opaque token independent of the element tag and JS prototype.
Read Rml::Element::GetClassNames as a space-separated string.
Native class list.
Read Rml::Element::GetClosestScrollableContainer, including this element.
Nearest native scroll container or null.
Live read-only Rml::Element::GetComputedValues.
Checked view; call context.update() before inspecting layout.
Copy Rml::Element::GetContainingBlock in pixels.
The native containing block dimensions.
Read Rml::Element::GetContext through the owning document.
Canonical context; detached documents and their descendants retain it. Other detached elements and context roots return null.
Read Rml::Element::GetDataModel through the checked native model index.
Canonical model constructor facade or null when unbound.
Read native GetDisplay from the computed values.
The display mode.
Read Rml::Element::GetElementBackgroundBorder as a checked component.
Canonical element-owned background and border component.
Find an element by id in the owning document.
idElement id.
Matching element or null.
Searches the whole owning document breadth first, including siblings.
Without an owner, searches from this element. Special tokens are #self,
#document and #parent.
Use querySelector for descendant searches.
Snapshot descendants through Rml::Element::GetElementsByClassName.
nameClass name.
Snapshot array containing live wrappers.
Snapshot descendants through Rml::Element::GetElementsByTagName.
tagNative tag name.
Snapshot array containing live wrappers.
Read Rml::Element::GetElementScroll as a checked native component.
Element-owned scroll component with canonical wrapper identity.
Read Rml::Element::GetEventDispatcher as a checked component.
Canonical element-owned native dispatcher.
Copy Rml::Element::GetEventDispatcherSummary for debugging.
Native event types and listener counts; empty when none exist.
Return Rml::Element::GetFirstChild.
First DOM child, or null.
Read native GetFloat from the computed values.
The float mode.
Get the deepest focused descendant, or this element if no child has focus.
Deepest focus descendant, or this element if no child has focus.
Rml::Element::GetFontFaceHandle as an opaque native token.
Font face token, or null when no face is selected.
Query the native virtual Rml::Element::GetIntrinsicDimensions.
Success, intrinsic size and ratio; unused outputs are zero.
Return Rml::Element::GetLastChild.
Last DOM child, or null.
Read native GetLineHeight from the computed values.
The computed line height in pixels.
Copy GetLocalProperty, including RCSS rules but excluding inherited values.
nameProperty name or native id.
Owned local property or null.
Snapshot GetLocalStyleProperties, excluding classes and custom variables.
Map of native ids to owned property copies.
Return Rml::Element::GetNextSibling.
Next DOM sibling, or null.
Get the number of attribute keys on the element.
Number of native attribute keys.
Get the total number of main and additional layout boxes.
Main box plus additional boxes.
Count children through Rml::Element::GetNumChildren.
includeNonDomElementsInclude internal children; default false.
Native child count.
Return Rml::Element::GetParentNode.
Parent, or null while detached.
Read native GetPosition from the computed values.
The positioning mode.
Return Rml::Element::GetPreviousSibling.
Previous DOM sibling, or null.
Copy Rml::Element::GetProperty into an owned property.
nameProperty name or native id.
Owned property or null when absent.
Read Rml::Element::GetProperty
Native conversion type selected by the exemplar.
nameProperty name.
typeNative conversion type exemplar.
Converted value or the native type's default value.
Copy GetRelativeOffset relative to the offset parent's border corner.
areaConcrete box area; defaults to Content, not Auto.
An independent pixel coordinate.
Get the render manager associated with this element.
Borrowed manager or null when no native manager is available.
Call native GetScriptObject; unregistered instances return null.
Registered script object or null.
Read the actual element-owned Rml::ElementStyle.
Canonical checked native style component.
Read Rml::Element::GetStyleSheet, including the document override.
Read-only compiled view, or null when no stylesheet is available.
Get a read-only view of the element’s computed transform state.
Read-only native view, or null if no state exists.
Query Rml::Element::HasAttribute, including attributes holding NONE.
nameAttribute name.
Whether the key exists.
Check DOM children through Rml::Element::HasChildNodes.
Whether at least one DOM child exists.
Transfer a detached child through Rml::Element::InsertBefore.
childDetached node, subject to appendChild ownership checks.
adjacentReference child; null or a non-child appends to the DOM.
Same child, inheriting the reference child's DOM/non-DOM status.
Test native inheritance through Rml::Element::IsClass.
identifierToken obtained from this module's RTTI methods.
Whether this element has the given native class or a subclass.
Return whether a class is set.
classNameClass name.
True when the class is present.
Call native IsPointWithinElement against the element border. Project transformed screen points with project first.
pointPoint in context pixels on the element plane.
Whether the native border area contains the point.
Query Rml::Element::IsPseudoClassSet.
namePseudo-class name.
Whether the pseudo-class is active.
Call native IsReplaced for elements handling their own rendering.
Whether this is a replaced element.
Call native IsVisible, optionally checking ancestors.
includeAncestorsAlso test ancestors; defaults to false.
The native visibility result.
Snapshot Rml::Element::IterateLocalProperties in one native traversal.
filterInheritedByKeep only properties inherited by this element.
Native-order name/property pairs with independent owned values.
Test this element through Rml::Element::Matches.
selectorRCSS selector.
Whether this element matches.
Invoke virtual Rml::Element::ProcessDefaultAction with a live event.
eventEvent from this element's currently executing listener.
The receiver must equal event.currentTarget. Preserves phase, parameters and propagation state; even a stopped event runs its action. This does not cancel the later automatic action. Use stopPropagation on an interruptible event if it should run only manually. Sequential calls repeat native side effects; reentry with the same event during a manual action is rejected.
Call native Project without modifying the supplied point. Native transforms refresh during rendering; render after changing them before querying their projection.
pointWindow coordinate in context pixels.
The native success flag and copied projected coordinate.
Find the first matching descendant in native depth-first order.
selectorCSS selector.
Matching element or null.
Snapshot descendants through Rml::Element::QuerySelectorAll.
selectorRCSS selector.
Stable array of live wrappers in native depth-first order.
Remove an attribute.
nameAttribute name.
Detach a previously attached event listener.
typeEvent name or registered native EventId.
listenerSame callback reference used when attaching.
captureSame capture flag used when attaching; defaults to false.
Remove a local CSS override (Rml::Element::RemoveProperty).
nameNative id or name, including variables like --accent.
Transfer ownership through Rml::Element::ReplaceChild.
childDetached replacement, subject to appendChild checks.
replacedExisting child; null or a non-child appends instead.
Detached replaced node with ownership, or null when appended.
Rml::Element::ResolveLength in the element's current style and context.
valueNative numeric value; non-length units return zero.
Length in pixels; invalid fields or overflow throw.
Rml::Element::ResolveNumericValue with native unit conversion.
valueNumeric value. NUMBER multiplies the base; PERCENT scales it by number / 100; angles return radians; non-numeric units return zero.
baseValueFinite base for NUMBER and PERCENT.
Resolved native value; invalid fields or overflow throw.
Call either native ScrollIntoView overload.
optionsAlign with the top by default, or supply native options.
Call native ScrollTo. Smooth and Auto require regular context updates.
offsetRequested scroll offset in pixels.
behaviorDefaults to Instant.
Set an attribute value.
nameAttribute name.
valueOwned Variant value; null stores native NONE.
Merge attributes through Rml::Element::SetAttributes.
attributesOwned values, fully converted before native mutation.
Copy a value into Rml::Element::SetBox, clearing additional boxes.
boxFinite box value; later changes do not affect this element.
Add or remove a class.
classNameClass name.
activateTrue adds, false removes.
Replace all classes with Rml::Element::SetClassNames.
namesSpace-separated native class names.
Set the native layout base through Rml::Element::SetOffset.
offsetFinite pixel coordinates; native position rules apply.
offsetParentStrict ancestor or null for an independent base.
offsetFixedIgnore ancestor scrolling; defaults to false.
Set a local RCSS property through Rml::Element::SetProperty.
nameProperty name for RCSS text, or PropertyId for a typed value.
valueRCSS text or a native Property copied by value.
Whether the property was applied.
Set a local RCSS property through Rml::Element::SetProperty.
nameProperty name for RCSS text, or PropertyId for a typed value.
valueRCSS text or a native Property copied by value.
Whether the property was applied.
Set a native pseudo-class through Rml::Element::SetPseudoClass.
namePseudo-class name without a colon.
activeWhether to activate it.
Register a managed native script object, preserving DOM ownership.
objectHost object, or null to clear the association.
Call native SetScrollableOverflowRectangle.
sizeFinite nonnegative dimensions in pixels.
clampScrollOffsetClamp after the final overflow size is known.
Submit through Rml::ElementForm::Submit; dispatches a submit event.
nameSubmitter name; empty uses the key "submit". Default "".
valueSubmitter value; default "".
StaticgetRead this facade's native Rml::GetStaticClassIdentifier.
Opaque type token, also available before runtime initialization.
Native Rml::ElementForm wrapper.