core/androidx.core.view.accessibility/AccessibilityEventCompat

AccessibilityEventCompat

class AccessibilityEventCompat(source)

Helper for accessing features in AccessibilityEvent.

Types

Link copied to clipboard

Properties

Link copied to clipboard
val CONTENT_CHANGE_TYPE_CONTENT_DESCRIPTION: Int = 4
Change type for TYPE_WINDOW_CONTENT_CHANGED event: The node's content description changed.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_CONTENT_INVALID: Int = 1024
Change type for TYPE_WINDOW_CONTENT_CHANGED event: The source node changed its content validity returned by isContentInvalid.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_DRAG_CANCELLED: Int = 512
Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag in with accessibility enabled has ended.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_DRAG_DROPPED: Int = 256
Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag in with accessibility enabled has ended.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_DRAG_STARTED: Int = 128
Change type for TYPE_WINDOW_CONTENT_CHANGED event: A drag has started while accessibility is enabled.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_ENABLED: Int = 4096
Change type for TYPE_WINDOW_CONTENT_CHANGED event: The source node changed its ability to interact returned by isEnabled.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_ERROR: Int = 2048
Change type for TYPE_WINDOW_CONTENT_CHANGED event: The source node changed its erroneous content's error message returned by getError.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_PANE_APPEARED: Int = 16
Change type for TYPE_WINDOW_STATE_CHANGED event: The node has a pane title, and either just appeared or just was assigned a title when it had none before.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_PANE_DISAPPEARED: Int = 32
Change type for TYPE_WINDOW_STATE_CHANGED event: Can mean one of two slightly different things.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_PANE_TITLE: Int = 8
Change type for TYPE_WINDOW_STATE_CHANGED event: The node's pane title changed.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_STATE_DESCRIPTION: Int = 64
Change type for TYPE_WINDOW_CONTENT_CHANGED event: state description of the node as returned by getStateDescription was changed.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_SUBTREE: Int = 1
Change type for TYPE_WINDOW_CONTENT_CHANGED event: A node in the subtree rooted at the source node was added or removed.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_TEXT: Int = 2
Change type for TYPE_WINDOW_CONTENT_CHANGED event: The node's text changed.
Link copied to clipboard
val CONTENT_CHANGE_TYPE_UNDEFINED: Int = 0
Change type for TYPE_WINDOW_CONTENT_CHANGED event: The type of change is not defined.
Link copied to clipboard
val TYPE_ANNOUNCEMENT: Int = 16384
Represents the event of an application making an announcement.
Link copied to clipboard
val TYPE_ASSIST_READING_CONTEXT: Int = 16777216
Represents the event of the assistant currently reading the users screen context.
Link copied to clipboard
val TYPE_GESTURE_DETECTION_END: Int = 524288
Represents the event of ending gesture detection.
Link copied to clipboard
val TYPE_GESTURE_DETECTION_START: Int = 262144
Represents the event of beginning gesture detection.
Link copied to clipboard
val TYPE_TOUCH_EXPLORATION_GESTURE_END: Int = 1024
Represents the event of ending a touch exploration gesture.
Link copied to clipboard
val TYPE_TOUCH_EXPLORATION_GESTURE_START: Int = 512
Represents the event of starting a touch exploration gesture.
Link copied to clipboard
val TYPE_TOUCH_INTERACTION_END: Int = 2097152
Represents the event of the user ending to touch the screen.
Link copied to clipboard
val TYPE_TOUCH_INTERACTION_START: Int = 1048576
Represents the event of the user starting to touch the screen.
Link copied to clipboard
val TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED: Int = 65536
Represents the event of clearing accessibility focus.
Link copied to clipboard
val TYPE_VIEW_ACCESSIBILITY_FOCUSED: Int = 32768
Represents the event of gaining accessibility focus.
Link copied to clipboard
val TYPE_VIEW_CONTEXT_CLICKED: Int = 8388608
Represents the event of a context click on a View.
Link copied to clipboard
val TYPE_VIEW_HOVER_ENTER: Int = 128
Represents the event of a hover enter over a View.
Link copied to clipboard
val TYPE_VIEW_HOVER_EXIT: Int = 256
Represents the event of a hover exit over a View.
Link copied to clipboard
val TYPE_VIEW_SCROLLED: Int = 4096
Represents the event of scrolling a view.
Link copied to clipboard
val TYPE_VIEW_TARGETED_BY_SCROLL: Int = 67108864
Represents the event of a scroll having completed and brought the target node on screen.
Link copied to clipboard
val TYPE_VIEW_TEXT_SELECTION_CHANGED: Int = 8192
Represents the event of changing the selection in an EditText.
val TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY: Int = 131072
Represents the event of traversing the text of a view at a given movement granularity.
Link copied to clipboard
val TYPE_WINDOW_CONTENT_CHANGED: Int = 2048
Represents the event of changing the content of a window.
Link copied to clipboard
val TYPE_WINDOWS_CHANGED: Int = 4194304
Represents the event change in the windows shown on the screen.
Link copied to clipboard
val TYPES_ALL_MASK: Int = -1
Mask for AccessibilityEvent all types.

Functions

Link copied to clipboard
open fun appendRecord(event: AccessibilityEvent, record: AccessibilityRecordCompat)
Appends an AccessibilityRecord to the end of event records.
Link copied to clipboard
open fun asRecord(event: AccessibilityEvent): AccessibilityRecordCompat
Creates an AccessibilityRecordCompat from an AccessibilityEvent that can be used to manipulate the event properties defined in AccessibilityRecord.
Link copied to clipboard
open fun getAction(@NonNull event: AccessibilityEvent): Int
Gets the performed action that triggered this event.
Link copied to clipboard
open fun getContentChangeTypes(@NonNull event: AccessibilityEvent): Int
Gets the bit mask of change types signaled by an TYPE_WINDOW_CONTENT_CHANGED event.
Link copied to clipboard
open fun getMovementGranularity(@NonNull event: AccessibilityEvent): Int
Gets the movement granularity that was traversed.
Link copied to clipboard
open fun getRecord(event: AccessibilityEvent, index: Int): AccessibilityRecordCompat
Gets the record at a given index.
Link copied to clipboard
open fun getRecordCount(event: AccessibilityEvent): Int
Gets the number of records contained in the event.
Link copied to clipboard
open fun isAccessibilityDataSensitive(@NonNull event: AccessibilityEvent): Boolean
Whether the event should only be delivered to an android.accessibilityservice.AccessibilityService with the isAccessibilityTool property set to true.
Link copied to clipboard
open fun setAccessibilityDataSensitive(@NonNull event: AccessibilityEvent, accessibilityDataSensitive: Boolean)
Sets whether the event should only be delivered to an android.accessibilityservice.AccessibilityService with the isAccessibilityTool property set to true.
Link copied to clipboard
open fun setAction(@NonNull event: AccessibilityEvent, action: Int)
Sets the performed action that triggered this event.
Link copied to clipboard
open fun setContentChangeTypes(@NonNull event: AccessibilityEvent, changeTypes: Int)
Sets the bit mask of node tree changes signaled by an TYPE_WINDOW_CONTENT_CHANGED event.
Link copied to clipboard
open fun setMovementGranularity(@NonNull event: AccessibilityEvent, granularity: Int)
Sets the movement granularity that was traversed.