Gitiles
Code Review Sign In
android-review.linaro.org / platform / tools / dokka-devsite-plugin / 6f896de9f93fe82ff1c7f1a7d1ff5c994d9503b9 / . / testData / compose / docs / reference / kotlin / androidx / compose / foundation / MutatePriority.html
blob: b9bb39a559a0b5547f91174037ca224fc760ea7f [file] [log] [blame]
<html devsite="true">
<head>
<title>MutatePriority</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>MutatePriority</h1>
<p>
<pre>enum <a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a></pre>
</p>
<div class="devsite-table-wrapper">
<table class="jd-inheritance-table">
<tbody>
<tr>
<td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
</tr>
<tr>
<td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="2"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">kotlin.Enum</a></td>
</tr>
<tr>
<td>&nbsp;</td>
<td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="1"><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">androidx.compose.foundation.MutatePriority</a></td>
</tr>
</tbody>
</table>
</div>
<hr>
<p>Priorities for performing mutation on state.</p>
<p><code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a></code> values follow the natural ordering of <code>enum class</code> values; a value that compares as <code>&gt;</code> to another has a higher priority. A mutation of equal or greater priority will interrupt the current mutation in progress.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Enum Values</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#Default">Default</a></code></td>
<td>
<p>The default priority for mutations.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#PreventUserInput">PreventUserInput</a></code></td>
<td>
<p>A high-priority mutation that can only be interrupted by other <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#PreventUserInput">PreventUserInput</a></code> priority operations.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#UserInput">UserInput</a></code></td>
<td>
<p>An elevated priority for mutations meant for implementing direct user interactions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public functions</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#valueOf(kotlin.String)">valueOf</a>(value:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
<p>Returns the enum constant of this type with the specified name.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a>&gt;</code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#values()">values</a>()</code></div>
<p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Enum Values</h2>
<div>
<h3 class="api-name" id="Default">Default</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#Default">MutatePriority.Default</a>:&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a></pre>
<p>The default priority for mutations. Can be interrupted by other <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#Default">Default</a></code>, <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#UserInput">UserInput</a></code> or <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#PreventUserInput">PreventUserInput</a></code> priority operations. <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#Default">Default</a></code> priority should be used for programmatic animations or changes that should not interrupt user input.</p>
</div>
<div>
<h3 class="api-name" id="PreventUserInput">PreventUserInput</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#PreventUserInput">MutatePriority.PreventUserInput</a>:&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a></pre>
<p>A high-priority mutation that can only be interrupted by other <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#PreventUserInput">PreventUserInput</a></code> priority operations. <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#PreventUserInput">PreventUserInput</a></code> priority should be used for operations that user input should not be able to interrupt.</p>
</div>
<div>
<h3 class="api-name" id="UserInput">UserInput</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#UserInput">MutatePriority.UserInput</a>:&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a></pre>
<p>An elevated priority for mutations meant for implementing direct user interactions. Can be interrupted by other <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#UserInput">UserInput</a></code> or <code><a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#PreventUserInput">PreventUserInput</a></code> priority operations.</p>
</div>
<h2>Public functions</h2>
<div><a name="valueOf-kotlin.String-"></a><a name="valueof"></a>
<h3 class="api-name" id="valueOf(kotlin.String)">valueOf</h3>
<pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#valueOf(kotlin.String)">valueOf</a>(value:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>):&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a></pre>
<p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Throws</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>kotlin.IllegalArgumentException:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
<td>
<p>if this enum type has no constant with the specified name</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="values--"></a><a name="values"></a>
<h3 class="api-name" id="values()">values</h3>
<pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html#values()">values</a>():&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="/reference/kotlin/androidx/compose/foundation/MutatePriority.html">MutatePriority</a>&gt;</pre>
<p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
<p>This method may be used to iterate over the constants.</p>
</div>
</body>
</html>