Added in API level 34

InsertModeGesture


class InsertModeGesture : HandwritingGesture, Parcelable
kotlin.Any
   ↳ android.view.inputmethod.HandwritingGesture
   ↳ android.view.inputmethod.InsertModeGesture

A sub-class of HandwritingGesture for starting an insert mode which inserts a space in the editor to let users hand write freely at the designated insertion point. This class holds the information required for insertion of text in toolkit widgets like TextView. Once InsertMode gesture is started, it continues until IME calls CancellationSignal#cancel() and toolkit can receive cancel using CancellationSignal#setOnCancelListener(CancellationSignal.OnCancelListener) obtained from getCancellationSignal().

Summary

Nested classes

Builder for InsertModeGesture.

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

CancellationSignal

Returns the CancellationSignal associated with finishing this gesture.

PointF

Returns the insertion point PointF (in screen coordinates) where space will be created for additional text to be inserted.

Int

Unit
writeToParcel(dest: Parcel, flags: Int)

Used to package this object into a Parcel.

Inherited functions
Properties
static Parcelable.Creator<InsertModeGesture!>

Used to make this class parcelable.

Public methods

describeContents

Added in API level 34
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getCancellationSignal

Added in API level 34
fun getCancellationSignal(): CancellationSignal

Returns the CancellationSignal associated with finishing this gesture. Once InsertMode gesture is started, it continues until IME calls CancellationSignal#cancel() and toolkit can receive cancel using CancellationSignal#setOnCancelListener(CancellationSignal.OnCancelListener).

Return
CancellationSignal This value cannot be null.

getInsertionPoint

Added in API level 34
fun getInsertionPoint(): PointF

Returns the insertion point PointF (in screen coordinates) where space will be created for additional text to be inserted.

Return
PointF This value cannot be null.

hashCode

Added in API level 34
fun hashCode(): Int
Return
Int a hash code value for this object.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written. This value cannot be null.
flags Int: The flags used for parceling.

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<InsertModeGesture!>

Used to make this class parcelable.