Skip to content

Commit

Permalink
Update from slint-ui/slint
Browse files Browse the repository at this point in the history
Update tng docs from commit f8015ae12e57664c828977930d58e67f534a0b4e (refs/heads/docs-tng)
  • Loading branch information
slint-team[bot] committed Oct 29, 2024
1 parent ca903c6 commit 9b64342
Show file tree
Hide file tree
Showing 63 changed files with 186 additions and 480 deletions.
8 changes: 2 additions & 6 deletions snapshots/tng/elements/dialog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,6 @@
a <code dir="auto">cancel_clicked</code> callback will be added.
Each of these automatically-generated callbacks is an alias for the <code dir="auto">clicked</code> callback of the associated <code dir="auto">StandardButton</code>.</p>
<h3 id="icon"><code dir="auto">icon</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/#images" dir="auto"> <code>image</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">the empty image</code><br> </p> <p>The window icon shown in the title bar or the task bar on window managers supporting it.</p> </div>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/#images" dir="auto"> <code>image</code> </a> <br> <strong>default:</strong> <code dir="auto">the empty image</code><br> </p> <p>The window icon shown in the title bar or the task bar on window managers supporting it.</p> </div>
<h3 id="title"><code dir="auto">title</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/#string" dir="auto"> <code>string</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">&quot;&quot;</code><br> </p> <p>The window title that is shown in the title bar.</p> </div> </div> <footer class="sl-flex astro-eifwj7ft"> <div class="meta sl-flex astro-eifwj7ft"> </div> <div class="pagination-links astro-dyqvxwuo" dir="ltr"> <a href="/tng/tutorial/conclusion" rel="prev" class="astro-dyqvxwuo"> <svg aria-hidden="true" class="astro-dyqvxwuo astro-6uleiwf3" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17 11H9.41l3.3-3.29a1.004 1.004 0 1 0-1.42-1.42l-5 5a1 1 0 0 0-.21.33 1 1 0 0 0 0 .76 1 1 0 0 0 .21.33l5 5a1.002 1.002 0 0 0 1.639-.325 1 1 0 0 0-.219-1.095L9.41 13H17a1 1 0 0 0 0-2Z"/></svg> <span class="astro-dyqvxwuo"> Previous <br class="astro-dyqvxwuo"> <span class="link-title astro-dyqvxwuo">Conclusion</span> </span> </a> <a href="/tng/elements/flickable/" rel="next" class="astro-dyqvxwuo"> <svg aria-hidden="true" class="astro-dyqvxwuo astro-6uleiwf3" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17.92 11.62a1.001 1.001 0 0 0-.21-.33l-5-5a1.003 1.003 0 1 0-1.42 1.42l3.3 3.29H7a1 1 0 0 0 0 2h7.59l-3.3 3.29a1.002 1.002 0 0 0 .325 1.639 1 1 0 0 0 1.095-.219l5-5a1 1 0 0 0 .21-.33 1 1 0 0 0 0-.76Z"/></svg> <span class="astro-dyqvxwuo"> Next <br class="astro-dyqvxwuo"> <span class="link-title astro-dyqvxwuo">Flickable</span> </span> </a> </div> </footer> </div> </div> </main> </div> </div> </div> </div> </body></html>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/#string" dir="auto"> <code>string</code> </a> <br> <strong>default:</strong> <code dir="auto">&quot;&quot;</code><br> </p> <p>The window title that is shown in the title bar.</p> </div> </div> <footer class="sl-flex astro-eifwj7ft"> <div class="meta sl-flex astro-eifwj7ft"> </div> <div class="pagination-links astro-dyqvxwuo" dir="ltr"> <a href="/tng/tutorial/conclusion" rel="prev" class="astro-dyqvxwuo"> <svg aria-hidden="true" class="astro-dyqvxwuo astro-6uleiwf3" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17 11H9.41l3.3-3.29a1.004 1.004 0 1 0-1.42-1.42l-5 5a1 1 0 0 0-.21.33 1 1 0 0 0 0 .76 1 1 0 0 0 .21.33l5 5a1.002 1.002 0 0 0 1.639-.325 1 1 0 0 0-.219-1.095L9.41 13H17a1 1 0 0 0 0-2Z"/></svg> <span class="astro-dyqvxwuo"> Previous <br class="astro-dyqvxwuo"> <span class="link-title astro-dyqvxwuo">Conclusion</span> </span> </a> <a href="/tng/elements/flickable/" rel="next" class="astro-dyqvxwuo"> <svg aria-hidden="true" class="astro-dyqvxwuo astro-6uleiwf3" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17.92 11.62a1.001 1.001 0 0 0-.21-.33l-5-5a1.003 1.003 0 1 0-1.42 1.42l3.3 3.29H7a1 1 0 0 0 0 2h7.59l-3.3 3.29a1.002 1.002 0 0 0 .325 1.639 1 1 0 0 0 1.095-.219l5-5a1 1 0 0 0 .21-.33 1 1 0 0 0 0-.76Z"/></svg> <span class="astro-dyqvxwuo"> Next <br class="astro-dyqvxwuo"> <span class="link-title astro-dyqvxwuo">Flickable</span> </span> </a> </div> </footer> </div> </div> </main> </div> </div> </div> </div> </body></html>
20 changes: 5 additions & 15 deletions snapshots/tng/elements/flickable/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,25 +121,15 @@ <h2 id="pointer-event-interaction">Pointer Event Interaction</h2>
to the coordinates of the press event exceeds 8 logical pixels.</li>
</ol>
<h3 id="interactive"><code dir="auto">interactive</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/" dir="auto"> <code>bool</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">true</code><br> </p> <p>When true, the viewport can be scrolled by clicking on it and dragging it with the cursor.</p> </div>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/" dir="auto"> <code>bool</code> </a> <br> <strong>default:</strong> <code dir="auto">true</code><br> </p> <p>When true, the viewport can be scrolled by clicking on it and dragging it with the cursor.</p> </div>
<h3 id="viewport-width"><code dir="auto">viewport-width</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/" dir="auto"> <code>length</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The total width of the scrollable element.</p> </div>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/" dir="auto"> <code>length</code> </a> <br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The total width of the scrollable element.</p> </div>
<h3 id="viewport-height"><code dir="auto">viewport-height</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/" dir="auto"> <code>length</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The total height of the scrollable element.</p> </div>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/" dir="auto"> <code>length</code> </a> <br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The total height of the scrollable element.</p> </div>
<h3 id="viewport-x"><code dir="auto">viewport-x</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/" dir="auto"> <code>length</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The position of the scrollable element relative to the <code dir="auto">Flickable</code>. This is usually a negative value.</p> </div>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/" dir="auto"> <code>length</code> </a> <br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The position of the scrollable element relative to the <code dir="auto">Flickable</code>. This is usually a negative value.</p> </div>
<h3 id="viewport-y"><code dir="auto">viewport-y</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/" dir="auto"> <code>length</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The position of the scrollable element relative to the <code dir="auto">Flickable</code>. This is usually a negative value.</p> </div>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/" dir="auto"> <code>length</code> </a> <br> <strong>default:</strong> <code dir="auto">0px</code><br> </p> <p>The position of the scrollable element relative to the <code dir="auto">Flickable</code>. This is usually a negative value.</p> </div>
<h2 id="callbacks">Callbacks</h2>
<h3 id="flicked"><code dir="auto">flicked()</code></h3>
<p>Invoked when <code dir="auto">viewport-x</code> or <code dir="auto">viewport-y</code> is changed by a user action (dragging, scrolling).</p> </div> <footer class="sl-flex astro-eifwj7ft"> <div class="meta sl-flex astro-eifwj7ft"> </div> <div class="pagination-links astro-dyqvxwuo" dir="ltr"> <a href="/tng/elements/dialog/" rel="prev" class="astro-dyqvxwuo"> <svg aria-hidden="true" class="astro-dyqvxwuo astro-6uleiwf3" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17 11H9.41l3.3-3.29a1.004 1.004 0 1 0-1.42-1.42l-5 5a1 1 0 0 0-.21.33 1 1 0 0 0 0 .76 1 1 0 0 0 .21.33l5 5a1.002 1.002 0 0 0 1.639-.325 1 1 0 0 0-.219-1.095L9.41 13H17a1 1 0 0 0 0-2Z"/></svg> <span class="astro-dyqvxwuo"> Previous <br class="astro-dyqvxwuo"> <span class="link-title astro-dyqvxwuo">Dialog</span> </span> </a> <a href="/tng/elements/focusscope/" rel="next" class="astro-dyqvxwuo"> <svg aria-hidden="true" class="astro-dyqvxwuo astro-6uleiwf3" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17.92 11.62a1.001 1.001 0 0 0-.21-.33l-5-5a1.003 1.003 0 1 0-1.42 1.42l3.3 3.29H7a1 1 0 0 0 0 2h7.59l-3.3 3.29a1.002 1.002 0 0 0 .325 1.639 1 1 0 0 0 1.095-.219l5-5a1 1 0 0 0 .21-.33 1 1 0 0 0 0-.76Z"/></svg> <span class="astro-dyqvxwuo"> Next <br class="astro-dyqvxwuo"> <span class="link-title astro-dyqvxwuo">FocusScope</span> </span> </a> </div> </footer> </div> </div> </main> </div> </div> </div> </div> </body></html>
8 changes: 2 additions & 6 deletions snapshots/tng/elements/focusscope/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,9 @@
or it will be mapped to a private unicode character. The mapping of these non-printable, special characters is available in the <a href="namespaces.md#key"><code dir="auto">Key</code></a> namespace</p>
<h2 id="properties">Properties</h2>
<h3 id="has-focus"><code dir="auto">has-focus</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/" dir="auto"> <code>bool</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">false</code><br> </p> <p>Is <code dir="auto">true</code> when the element has keyboard focus.</p> </div>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/" dir="auto"> <code>bool</code> </a> <code>(out)</code> <br> <strong>default:</strong> <code dir="auto">false</code><br> </p> <p>Is <code dir="auto">true</code> when the element has keyboard focus.</p> </div>
<h3 id="enabled"><code dir="auto">enabled</code></h3>
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/guide/types/" dir="auto"> <code>bool</code> </a>
(<code>in</code>)
<br> <strong>default:</strong> <code dir="auto">true</code><br> </p> <p>When true, the <code dir="auto">FocusScope</code> will make itself the focused element when clicked. Set this to false if you don’t want the click-to-focus
<div class="sl-markdown-content"> <p> <strong>type:</strong> <a href="/tng/guide/types/" dir="auto"> <code>bool</code> </a> <br> <strong>default:</strong> <code dir="auto">true</code><br> </p> <p>When true, the <code dir="auto">FocusScope</code> will make itself the focused element when clicked. Set this to false if you don’t want the click-to-focus
behavior. Similarly, a disabled <code dir="auto">FocusScope</code> does not accept the focus via tab focus traversal. A parent <code dir="auto">FocusScope</code> will still receive key events from
child <code dir="auto">FocusScope</code>s that were rejected, even if <code dir="auto">enabled</code> is set to false.</p> </div>
<h2 id="functions">Functions</h2>
Expand Down
Loading

0 comments on commit 9b64342

Please sign in to comment.