blob: 5ef5c51cd68ed88c081223ff0037163fef5c66e9 [file] [log] [blame]
<html devsite="true">
<head>
<title>Arrangement.Horizontal</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>Arrangement.Horizontal</h1>
<p>
<pre>interface Arrangement.Horizontal</pre>
</p>
<div class="devsite-table-wrapper"><devsite-expandable><span class="expand-control jd-sumtable-subclasses">Known direct subclasses
<div class="showalways" id="subclasses-direct"><a href="/reference/androidx/compose/foundation/layout/Arrangement.HorizontalOrVertical.html">Arrangement.HorizontalOrVertical</a></div>
</span>
<div id="subclasses-direct-summary">
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody>
<tr>
<td width="40%"><code><a href="/reference/androidx/compose/foundation/layout/Arrangement.HorizontalOrVertical.html">Arrangement.HorizontalOrVertical</a></code></td>
<td>
<p>Used to specify the horizontal arrangement of the layout's children in horizontal layouts like <code><a href="/reference/androidx/compose/foundation/layout/package-summary.html#Row(Modifier,androidx.compose.foundation.layout.Arrangement.Horizontal,Alignment.Vertical,kotlin.Function1)">Row</a></code>, or the vertical arrangement of the layout's children in vertical layouts like <code><a href="/reference/androidx/compose/foundation/layout/package-summary.html#Column(Modifier,androidx.compose.foundation.layout.Arrangement.Vertical,Alignment.Horizontal,kotlin.Function1)">Column</a></code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</devsite-expandable> </div>
<hr>
<p>Used to specify the horizontal arrangement of the layout's children in layouts like <code><a href="/reference/androidx/compose/foundation/layout/package-summary.html#Row(Modifier,androidx.compose.foundation.layout.Arrangement.Horizontal,Alignment.Vertical,kotlin.Function1)">Row</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td width="40%"><code>default @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/Arrangement.Horizontal.html#spacing()">spacing</a></code></div>
<p>Spacing that should be added between any two adjacent layout children.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td width="40%"><code>abstract void</code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/ArrangementKt.html">ArrangementKt</a>.<a href="/reference/androidx/compose/foundation/layout/Arrangement.Horizontal.html#(Density).arrange(kotlin.Int,kotlin.IntArray,LayoutDirection,kotlin.IntArray)">arrange</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;totalSize,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[]&nbsp;sizes,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;layoutDirection,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[]&nbsp;outPositions<br>)</code></div>
<p>Horizontally places the layout children.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public fields</h2>
<div><a name="getSpacing()"></a><a name="setSpacing()"></a><a name="getSpacing--"></a><a name="setSpacing--"></a>
<h3 class="api-name" id="spacing()">spacing</h3>
<pre class="api-signature no-pretty-print">default&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;<a href="/reference/androidx/compose/foundation/layout/Arrangement.Horizontal.html#spacing()">spacing</a></pre>
<p>Spacing that should be added between any two adjacent layout children.</p>
</div>
<h2>Public methods</h2>
<div><a name="(Density).arrange(kotlin.Int, kotlin.IntArray, LayoutDirection, kotlin.IntArray)"></a><a name="-Density-.arrange-kotlin.Int-kotlin.IntArray-LayoutDirection-kotlin.IntArray-"></a><a name="arrange"></a>
<h3 class="api-name" id="(Density).arrange(kotlin.Int,kotlin.IntArray,LayoutDirection,kotlin.IntArray)">ArrangementKt.arrange</h3>
<pre class="api-signature no-pretty-print">abstract&nbsp;void&nbsp;<a href="/reference/androidx/compose/foundation/layout/ArrangementKt.html">ArrangementKt</a>.<a href="/reference/androidx/compose/foundation/layout/Arrangement.Horizontal.html#(Density).arrange(kotlin.Int,kotlin.IntArray,LayoutDirection,kotlin.IntArray)">arrange</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;totalSize,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[]&nbsp;sizes,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;layoutDirection,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[]&nbsp;outPositions<br>)</pre>
<p>Horizontally places the layout children.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td width="40%"><code>int&nbsp;totalSize</code></td>
<td>
<p>Available space that can be occupied by the children, in pixels.</p>
</td>
</tr>
<tr>
<td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[]&nbsp;sizes</code></td>
<td>
<p>An array of sizes of all children, in pixels.</p>
</td>
</tr>
<tr>
<td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;layoutDirection</code></td>
<td>
<p>A layout direction, left-to-right or right-to-left, of the parent layout that should be taken into account when determining positions of the children.</p>
</td>
</tr>
<tr>
<td width="40%"><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[]&nbsp;outPositions</code></td>
<td>
<p>An array of the size of <code><a href="/reference/androidx/compose/foundation/layout/Arrangement.Horizontal.html#(Density).arrange(kotlin.Int,kotlin.IntArray,LayoutDirection,kotlin.IntArray)">sizes</a></code> that returns the calculated positions relative to the left, in pixels.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>