24 lines
6.2 KiB
HTML
24 lines
6.2 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Handles activation of the application’s accessibility implementation."><title>ActivationHandler in accesskit - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="accesskit" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../accesskit/index.html">accesskit</a><span class="version">0.17.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Activation<wbr>Handler</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.request_initial_tree" title="request_initial_tree">request_initial_tree</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate accesskit</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">accesskit</a></span><h1>Trait <span class="trait">ActivationHandler</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/accesskit/lib.rs.html#2349-2372">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ActivationHandler {
|
||
// Required method
|
||
fn <a href="#tymethod.request_initial_tree" class="fn">request_initial_tree</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.TreeUpdate.html" title="struct accesskit::TreeUpdate">TreeUpdate</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Handles activation of the application’s accessibility implementation.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.request_initial_tree" class="method"><a class="src rightside" href="../src/accesskit/lib.rs.html#2371">Source</a><h4 class="code-header">fn <a href="#tymethod.request_initial_tree" class="fn">request_initial_tree</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.TreeUpdate.html" title="struct accesskit::TreeUpdate">TreeUpdate</a>></h4></section></summary><div class="docblock"><p>Requests a <a href="struct.TreeUpdate.html" title="struct accesskit::TreeUpdate"><code>TreeUpdate</code></a> with a full tree. If the application
|
||
can generate the tree synchronously within this method call,
|
||
it should do so and return the <a href="struct.TreeUpdate.html" title="struct accesskit::TreeUpdate"><code>TreeUpdate</code></a>. Otherwise,
|
||
it must send the update to the platform adapter asynchronously,
|
||
no later than the next display refresh, even if a frame would not
|
||
normally be rendered due to user input or other activity.
|
||
The application should not return or send a placeholder <a href="struct.TreeUpdate.html" title="struct accesskit::TreeUpdate"><code>TreeUpdate</code></a>;
|
||
the platform adapter will provide one if necessary until the real
|
||
tree is sent.</p>
|
||
<p>The primary purpose of this method is to allow the application
|
||
to lazily initialize its accessibility implementation. However,
|
||
this method may be called consecutively without any call to
|
||
<a href="trait.DeactivationHandler.html#tymethod.deactivate_accessibility" title="method accesskit::DeactivationHandler::deactivate_accessibility"><code>DeactivationHandler::deactivate_accessibility</code></a>; this typically happens
|
||
if the platform adapter merely forwards tree updates to assistive
|
||
technologies without maintaining any state. A call to this method
|
||
must always generate a <a href="struct.TreeUpdate.html" title="struct accesskit::TreeUpdate"><code>TreeUpdate</code></a> with a full tree, even if
|
||
the application normally sends incremental updates.</p>
|
||
<p>The thread on which this method is called is platform-dependent.
|
||
Refer to the platform adapter documentation for more details.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/accesskit/trait.ActivationHandler.js" async></script></section></div></main></body></html> |