117 lines
No EOL
19 KiB
HTML
117 lines
No EOL
19 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="API documentation for the Rust `TouchHandler` trait in crate `cosmic`."><title>TouchHandler in cosmic::cctk::sctk::seat::touch - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../../" data-static-root-path="../../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../../static.files/storage-68b7e25d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-32bb7600.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="../../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Touch<wbr>Handler</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.cancel" title="cancel">cancel</a></li><li><a href="#tymethod.down" title="down">down</a></li><li><a href="#tymethod.motion" title="motion">motion</a></li><li><a href="#tymethod.orientation" title="orientation">orientation</a></li><li><a href="#tymethod.shape" title="shape">shape</a></li><li><a href="#tymethod.up" title="up">up</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>seat::<wbr>touch</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../../index.html">cosmic</a>::<wbr><a href="../../../index.html">cctk</a>::<wbr><a href="../../index.html">sctk</a>::<wbr><a href="../index.html">seat</a>::<wbr><a href="index.html">touch</a></div><h1>Trait <span class="trait">TouchHandler</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub trait TouchHandler: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.down" class="fn">down</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
surface: <a class="struct" href="../../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
position: (<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>),
|
||
);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.up" class="fn">up</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.motion" class="fn">motion</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
position: (<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>),
|
||
);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.shape" class="fn">shape</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
major: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,
|
||
minor: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,
|
||
);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.orientation" class="fn">orientation</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
orientation: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,
|
||
);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.cancel" class="fn">cancel</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
);
|
||
}</code></pre><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>wayland</code> and Linux</strong> only.</div></span><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.down" class="method"><h4 class="code-header">fn <a href="#tymethod.down" class="fn">down</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
surface: <a class="struct" href="../../reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
position: (<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>),
|
||
)</h4></section></summary><div class="docblock"><p>New touch point.</p>
|
||
<p>Indicates a new touch point has appeared on the surface, starting a touch sequence. The ID
|
||
associated with this event identifies this touch point for devices with multi-touch and
|
||
will be referenced in future events.</p>
|
||
<p>The associated touch ID ceases to be valid after the touch up event with the associated ID
|
||
and may be reused for other touch points after that.</p>
|
||
<p>Coordinates are surface-local.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.up" class="method"><h4 class="code-header">fn <a href="#tymethod.up" class="fn">up</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
)</h4></section></summary><div class="docblock"><p>End of touch sequence.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.motion" class="method"><h4 class="code-header">fn <a href="#tymethod.motion" class="fn">motion</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
position: (<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>),
|
||
)</h4></section></summary><div class="docblock"><p>Touch point motion.</p>
|
||
<p>Coordinates are surface-local.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.shape" class="method"><h4 class="code-header">fn <a href="#tymethod.shape" class="fn">shape</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
major: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,
|
||
minor: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,
|
||
)</h4></section></summary><div class="docblock"><p>Touch point shape change.</p>
|
||
<p>The shape of a touch point is approximated by an ellipse through the major and minor axis
|
||
length. Major always represents the larger of the two axis and is orthogonal to minor.</p>
|
||
<p>The dimensions are specified in surface-local coordinates and the locations reported by
|
||
other events always report the center of the ellipse.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.orientation" class="method"><h4 class="code-header">fn <a href="#tymethod.orientation" class="fn">orientation</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>,
|
||
id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
orientation: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,
|
||
)</h4></section></summary><div class="docblock"><p>Touch point shape orientation.</p>
|
||
<p>The orientation describes the clockwise angle of a touch point’s major axis to the positive
|
||
surface y-axis and is normalized to the -180° to +180° range.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.cancel" class="method"><h4 class="code-header">fn <a href="#tymethod.cancel" class="fn">cancel</a>(&mut self, conn: &<a class="struct" href="../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>, qh: &<a class="struct" href="../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>, touch: &<a class="struct" href="../../reexports/client/protocol/wl_touch/struct.WlTouch.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_touch::WlTouch">WlTouch</a>)</h4></section></summary><div class="docblock"><p>Cancel active touch sequence.</p>
|
||
<p>This indicates that the compositor has cancelled the active touch sequence, for example due
|
||
to detection of a touch gesture.</p>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../../../trait.impl/smithay_client_toolkit/seat/touch/trait.TouchHandler.js" async></script></section></div></main></body></html> |