API reference
Preparing search index…

TextInputContext

Checked native Rml::TextInputContext for a live input or textarea widget.

Obtain this capability from TextInputHandler callbacks or drainEvents. Blur preserves it; widget destruction, input type changes and shutdown invalidate it. Offsets count Unicode code points, not UTF-16 code units. Native RmlUi implements all editing operations. On supported macOS SFML windows, focus attaches a native IME client; queued Cocoa edits run from Context.processEvent or Context.update. Other OS bridges are unavailable. getBoundingBox describes the widget; candidate placement uses the native caret.

Source & inheritance
Member directory8

Accessors

Methods

Accessors

Methods

  • Commit through native CommitComposition and its length restrictions.

    Parameters

    text
    string

    Composition text; [0, 0] performs no replacement.

    Returns

    void
    Source & inheritance
  • Call native SetCompositionRange; [0, 0] clears composition.

    Parameters

    start
    number

    Nonnegative int32 first code point.

    end
    number

    Exclusive int32 end, at least start.

    Returns

    void
    Source & inheritance
  • Call Rml::TextInputContext::SetCursorPosition.

    Parameters

    position
    number

    Nonnegative int32 code-point position.

    Returns

    void
    Source & inheritance
  • Call Rml::TextInputContext::SetSelectionRange; unfocused widgets ignore it.

    Parameters

    start
    number

    Nonnegative int32 start in code points.

    end
    number

    Exclusive nonnegative int32 end, at least start.

    Returns

    void
    Source & inheritance
  • Replace a range through native SetText, bypassing maxlength.

    Parameters

    text
    string

    Replacement text.

    start
    number

    Nonnegative int32 first code point.

    end
    number

    Exclusive int32 end, at least start.

    Returns

    void
    Source & inheritance

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