Google is committed to advancing racial equity for Black communities. See how.

SemanticsConfiguration

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

Describes the semantic information associated with the owning component

Public methods
operator Boolean

SemanticsConfiguration

Returns an exact copy of this configuration.

Boolean
equals(other: Any?)

operator 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

Iterator<Entry<SemanticsPropertyKey<*>, Any?>>

Unit
set(key: SemanticsPropertyKey<T>, value: T)

String

Extension functions
From androidx.compose.ui.semantics
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

Whether this element is a Dialog.

Unit

Whether this semantics node is disabled.

Unit
SemanticsPropertyReceiver.dismiss(label: String? = null, action: () -> Boolean)

This function adds the SemanticsActions.Dismiss to the SemanticsPropertyReceiver.

Unit

This function adds the SemanticsActions.GetTextLayoutResult to the SemanticsPropertyReceiver.

Unit

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

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

Boolean

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

String

String

Developer-set content description of the semantics node.

List<CustomAccessibilityAction>