GlanceModifier

public interface GlanceModifier

An ordered, immutable, collection of modifier element for the Glance library.

This plays the same role as androidx.compose.ui.Modifier, but for the Glance composables.

Functions

foldIn

public fun <R> foldIn(initial: R, operation: (R, Element) -> R): R

Accumulates a value starting with initial and applying operation to the current value and each element from outside in.

Elements wrap one another in a chain from left to right; an Element that appears to the left of another in a + expression or in operation's parameter order affects all of the elements that appear after it. foldIn may be used to accumulate a value starting from the parent or head of the modifier chain to the final wrapped child.

foldOut

public fun <R> foldOut(initial: R, operation: (Element, R) -> R): R

Accumulates a value starting with initial and applying operation to the current value and each element from inside out.

Elements wrap one another in a chain from left to right; an Element that appears to the left of another in a + expression or in operation's parameter order affects all of the elements that appear after it. foldOut may be used to accumulate a value starting from the child or tail of the modifier chain up to the parent or head of the chain.

any

public fun any(predicate: (Element) -> Boolean): Boolean

Returns true if predicate returns true for any Element in this GlanceModifier.

all

public fun all(predicate: (Element) -> Boolean): Boolean

Returns true if predicate returns true for all Elements in this GlanceModifier or if this GlanceModifier contains no Elements.

then

public infix fun then(other: GlanceModifier): GlanceModifier

Concatenates this modifier with another.

Returns a GlanceModifier representing this modifier followed by other in sequence.

Members

Element

public interface Element : GlanceModifier

A single element contained within a GlanceModifier chain.

Functions

foldIn

override fun <R> foldIn(initial: R, operation: (R, Element) -> R): R

foldOut

override fun <R> foldOut(initial: R, operation: (Element, R) -> R): R

any

override fun any(predicate: (Element) -> Boolean): Boolean

all

override fun all(predicate: (Element) -> Boolean): Boolean

Companion

public companion object : GlanceModifier

The companion object Modifier is the empty, default, or starter GlanceModifier that contains no elements. Use it to create a new GlanceModifier using modifier extension factory functions.

Functions

foldIn

override fun <R> foldIn(initial: R, operation: (R, Element) -> R): R

foldOut

override fun <R> foldOut(initial: R, operation: (Element, R) -> R): R

any

override fun any(predicate: (Element) -> Boolean): Boolean

all

override fun all(predicate: (Element) -> Boolean): Boolean

then

override infix fun then(other: GlanceModifier): GlanceModifier

toString

override fun toString(): String