Package-level declarations

Functions

Link copied to clipboard
inline fun Style.accessibilityHeading(isAccessibilityHeading: Boolean): Style

Whether the view is a heading for a section of content for accessibility purposes.

Link copied to clipboard
inline fun Style.accessibilityRole(accessibilityRole: String?): Style

The Android Talkback "role" this component has. This will be read out when the view is visited in Talkback mode. See AccessibilityRoleType for possible roles.

Link copied to clipboard
inline fun Style.accessibilityRoleDescription(accessibilityRoleDescription: CharSequence?): Style

The description for this Component's accessibilityRole. This will be read out when the view is visited in Talkback mode.

Link copied to clipboard
inline fun Style.containerTitle(containerTitle: CharSequence?): Style

Sets the container title for app-developer-defined container which can be any type of ViewGroup or layout. Container title will be used to group together related controls, similar to HTML fieldset.

Link copied to clipboard
inline fun Style.contentDescription(contentDescription: CharSequence?): Style

A description of the contents of this Component for accessibility.

Link copied to clipboard
inline fun Style.focusOrder(focusOrderModel: FocusOrderModel): Style
Link copied to clipboard
inline fun Style.importantForAccessibility(importantForAccessibility: ImportantForAccessibility): Style

Sets whether this Component is "important for accessibility". If it is, it fires accessibility events and is reported to accessibility services that query the screen. The value for this property can be one of the values in ImportantForAccessibility.

Link copied to clipboard
inline fun Style.labeledBy(viewTag: Any): Style

Sets the view which serves as the label of the view represented by this info for accessibility purposes.

Link copied to clipboard
inline fun Style.liveRegion(mode: Int): Style

Sets the live region mode for this view. This indicates to accessibility services whether they should automatically notify the user about changes to the view's content description or text, or to the content descriptions or text of the view's children (where applicable).

Link copied to clipboard

Sets the minimum time duration between two content change events, which is used in throttling content change events in accessibility services.

Link copied to clipboard
inline fun Style.onInitializeAccessibilityEvent(noinline onInitializeAccessibilityEventHandler: (OnInitializeAccessibilityEventEvent) -> Unit): Style

Initializes an AccessibilityEvent with information about the the host View which dispatched the event.

Link copied to clipboard
inline fun Style.onInitializeAccessibilityNodeInfo(noinline onInitializeAccessibilityNodeInfoHandler: (OnInitializeAccessibilityNodeInfoEvent) -> Unit): Style

Initializes an AccessibilityNodeInfoCompat with information about the host view.

Link copied to clipboard
inline fun Style.onPerformAccessibilityAction(noinline onPerformAccessibilityActionHandler: (PerformAccessibilityActionEvent) -> Unit): Style

Called when performs the specified accessibility action on the view.

Link copied to clipboard
inline fun Style.onPerformActionForVirtualView(noinline onPerformActionForVirtualViewHandler: (PerformActionForVirtualViewEvent) -> Unit): Style

Performs the specified accessibility action on a virtual view child of the host View and gives an opportunity to the parent (the host) to implement the desired behavior.

Link copied to clipboard
inline fun Style.onPopulateAccessibilityEvent(noinline onPopulateAccessibilityEventHandler: (OnPopulateAccessibilityEventEvent) -> Unit): Style

Gives a chance to the host View to populate the accessibility event with its text content.

Link copied to clipboard
inline fun Style.onPopulateAccessibilityNode(noinline onPopulateAccessibilityNodeHandler: (OnPopulateAccessibilityNodeEvent) -> Unit): Style

Gives a chance to the component to implement its own accessibility support.

Link copied to clipboard
inline fun Style.onRequestSendAccessibilityEvent(noinline onRequestSendAccessibilityEventHandler: (OnRequestSendAccessibilityEventEvent) -> Unit): Style

Called when a child of the host View has requested sending an AccessibilityEvent and gives an opportunity to the parent (the host) to augment the event.

Link copied to clipboard
inline fun Style.onSendAccessibilityEvent(noinline onSendAccessibilityEventHandler: (SendAccessibilityEventEvent) -> Unit): Style

Called when Sends an accessibility event of the given type. If accessibility is not enabled this method has no effect.

Link copied to clipboard
inline fun Style.onSendAccessibilityEventUnchecked(noinline onSendAccessibilityEventUncheckedHandler: (SendAccessibilityEventUncheckedEvent) -> Unit): Style

Sends an accessibility event. This method behaves exactly as sendAccessibilityEvent() but takes as an argument an empty AccessibilityEvent and does not perform a check whether accessibility is enabled.

Link copied to clipboard
inline fun Style.onVirtualViewKeyboardFocusChanged(noinline onVirtualViewKeyboardFocusChangedHandler: (VirtualViewKeyboardFocusChangedEvent) -> Unit): Style

Called when a virtual view child of the host View has changed keyboard focus and gives an opportunity to the parent (the host) to react (changing visual display, etc.)

Link copied to clipboard
inline fun Style.paneTitle(accessibilityPaneTitle: CharSequence?): Style

Visually distinct portion of a window with window-like semantics are considered panes for accessibility purposes. One example is the content view of a large fragment that is replaced. In order for accessibility services to understand a pane's window-like behavior, panes should have descriptive titles. Views with pane titles produce AccessibilityEvent#TYPE_WINDOW_STATE_CHANGEDs when they appear, disappear, or change title.

Link copied to clipboard
inline fun Style.requestInitialAccessibilityFocus(requestInitialAccessibilityFocus: Boolean): Style

Sets whether the node has requested initial accessibility focus.

Link copied to clipboard
inline fun Style.screenReaderFocusable(isFocusable: Boolean): Style

Sets whether this View should be a focusable element for screen readers

Link copied to clipboard
inline fun Style.stateDescription(description: CharSequence?): Style

Sets the state description of the component associated to this Style.