Gitiles
Code Review Sign In
android-review.linaro.org / platform / tools / dokka-devsite-plugin / 3187d73036dd9cdaad606f720f04278eb353b52a / . / testData / compose / docs / reference / kotlin / androidx / compose / foundation / gestures / ScrollScope.html
blob: 89b5dd76ebd2d1cfb27afb8eb894cd6ac1d8a8af [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>
8 <h1>ScrollScope</h1>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]9 <p>
Owen Gray22f20572022-08-08 13:48:02 -0400[diff] [blame]10 <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]11 </p>
12 <hr>
13 <p>Scope used for suspending scroll blocks</p>
14 <h2>Summary</h2>
15 <div class="devsite-table-wrapper">
16 <table class="responsive">
17 <thead>
18 <tr>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]19 <th colspan="100%"><h3>Public functions</h3></th>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]20 </tr>
21 </thead>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]22 <tbody class="list">
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]23 <tr>
24 <td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
25 <td>
26 <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>
27 <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>
28 </td>
29 </tr>
30 </tbody>
31 </table>
32 </div>
33 <h2>Public functions</h2>
34 <div><a name="scrollBy-kotlin.Float-"></a><a name="scrollby"></a>
35 <h3 class="api-name" id="scrollBy(kotlin.Float)">scrollBy</h3>
36 <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>
37 <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>
38 <div class="devsite-table-wrapper">
39 <table class="responsive">
40 <thead>
41 <tr>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]42 <th colspan="100%">Returns</th>
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]43 </tr>
44 </thead>
Andrea Falcone80f1a8f2022-08-23 11:22:33 -0400[diff] [blame]45 <tbody class="list">
Tiem Song6fed3de2021-06-14 14:48:10 -0700[diff] [blame]46 <tr>
47 <td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a></code></td>
48 <td>
49 <p>the amount of the requested scroll that was consumed (that is, how far it scrolled)</p>
50 </td>
51 </tr>
52 </tbody>
53 </table>
54 </div>
55 </div>
56 </body>
57</html>