Gitiles
Code Review Sign In
android-review.linaro.org / platform / tools / dokka-devsite-plugin / 6f896de9f93fe82ff1c7f1a7d1ff5c994d9503b9 / . / testData / compose / docs / reference / kotlin / androidx / compose / foundation / gestures / ScrollScope.html
blob: 7666f8199da5116773dda6109e810147c43e58f3 [file] [log] [blame]
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]1<html devsite="true">
2 <head>
3 <title>ScrollScope</title>
4{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
5{% include "_shared/_reference-head-tags.html" %}
6 </head>
7 <body>
Tiem Song6f896de2022-11-03 14:55:52 -0700[diff] [blame^]8 <div id="metadata-info-block"></div>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]9 <h1>ScrollScope</h1>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]10 <p>
Owen Gray22f20572022-08-08 13:48:02 -0400[diff] [blame]11 <pre>interface <a href="/reference/kotlin/androidx/compose/foundation/gestures/ScrollScope.html">ScrollScope</a></pre>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]12 </p>
13 <hr>
14 <p>Scope used for suspending scroll blocks</p>
15 <h2>Summary</h2>
16 <div class="devsite-table-wrapper">
17 <table class="responsive">
18 <thead>
19 <tr>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]20 <th colspan="100%"><h3>Public functions</h3></th>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]21 </tr>
22 </thead>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]23 <tbody class="list">
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]24 <tr>
25 <td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
26 <td>
27 <div><code><a href="/reference/kotlin/androidx/compose/foundation/gestures/ScrollScope.html#scrollBy(kotlin.Float)">scrollBy</a>(pixels:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>)</code></div>
28 <p>Attempts to scroll forward by <code><a href="/reference/kotlin/androidx/compose/foundation/gestures/ScrollScope.html#scrollBy(kotlin.Float)">pixels</a></code> px.</p>
29 </td>
30 </tr>
31 </tbody>
32 </table>
33 </div>
34 <h2>Public functions</h2>
35 <div><a name="scrollBy-kotlin.Float-"></a><a name="scrollby"></a>
36 <h3 class="api-name" id="scrollBy(kotlin.Float)">scrollBy</h3>
37 <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/compose/foundation/gestures/ScrollScope.html#scrollBy(kotlin.Float)">scrollBy</a>(pixels:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a>):&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></pre>
38 <p>Attempts to scroll forward by <code><a href="/reference/kotlin/androidx/compose/foundation/gestures/ScrollScope.html#scrollBy(kotlin.Float)">pixels</a></code> px.</p>
39 <div class="devsite-table-wrapper">
40 <table class="responsive">
41 <thead>
42 <tr>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]43 <th colspan="100%">Returns</th>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]44 </tr>
45 </thead>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]46 <tbody class="list">
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]47 <tr>
48 <td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
49 <td>
50 <p>the amount of the requested scroll that was consumed (that is, how far it scrolled)</p>
51 </td>
52 </tr>
53 </tbody>
54 </table>
55 </div>
56 </div>
57 </body>
58</html>