Docsv3.3.0
Back to API Reference
Interface

IInsertionHandle

abstract
Implements:ITouchHandles

Insertion-handle capability on touch platforms: a single draggable handle under a collapsed caret that the user drags to reposition it, taps to raise the context menu, or releases to confirm placement. It is optional and independent of ISelectionHandles; one entity may implement either capability or both.

Remarks

Show appears the handle at the current caret, UpdatePosition follows it while visible, and Hide removes it when the caret is gone, a selection forms, or focus is lost.

Implementations(1)

Types that implement IInsertionHandle.

C
PrefabSelectionHandles
Presents the shipped Unity-UI selection and insertion handles from a prefab shared through the touch overlay. The managed entity remains owned by one selectable while the prefab instance is resolved lazily and can be shared by multiple fields.
public abstract void Show()

Shows the insertion handle at the current caret.

public abstract void Hide()

Hides the insertion handle.

public abstract void UpdatePosition()

Updates the handle from the current owner state.

public Action<Vector2> InsertionHandleDragged

Occurs when the user is dragging the insertion handle. The parameter is the drag position in screen coordinates, to be hit-tested into the new caret codepoint.

public Action InsertionHandleTapped

Occurs when the user has tapped the insertion handle (requests the context menu).

public Action InsertionHandleDragStarted

Occurs when an insertion-handle drag begins — a cue to hide transient UI such as the context menu for the duration of the drag.

public Action InsertionHandleDragEnded

Occurs when an insertion-handle drag has ended (confirms placement).

Back to API Reference