89 lines
No EOL
17 KiB
HTML
89 lines
No EOL
17 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="Handler trait for DataSource events."><title>DataSourceHandler in cosmic::cctk::sctk::data_device_manager::data_source - 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="#">Data<wbr>Source<wbr>Handler</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.accept_mime" title="accept_mime">accept_mime</a></li><li><a href="#tymethod.action" title="action">action</a></li><li><a href="#tymethod.cancelled" title="cancelled">cancelled</a></li><li><a href="#tymethod.dnd_dropped" title="dnd_dropped">dnd_dropped</a></li><li><a href="#tymethod.dnd_finished" title="dnd_finished">dnd_finished</a></li><li><a href="#tymethod.send_request" title="send_request">send_request</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>data_<wbr>device_<wbr>manager::<wbr>data_<wbr>source</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">data_device_manager</a>::<wbr><a href="index.html">data_source</a></div><h1>Trait <span class="trait">DataSourceHandler</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 DataSourceHandler: <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.accept_mime" class="fn">accept_mime</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
mime: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../reexports/client/backend/smallvec/alloc/string/struct.String.html" title="struct cosmic::cctk::sctk::reexports::client::backend::smallvec::alloc::string::String">String</a>>,
|
|
);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.send_request" class="fn">send_request</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
mime: <a class="struct" href="../../reexports/client/backend/smallvec/alloc/string/struct.String.html" title="struct cosmic::cctk::sctk::reexports::client::backend::smallvec::alloc::string::String">String</a>,
|
|
fd: <a class="struct" href="../struct.WritePipe.html" title="struct cosmic::cctk::sctk::data_device_manager::WritePipe">WritePipe</a>,
|
|
);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.cancelled" class="fn">cancelled</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.dnd_dropped" class="fn">dnd_dropped</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.dnd_finished" class="fn">dnd_finished</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.action" class="fn">action</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
action: <a class="struct" href="../../reexports/client/protocol/wl_data_device_manager/struct.DndAction.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_device_manager::DndAction">DndAction</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><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Handler trait for DataSource events.</p>
|
|
<p>The functions defined in this trait are called as DataSource events are received from the compositor.</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.accept_mime" class="method"><h4 class="code-header">fn <a href="#tymethod.accept_mime" class="fn">accept_mime</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
mime: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../reexports/client/backend/smallvec/alloc/string/struct.String.html" title="struct cosmic::cctk::sctk::reexports::client::backend::smallvec::alloc::string::String">String</a>>,
|
|
)</h4></section></summary><div class="docblock"><p>This may be called multiple times, once for each accepted mime type from the destination, if any.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.send_request" class="method"><h4 class="code-header">fn <a href="#tymethod.send_request" class="fn">send_request</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
mime: <a class="struct" href="../../reexports/client/backend/smallvec/alloc/string/struct.String.html" title="struct cosmic::cctk::sctk::reexports::client::backend::smallvec::alloc::string::String">String</a>,
|
|
fd: <a class="struct" href="../struct.WritePipe.html" title="struct cosmic::cctk::sctk::data_device_manager::WritePipe">WritePipe</a>,
|
|
)</h4></section></summary><div class="docblock"><p>The client has requested the data for this source to be sent.
|
|
Send the data, then close the fd.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.cancelled" class="method"><h4 class="code-header">fn <a href="#tymethod.cancelled" class="fn">cancelled</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
)</h4></section></summary><div class="docblock"><p>The data source is no longer valid
|
|
Cleanup & destroy this resource</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.dnd_dropped" class="method"><h4 class="code-header">fn <a href="#tymethod.dnd_dropped" class="fn">dnd_dropped</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
)</h4></section></summary><div class="docblock"><p>A drop was performed.
|
|
The data source will be used and should not be destroyed yet</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.dnd_finished" class="method"><h4 class="code-header">fn <a href="#tymethod.dnd_finished" class="fn">dnd_finished</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
)</h4></section></summary><div class="docblock"><p>The drag and drop finished.
|
|
The data source may be destroyed.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.action" class="method"><h4 class="code-header">fn <a href="#tymethod.action" class="fn">action</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>,
|
|
source: &<a class="struct" href="../../reexports/client/protocol/wl_data_source/struct.WlDataSource.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_source::WlDataSource">WlDataSource</a>,
|
|
action: <a class="struct" href="../../reexports/client/protocol/wl_data_device_manager/struct.DndAction.html" title="struct cosmic::cctk::sctk::reexports::client::protocol::wl_data_device_manager::DndAction">DndAction</a>,
|
|
)</h4></section></summary><div class="docblock"><p>An action was selected by the compositor.</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/data_device_manager/data_source/trait.DataSourceHandler.js" async></script></section></div></main></body></html> |