SemanticsConfiguration

Added in 1.0.0

Cmn

class SemanticsConfiguration : SemanticsPropertyReceiver, Iterable

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
`SemanticsConfiguration()`	Cmn

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

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

Extension functions
`T?`	`<T : Any?> SemanticsConfiguration.getOrNull(key: SemanticsPropertyKey<T>)`	Cmn

Public constructors

SemanticsConfiguration

Cmn

Added in 1.0.0

SemanticsConfiguration()

Public functions

contains

Cmn

Added in 1.0.0

operator fun <T : Any?> contains(key: SemanticsPropertyKey<T>): Boolean

copy

Cmn

Added in 1.0.0

fun copy(): SemanticsConfiguration

Returns an exact copy of this configuration.

equals

Cmn

open operator fun equals(other: Any?): Boolean

get

Cmn

Added in 1.0.0

operator fun <T : Any?> get(key: SemanticsPropertyKey<T>): T

Retrieves the value for the given property, if one has been set. If a value has not been set, throws IllegalStateException

getOrElse

Cmn

Added in 1.0.0

fun <T : Any?> getOrElse(key: SemanticsPropertyKey<T>, defaultValue: () -> T): T

getOrElseNullable

Cmn

Added in 1.0.0

fun <T : Any?> getOrElseNullable(
    key: SemanticsPropertyKey<T>,
    defaultValue: () -> T?
): T?

hashCode

Cmn

open fun hashCode(): Int

iterator

Cmn

Added in 1.0.0

open operator fun iterator(): Iterator<Map.Entry<SemanticsPropertyKey<*>, Any?>>

set

Cmn

open operator fun <T : Any?> set(key: SemanticsPropertyKey<T>, value: T): Unit

toString

Cmn

open fun toString(): String

Public properties

isClearingSemantics

Cmn

Added in 1.0.0

var isClearingSemantics: Boolean

isMergingSemanticsOfDescendants

Cmn

Added in 1.0.0

var isMergingSemanticsOfDescendants: Boolean

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

If set to true, the descendants of the owning component's SemanticsNode will merge their semantic information into the SemanticsNode representing the owning component.

Extension functions

getOrNull

Cmn

Artifact: androidx.compose.ui:ui

View Source

fun <T : Any?> SemanticsConfiguration.getOrNull(key: SemanticsPropertyKey<T>): T?