| <html devsite="true"> |
| <head> |
| <title>ProvidedValue</title> |
| {% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} |
| {% include "_shared/_reference-head-tags.html" %} |
| </head> |
| <body> |
| <div id="metadata-info-block"></div> |
| <h1>ProvidedValue</h1> |
| <p> |
| <pre>public final class <a href="/reference/androidx/compose/runtime/ProvidedValue.html">ProvidedValue</a><T extends <a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>></pre> |
| </p> |
| <hr> |
| <p>An instance to hold a value provided by <code><a href="/reference/androidx/compose/runtime/package-summary.html#CompositionLocalProvider(kotlin.Array,kotlin.Function0)">CompositionLocalProvider</a></code> and is created by the <code><a href="/reference/androidx/compose/runtime/ProvidableCompositionLocal.html#provides(kotlin.Any)">ProvidableCompositionLocal.provides</a></code> infixed operator. If <code><a href="/reference/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 fields</h3></th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td width="40%"><code>final boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/runtime/ProvidedValue.html#canOverride()">canOverride</a></code></div> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/runtime/CompositionLocal.html">CompositionLocal</a><@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> T></code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/runtime/ProvidedValue.html#compositionLocal()">compositionLocal</a></code></div> |
| </td> |
| </tr> |
| <tr> |
| <td width="40%"><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> T</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/compose/runtime/ProvidedValue.html#value()">value</a></code></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <h2>Public fields</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">public final boolean <a href="/reference/androidx/compose/runtime/ProvidedValue.html#canOverride()">canOverride</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">public final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/compose/runtime/CompositionLocal.html">CompositionLocal</a><@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> T> <a href="/reference/androidx/compose/runtime/ProvidedValue.html#compositionLocal()">compositionLocal</a></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">public final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> T <a href="/reference/androidx/compose/runtime/ProvidedValue.html#value()">value</a></pre> |
| </div> |
| </body> |
| </html> |