androidx.compose.ui.layout

The receiver scope of a layout's intrinsic approach measurements lambdas.

ApproachLayoutModifierNode is designed to support gradually approaching the destination layout calculated in the lookahead pass.

ApproachMeasureScope provides access to lookahead results to allow ApproachLayoutModifierNode to leverage lookahead results to define how measurements and placements approach their destination.

Layout extra items in the specified direction.

The scope used in BeyondBoundsLayout.layout.

Provides a BeyondBoundsLayout through Modifier.Node APIs.

Represents a rule to apply to scale a source rectangle to be inscribed into a destination

The info about the graphics layers used by tooling.

A part of the composition that can be measured.

The receiver scope of a layout's intrinsic measurements lambdas.

A holder of the measured bounds for the Layout.

Can be implemented by values used as parent data to make them usable as tags.

The public information about the layouts used internally as nodes in the Compose UI hierarchy.

A Modifier.Element that changes how its wrapped content is measured and laid out.

LookaheadScope provides a receiver scope for all (direct and indirect) child layouts in LookaheadScope.

A part of the composition that can be measured.

Defines the measure and layout behavior of a Layout.

Interface holding the size and alignment lines of the measured layout, as well as the children positioning logic.

The receiver scope of a layout's measure lambda.

A Measured corresponds to a layout that has been measured by its parent layout.

Defines the measure and layout behavior of a Layout overload which accepts a list of multiple composable content lambdas.

A modifier whose onGloballyPositioned is called with the final LayoutCoordinates of the Layout when the global position of the content may have changed.

A modifier whose onPlaced is called after the parent LayoutModifier and parent layout has been placed and before child LayoutModifier is placed.

A modifier whose onRemeasured is called when the layout content is remeasured.

A Modifier that provides data to the parent Layout.

Represents a container which can be pinned when the content of this container is important.

This is an object returned by pin which allows to release the pinning.

A collection of Rulers used to define a Rectangle.

This object is associated with a layout node and allows to execute some extra measure/layout actions which are needed for some complex layouts.

A Modifier.Element that provides a Remeasurement object associated with the layout node the modifier is applied to.

A scope used in MeasureScope.layout for the rulers parameter to allow a layout to define Ruler values for children.

A PausedPrecomposition is a subcomposition that can be composed incrementally as it supports being paused and resumed.

Instance of this interface is returned by precompose function.

The receiver scope of a SubcomposeLayout's measure lambda which adds ability to dynamically subcompose a content during the measuring on top of the features provided by MeasureScope.

This policy allows SubcomposeLayout to retain some of slots which we were used but not used anymore instead of disposing them.

Provides properties related to animating WindowInsetsRulers.

Contains rulers used for window insets.

Defines an offset line that can be used by parent layouts to align and position their children.

The direction (from the visible bounds) that a BeyondBoundsLayout is requesting more items to be laid.

ContentScale implementation that always scales the dimension by the provided fixed floating point value

A horizontal AlignmentLine.

A horizontal Ruler.

An object which holds on to a (potentially) mutating RelativeLayoutBounds of a specific node.

Used by tooling to examine the modifiers on a LayoutInfo.

A Placeable corresponds to a child layout that can be positioned by its parent layout.

Receiver scope that permits explicit placement of a Placeable.

A line that can be used to align layout children inside a Placeable.PlacementScope.

Holds 2 dimensional scaling factors for horizontal and vertical axes

State used by SubcomposeLayout.

Set containing slot ids currently available to reuse.

A vertical AlignmentLine.

A vertical Ruler.

Layout is the main core component for layout for "leaf" nodes.

LookaheadScope creates a scope in which all layouts will first determine their destination layout through a lookahead pass, followed by an approach pass to run the measurement and placement approach defined in approachLayout or ApproachLayoutModifierNode, in order to gradually reach the destination.

Analogue of Layout which allows to subcompose the actual content during the measuring stage for example to use the values calculated during the measurement as params for the composition of the children.

Creates an approach layout intended to help gradually approach the destination layout calculated in the lookahead pass.

Creates a LayoutModifier that allows changing how the wrapped element is measured and laid out.

This will map the RelativeLayoutBounds of the modifier into the provided LayoutBoundsHolder.

Tag the element with layoutId to identify the element within its parent.

Registers a callback to monitor when the node is first inside of the viewport of the window or not.

Invoke onGloballyPositioned with the LayoutCoordinates of the element when the global position of the content may have changed.

Invokes callback with the position of this layout node relative to the coordinate system of the root of the composition, as well as in screen coordinates and window coordinates.

Invoke onPlaced after the parent LayoutModifier and parent layout has been placed and before child LayoutModifier is placed.

Invoked with the size of the modified Compose UI element when the element is first measured or when the size of the element changes.

Registers a callback to monitor whether or not the node is inside of the viewport of the window or not.

Creates a RectRulers.

Constructs a ScaleFactor from the given x and y scale values

Creates SubcomposeSlotReusePolicy which retains the fixed amount of slots.

Linearly interpolate between two ScaleFactor parameters

Creates a DelegatableNode for a modifier node, implementing the contract of onVisibilityChanged Modifier.

Returns the bounding box of the child in the parent's content area, including any clipping done with respect to the parent.

The boundaries of this layout inside the root composable.

The boundaries of this layout relative to the window's origin.

Division operator with Size

Walks up the LayoutCoordinates hierarchy to find the LayoutCoordinates whose LayoutCoordinates.parentCoordinates is null and returns it.

Returns a List of RectRulers, one RectRulers for each display cutout.

Merges multiple RectRulers into a single RectRulers, using the inner-most value.

Obtains the LayoutCoordinates for the given LookaheadScope using a LayoutCoordinates within the LookaheadScope.

Merges multiple RectRulers into a single RectRulers, using the outer-most value.

Returns the position of the top-left in the parent's content area or (0, 0) for the root.

The position of this layout inside the root composable.

The position of this layout relative to the window.

The position of this layout on the device's screen.

Registers a callback to be executed with the position of this modifier node relative to the coordinate system of the root of the composition, as well as in screen coordinates and window coordinates, see RelativeLayoutBounds.

Registers a callback to be executed with the position of this modifier node relative to the coordinate system of the root of the composition, as well as in screen coordinates and window coordinates.

If this ScaleFactor then this is returned, otherwise block is executed and its result is returned.

Multiplication operator with Size.

Multiplication operator with Size with reverse parameter types to maintain commutative properties of multiplication

AlignmentLine defined by the baseline of a first line of a androidx.compose.foundation.text.BasicText

AlignmentLine defined by the baseline of the last line of a androidx.compose.foundation.text.BasicText

Use this composition local to get the PinnableContainer handling the current subhierarchy.

A modifier local that provides access to a BeyondBoundsLayout that a child can use to ask a parent to layout more items that are beyond its visible bounds.

false when this is ScaleFactor.Unspecified.

true when this is ScaleFactor.Unspecified.

Retrieves the tag associated to a composable with the Modifier.layoutId modifier.

Return the owner as a View from the associated LayoutNode.