API reference
Preparing search index…

Checked element-owned Rml::ElementStyle with native cascade and dirty state.

Class and pseudo-class setters follow ElementStyle directly. Call updateDefinition explicitly after changing them. Queries return owned snapshots. High-frequency numeric operations use ElementCommandBuffer's style opcodes and shared planes; normal layout computation stays native. Element destruction and runtime shutdown invalidate every style operation.

Source & inheritance
Member directory36

Methods

Methods

  • Query native dirty property, variable and shorthand sets.

    Returns

    boolean

    Whether recomputation is required.

    Source & inheritance
  • Compute into owned native values and consume the element's real dirty sets.

    Parameters

    values

    Writable values associated with this element.

    parentValues

    Already computed parent values, or null.

    documentValues

    Already computed document values, or null.

    valuesAreDefaultInitialized
    boolean

    Output still has native defaults.

    dpRatio
    number

    Positive finite density ratio.

    viewportDimensions

    Finite native viewport dimensions.

    Returns

    Consumed dirty IDs; inherited dependencies propagate to children.

    Execute parents before children. This operation writes owned output only; it does not invoke Element::OnPropertyChange or update its layout. Before subsequent Context.update, redirty every returned ID on this style so Element::UpdateProperties can apply the pending values to live layout.

    Source & inheritance
  • Dirty matching properties recursively, including non-DOM children.

    Parameters

    units

    Native unit bit mask.

    Returns

    void
    Source & inheritance
  • Snapshot pseudo-class bits: normal 1, override 2, combined 3.

    Returns

    Map<string, number>

    Independent name-to-state map.

    Source & inheritance
  • Resolve a native custom property through ancestors and variables.

    Parameters

    name
    string

    Custom name beginning with --.

    Returns

    null | Property

    Owned resolved property or null.

    Source & inheritance
  • Copy a local custom property without variable substitution.

    Parameters

    name
    string

    Custom name beginning with --.

    Returns

    null | Property

    Owned property or null.

    Source & inheritance
  • Copy the specified custom property through native ancestors.

    Parameters

    name
    string

    Custom name beginning with --.

    Returns

    null | Property

    Owned unresolved property or null.

    Source & inheritance
  • Query native class membership.

    Parameters

    name
    string

    Class name.

    Returns

    boolean

    Whether present.

    Source & inheritance
  • Test active pseudo-class membership.

    Parameters

    name
    string

    Pseudo-class name.

    Returns

    boolean

    Whether either state bit is set.

    Source & inheritance
  • Snapshot all native local maps, skipping shorthand placeholders.

    Parameters

    filterInheritedBy
    null | Element = null

    Optional native cascade filter element.

    Returns

    [string, Property][]

    Independent name/property pairs in native iteration order.

    Source & inheritance
  • Remove a local custom property.

    Parameters

    name
    string

    Custom name beginning with --.

    Returns

    void
    Source & inheritance
  • Resolve a numeric value to its native canonical unit.

    Parameters

    value

    Single-unit native numeric value.

    baseValue
    number

    Number and percentage scaling base.

    Returns

    number

    Finite resolved value; zero for unsupported units.

    Source & inheritance
  • Add or remove a native class without updating the definition.

    Parameters

    name
    string

    Class name.

    activate
    boolean

    Add or remove.

    Returns

    boolean

    Whether class membership changed.

    Source & inheritance
  • Replace native classes using space-separated names.

    Parameters

    names
    string

    Complete native class list.

    Returns

    void
    Source & inheritance
  • Copy an inline custom property and dirty its variable name.

    Parameters

    name
    string

    Custom name beginning with --.

    value

    Parsed property.

    Returns

    void
    Source & inheritance
  • Set the native normal or override pseudo-class bit.

    Parameters

    name
    string

    Pseudo-class name.

    activate
    boolean

    Add or remove the selected bit.

    overrideClass
    boolean = false

    Select the override bit, retained on normal clear.

    Returns

    boolean

    Whether active membership changed, not just its bit state.

    Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0