API reference
Preparing search index…

StyleSheetSpecification

Rml::StyleSheetSpecification, the runtime's global RCSS registry.

Initialise and Shutdown follow the owning RmlUi runtime automatically. Register custom properties before loading documents. Built-in definitions are read-only; custom definitions remain mutable until shutdown.

Source & inheritance
Member directory16

Methods

Methods

  • Apply Rml::StyleSheetSpecification::ParsePropertyDeclaration.

    Parameters

    dictionary

    Native output dictionary.

    name
    string

    Property, shorthand, or custom variable name.

    value
    string

    Raw declaration text.

    Returns

    boolean

    Native success, preserving partial writes on failure.

    Source & inheritance
  • Register a custom Rml::StyleSheetSpecification property.

    Parameters

    name
    string

    Unique name, excluding built-in properties and shorthands.

    defaultValue
    string

    Raw default value, parsed after attaching a parser.

    inherited
    boolean

    Whether descendants inherit the property.

    forcesLayout
    boolean = false

    Whether changes dirty layout; default false.

    Returns

    Mutable definition; repeated custom names preserve the original.

    Source & inheritance

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