SemanticsConfiguration

Kotlin |Java

class SemanticsConfiguration : SemanticsPropertyReceiver, Iterable<Entry<SemanticsPropertyKey<*>, Any?>>

kotlin.Any
↳	androidx.compose.ui.semantics.SemanticsConfiguration

Describes the semantic information associated with the owning component

The information provided in the configuration is used to to generate the semantics tree.

Summary

Public constructors
<init>() Describes the semantic information associated with the owning component

Public methods
operator Boolean	contains(key: SemanticsPropertyKey<T>)
SemanticsConfiguration	copy() Returns an exact copy of this configuration.
Boolean	equals(other: Any?)
operator T	get(key: SemanticsPropertyKey<T>) Retrieves the value for the given property, if one has been set.
T	getOrElse(key: SemanticsPropertyKey<T>, defaultValue: () -> T)
T?	getOrElseNullable(key: SemanticsPropertyKey<T>, defaultValue: () -> T?)
Int	hashCode()
Iterator<Entry<SemanticsPropertyKey<*>, Any?>>	iterator()
Unit	set(key: SemanticsPropertyKey<T>, value: T)
String	toString()

Extension functions
From androidx.compose.ui.semantics T? SemanticsConfiguration.getOrNull(key: SemanticsPropertyKey<T>)

Inherited extension functions

From androidx.compose.ui.semantics Unit SemanticsPropertyReceiver.copyText(label: String? = null, action: () -> Boolean) This function adds the SemanticsActions.CopyText to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.cutText(label: String? = null, action: () -> Boolean) This function adds the SemanticsActions.CutText to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.dialog() Whether this element is a Dialog. Unit SemanticsPropertyReceiver.disabled() Whether this semantics node is disabled. Unit SemanticsPropertyReceiver.dismiss(label: String? = null, action: () -> Boolean) This function adds the SemanticsActions.Dismiss to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.getTextLayoutResult(label: String? = null, action: (MutableList<TextLayoutResult>) -> Boolean) This function adds the SemanticsActions.GetTextLayoutResult to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.hidden() Whether this semantics node is hidden. Unit SemanticsPropertyReceiver.onClick(label: String? = null, action: () -> Boolean) This function adds the SemanticsActions.OnClick to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.onLongClick(label: String? = null, action: () -> Boolean) This function adds the SemanticsActions.OnLongClick to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.pasteText(label: String? = null, action: () -> Boolean) This function adds the SemanticsActions.PasteText to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.popup() Whether this semantics node represents a Popup. Unit SemanticsPropertyReceiver.scrollBy(label: String? = null, action: (x: Float, y: Float) -> Boolean) This function adds the SemanticsActions.ScrollBy to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.setProgress(label: String? = null, action: (Float) -> Boolean) This function adds the SemanticsActions.SetProgress to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.setSelection(label: String? = null, action: (startIndex: Int, endIndex: Int, traversalMode: Boolean) -> Boolean) This function adds the SemanticsActions.SetSelection to the SemanticsPropertyReceiver. Unit SemanticsPropertyReceiver.setText(label: String? = null, action: (AnnotatedString) -> Boolean) This function adds the SemanticsActions.SetText to the SemanticsPropertyReceiver.

Properties
Boolean	isClearingSemantics
Boolean	isMergingSemanticsOfDescendants Whether the semantic information provided by the owning component and all of its descendants should be treated as one logical entity.

Inherited extension properties
From androidx.compose.ui.semantics String accessibilityLabel String accessibilityValue String contentDescription Developer-set content description of the semantics node. List<CustomAccessibilityAction> customAction