Gitiles
Code Review Sign In
android-review.linaro.org / platform / tools / dokka-devsite-plugin / 6f896de9f93fe82ff1c7f1a7d1ff5c994d9503b9 / . / testData / compose / docs / reference / androidx / compose / material / DrawerValue.html
blob: 7c5dabeb4e9c9fc542a67356cde798e38f10b974 [file] [log] [blame]
<html devsite="true">
<head>
<title>DrawerValue</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>DrawerValue</h1>
<p>
<pre>public enum <a href="/reference/androidx/compose/material/DrawerValue.html">DrawerValue</a> extends <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://developer.android.com/reference/java/lang/Object.html">java.lang.Object</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/androidx/compose/material/DrawerValue.html">androidx.compose.material.DrawerValue</a></td>
</tr>
</tbody>
</table>
</div>
<hr>
<p>Possible values of <code><a href="/reference/androidx/compose/material/DrawerState.html">DrawerState</a></code>.</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/androidx/compose/material/DrawerValue.html#Closed">Closed</a></code></td>
<td>
<p>The state of the drawer when it is closed.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/androidx/compose/material/DrawerValue.html#Open">Open</a></code></td>
<td>
<p>The state of the drawer when it is open.</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>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/material/DrawerValue.html">DrawerValue</a></code></td>
<td>
<div><code><a href="/reference/androidx/compose/material/DrawerValue.html#valueOf(kotlin.String)">valueOf</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;value)</code></div>
<p>Returns the enum constant of this type with the specified name.</p>
</td>
</tr>
<tr>
<td width="40%"><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> DrawerValue[]</code></td>
<td>
<div><code><a href="/reference/androidx/compose/material/DrawerValue.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="Closed">Closed</h3>
<pre class="api-signature no-pretty-print"><a href="/reference/androidx/compose/material/DrawerValue.html">DrawerValue</a>&nbsp;<a href="/reference/androidx/compose/material/DrawerValue.html#Closed">DrawerValue.Closed</a></pre>
<p>The state of the drawer when it is closed.</p>
</div>
<div>
<h3 class="api-name" id="Open">Open</h3>
<pre class="api-signature no-pretty-print"><a href="/reference/androidx/compose/material/DrawerValue.html">DrawerValue</a>&nbsp;<a href="/reference/androidx/compose/material/DrawerValue.html#Open">DrawerValue.Open</a></pre>
<p>The state of the drawer when it is open.</p>
</div>
<h2>Public methods</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">public&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/material/DrawerValue.html">DrawerValue</a>&nbsp;<a href="/reference/androidx/compose/material/DrawerValue.html#valueOf(kotlin.String)">valueOf</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;value)</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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a>&nbsp;kotlin.IllegalArgumentException</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">public&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> DrawerValue[]&nbsp;<a href="/reference/androidx/compose/material/DrawerValue.html#values()">values</a>()</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>