blob: 9839d6576de60a31c1ec6e57d05d7c0575e94e1b [file] [log] [blame]
<html devsite="true">
<head>
<title>ProvidedValue</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>ProvidedValue</h1>
<p>
<pre>class <a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html">ProvidedValue</a>&lt;T&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?&gt;</pre>
</p>
<hr>
<p>An instance to hold a value provided by <code><a href="/reference/kotlin/androidx/compose/runtime/package-summary.html#CompositionLocalProvider(kotlin.Array,kotlin.Function0)">CompositionLocalProvider</a></code> and is created by the <code><a href="/reference/kotlin/androidx/compose/runtime/ProvidableCompositionLocal.html#provides(kotlin.Any)">ProvidableCompositionLocal.provides</a></code> infixed operator. If <code><a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html#canOverride()">canOverride</a></code> is <code>false</code>, the provided value will not overwrite a potentially already existing value in the scope.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html#canOverride()">canOverride</a></code></div>
</td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/kotlin/androidx/compose/runtime/CompositionLocal.html">CompositionLocal</a>&lt;T&gt;</code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html#compositionLocal()">compositionLocal</a></code></div>
</td>
</tr>
<tr>
<td width="40%"><code>T</code></td>
<td>
<div><code><a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html#value()">value</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public properties</h2>
<div><a name="getCanOverride()"></a><a name="setCanOverride()"></a><a name="getCanOverride--"></a><a name="setCanOverride--"></a>
<h3 class="api-name" id="canOverride()">canOverride</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html#canOverride()">canOverride</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
</div>
<div><a name="getCompositionLocal()"></a><a name="setCompositionLocal()"></a><a name="getCompositionLocal--"></a><a name="setCompositionLocal--"></a>
<h3 class="api-name" id="compositionLocal()">compositionLocal</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html#compositionLocal()">compositionLocal</a>:&nbsp;<a href="/reference/kotlin/androidx/compose/runtime/CompositionLocal.html">CompositionLocal</a>&lt;T&gt;</pre>
</div>
<div><a name="getValue()"></a><a name="setValue()"></a><a name="getValue--"></a><a name="setValue--"></a>
<h3 class="api-name" id="value()">value</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/compose/runtime/ProvidedValue.html#value()">value</a>:&nbsp;T</pre>
</div>
</body>
</html>