blob: 3cef4a7d435efdbd0e8e4e004793226c4243b3ca [file] [log] [blame]
<html devsite="true">
<head>
<title>PaddingValues</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>PaddingValues</h1>
<p>
<pre>public interface <a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a></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/PaddingValues.Absolute.html">PaddingValues.Absolute</a></div>
</span>
<div id="subclasses-direct-summary">
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.Absolute.html">PaddingValues.Absolute</a></code></td>
<td>
<p>Describes an absolute (RTL unaware) padding to be applied along the edges inside a box.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</devsite-expandable> </div>
<hr>
<p>Describes a padding to be applied along the edges inside a box. See the <code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a></code> factories and <code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.Absolute.html">Absolute</a></code> for convenient ways to build <code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Nested types</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>public final class <a href="/reference/androidx/compose/foundation/layout/PaddingValues.Absolute.html">PaddingValues.Absolute</a> implements <a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a></code></td>
<td>
<p>Describes an absolute (RTL unaware) padding to be applied along the edges inside a box.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>abstract @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateBottomPadding()">calculateBottomPadding</a>()</code></div>
<p>The padding to be applied along the bottom edge inside a box.</p>
</td>
</tr>
<tr>
<td width="40%"><code>abstract @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateLeftPadding(androidx.compose.ui.unit.LayoutDirection)">calculateLeftPadding</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection)</code></div>
<p>The padding to be applied along the left edge inside a box.</p>
</td>
</tr>
<tr>
<td width="40%"><code>abstract @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateRightPadding(androidx.compose.ui.unit.LayoutDirection)">calculateRightPadding</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection)</code></div>
<p>The padding to be applied along the right edge inside a box.</p>
</td>
</tr>
<tr>
<td width="40%"><code>abstract @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateTopPadding()">calculateTopPadding</a>()</code></div>
<p>The padding to be applied along the top edge inside a box.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Extension functions</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>default&nbsp;final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/PaddingKt.html">PaddingKt</a>.<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#(androidx.compose.foundation.layout.PaddingValues).calculateEndPadding(androidx.compose.ui.unit.LayoutDirection)">calculateEndPadding</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a>&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection<br>)</code></div>
<p>The padding to be applied along the end edge inside a box: along the right edge if the layout direction is LTR, or along the left edge for RTL.</p>
</td>
</tr>
<tr>
<td width="40%"><code>default&nbsp;final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/foundation/layout/PaddingKt.html">PaddingKt</a>.<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#(androidx.compose.foundation.layout.PaddingValues).calculateStartPadding(androidx.compose.ui.unit.LayoutDirection)">calculateStartPadding</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a>&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection<br>)</code></div>
<p>The padding to be applied along the start edge inside a box: along the left edge if the layout direction is LTR, or along the right edge for RTL.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public methods</h2>
<div><a name="calculateBottomPadding--"></a><a name="calculatebottompadding"></a>
<h3 class="api-name" id="calculateBottomPadding()">calculateBottomPadding</h3>
<pre class="api-signature no-pretty-print">abstract&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a>&nbsp;<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateBottomPadding()">calculateBottomPadding</a>()</pre>
<p>The padding to be applied along the bottom edge inside a box.</p>
</div>
<div><a name="calculateLeftPadding-androidx.compose.ui.unit.LayoutDirection-"></a><a name="calculateleftpadding"></a>
<h3 class="api-name" id="calculateLeftPadding(androidx.compose.ui.unit.LayoutDirection)">calculateLeftPadding</h3>
<pre class="api-signature no-pretty-print">abstract&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a>&nbsp;<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateLeftPadding(androidx.compose.ui.unit.LayoutDirection)">calculateLeftPadding</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection)</pre>
<p>The padding to be applied along the left edge inside a box.</p>
</div>
<div><a name="calculateRightPadding-androidx.compose.ui.unit.LayoutDirection-"></a><a name="calculaterightpadding"></a>
<h3 class="api-name" id="calculateRightPadding(androidx.compose.ui.unit.LayoutDirection)">calculateRightPadding</h3>
<pre class="api-signature no-pretty-print">abstract&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a>&nbsp;<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateRightPadding(androidx.compose.ui.unit.LayoutDirection)">calculateRightPadding</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection)</pre>
<p>The padding to be applied along the right edge inside a box.</p>
</div>
<div><a name="calculateTopPadding--"></a><a name="calculatetoppadding"></a>
<h3 class="api-name" id="calculateTopPadding()">calculateTopPadding</h3>
<pre class="api-signature no-pretty-print">abstract&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a>&nbsp;<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#calculateTopPadding()">calculateTopPadding</a>()</pre>
<p>The padding to be applied along the top edge inside a box.</p>
</div>
<h2>Extension functions</h2>
<div><a name="-androidx.compose.foundation.layout.PaddingValues-.calculateEndPadding-androidx.compose.ui.unit.LayoutDirection-"></a><a name="calculateendpadding"></a>
<h3 class="api-name" id="(androidx.compose.foundation.layout.PaddingValues).calculateEndPadding(androidx.compose.ui.unit.LayoutDirection)">PaddingKt.calculateEndPadding</h3>
<pre class="api-signature no-pretty-print">default&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a>&nbsp;<a href="/reference/androidx/compose/foundation/layout/PaddingKt.html">PaddingKt</a>.<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#(androidx.compose.foundation.layout.PaddingValues).calculateEndPadding(androidx.compose.ui.unit.LayoutDirection)">calculateEndPadding</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a>&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection<br>)</pre>
<p>The padding to be applied along the end edge inside a box: along the right edge if the layout direction is LTR, or along the left edge for RTL.</p>
</div>
<div><a name="-androidx.compose.foundation.layout.PaddingValues-.calculateStartPadding-androidx.compose.ui.unit.LayoutDirection-"></a><a name="calculatestartpadding"></a>
<h3 class="api-name" id="(androidx.compose.foundation.layout.PaddingValues).calculateStartPadding(androidx.compose.ui.unit.LayoutDirection)">PaddingKt.calculateStartPadding</h3>
<pre class="api-signature no-pretty-print">default&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/Dp.html">Dp</a>&nbsp;<a href="/reference/androidx/compose/foundation/layout/PaddingKt.html">PaddingKt</a>.<a href="/reference/androidx/compose/foundation/layout/PaddingValues.html#(androidx.compose.foundation.layout.PaddingValues).calculateStartPadding(androidx.compose.ui.unit.LayoutDirection)">calculateStartPadding</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/foundation/layout/PaddingValues.html">PaddingValues</a>&nbsp;receiver,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/ui/unit/LayoutDirection.html">LayoutDirection</a>&nbsp;layoutDirection<br>)</pre>
<p>The padding to be applied along the start edge inside a box: along the left edge if the layout direction is LTR, or along the right edge for RTL.</p>
</div>
</body>
</html>