|
|
|
|
|
<!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 `RequestsTrait` trait in crate `wayland_client`."><meta name="keywords" content="rust, rustlang, rust-lang, RequestsTrait"><title>wayland_client::protocol::wl_data_offer::RequestsTrait - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../wayland_client/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait RequestsTrait</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.accept">accept</a><a href="#tymethod.destroy">destroy</a><a href="#tymethod.finish">finish</a><a href="#tymethod.receive">receive</a><a href="#tymethod.set_actions">set_actions</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>wayland_client</a>::<wbr><a href='../index.html'>protocol</a>::<wbr><a href='index.html'>wl_data_offer</a></p><script>window.sidebarCurrent = {name: 'RequestsTrait', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/wayland_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>wayland_client</a>::<wbr><a href='../index.html'>protocol</a>::<wbr><a href='index.html'>wl_data_offer</a>::<wbr><a class="trait" href=''>RequestsTrait</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait RequestsTrait {
|
|
|
|
|
|
fn <a href='#tymethod.accept' class='fnname'>accept</a>(&self, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, mime_type: <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="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>);
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.receive' class='fnname'>receive</a>(&self, mime_type: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, fd: <a class="type" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/type.RawFd.html" title="type std::sys::unix::ext::io::RawFd">RawFd</a>);
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.destroy' class='fnname'>destroy</a>(&self);
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.finish' class='fnname'>finish</a>(&self);
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_actions' class='fnname'>set_actions</a>(&self, dnd_actions: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, preferred_action: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>);
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.accept' class='method'><code id='accept.v'>fn <a href='#tymethod.accept' class='fnname'>accept</a>(&self, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, mime_type: <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="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>)</code></h3><div class='docblock'><p>accept one of the offered mime types</p>
|
|
|
|
|
|
<p>Indicate that the client can accept the given mime type, or
|
|
|
|
|
|
NULL for not accepted.</p>
|
|
|
|
|
|
<p>For objects of version 2 or older, this request is used by the
|
|
|
|
|
|
client to give feedback whether the client can receive the given
|
|
|
|
|
|
mime type, or NULL if none is accepted; the feedback does not
|
|
|
|
|
|
determine whether the drag-and-drop operation succeeds or not.</p>
|
|
|
|
|
|
<p>For objects of version 3 or newer, this request determines the
|
|
|
|
|
|
final result of the drag-and-drop operation. If the end result
|
|
|
|
|
|
is that no mime types were accepted, the drag-and-drop operation
|
|
|
|
|
|
will be cancelled and the corresponding drag source will receive
|
|
|
|
|
|
wl_data_source.cancelled. Clients may still use this event in
|
|
|
|
|
|
conjunction with wl_data_source.action for feedback.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.receive' class='method'><code id='receive.v'>fn <a href='#tymethod.receive' class='fnname'>receive</a>(&self, mime_type: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, fd: <a class="type" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/type.RawFd.html" title="type std::sys::unix::ext::io::RawFd">RawFd</a>)</code></h3><div class='docblock'><p>request that the data is transferred</p>
|
|
|
|
|
|
<p>To transfer the offered data, the client issues this request
|
|
|
|
|
|
and indicates the mime type it wants to receive. The transfer
|
|
|
|
|
|
happens through the passed file descriptor (typically created
|
|
|
|
|
|
with the pipe system call). The source client writes the data
|
|
|
|
|
|
in the mime type representation requested and then closes the
|
|
|
|
|
|
file descriptor.</p>
|
|
|
|
|
|
<p>The receiving client reads from the read end of the pipe until
|
|
|
|
|
|
EOF and then closes its end, at which point the transfer is
|
|
|
|
|
|
complete.</p>
|
|
|
|
|
|
<p>This request may happen multiple times for different mime types,
|
|
|
|
|
|
both before and after wl_data_device.drop. Drag-and-drop destination
|
|
|
|
|
|
clients may preemptively fetch data or examine it more closely to
|
|
|
|
|
|
determine acceptance.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.destroy' class='method'><code id='destroy.v'>fn <a href='#tymethod.destroy' class='fnname'>destroy</a>(&self)</code></h3><div class='docblock'><p>destroy data offer</p>
|
|
|
|
|
|
<p>Destroy the data offer.</p>
|
|
|
|
|
|
<p>This is a destructor, you cannot send requests to this object any longer once this method is called.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.finish' class='method'><code id='finish.v'>fn <a href='#tymethod.finish' class='fnname'>finish</a>(&self)</code></h3><div class='docblock'><p>the offer will no longer be used</p>
|
|
|
|
|
|
<p>Notifies the compositor that the drag destination successfully
|
|
|
|
|
|
finished the drag-and-drop operation.</p>
|
|
|
|
|
|
<p>Upon receiving this request, the compositor will emit
|
|
|
|
|
|
wl_data_source.dnd_finished on the drag source client.</p>
|
|
|
|
|
|
<p>It is a client error to perform other requests than
|
|
|
|
|
|
wl_data_offer.destroy after this one. It is also an error to perform
|
|
|
|
|
|
this request after a NULL mime type has been set in
|
|
|
|
|
|
wl_data_offer.accept or no action was received through
|
|
|
|
|
|
wl_data_offer.action.</p>
|
|
|
|
|
|
<p>Only available since version 3 of the interface.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.set_actions' class='method'><code id='set_actions.v'>fn <a href='#tymethod.set_actions' class='fnname'>set_actions</a>(&self, dnd_actions: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, preferred_action: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></h3><div class='docblock'><p>set the available/preferred drag-and-drop actions</p>
|
|
|
|
|
|
<p>Sets the actions that the destination side client supports for
|
|
|
|
|
|
this operation. This request may trigger the emission of
|
|
|
|
|
|
wl_data_source.action and wl_data_offer.action events if the compositor
|
|
|
|
|
|
needs to change the selected action.</p>
|
|
|
|
|
|
<p>This request can be called multiple times throughout the
|
|
|
|
|
|
drag-and-drop operation, typically in response to wl_data_device.enter
|
|
|
|
|
|
or wl_data_device.motion events.</p>
|
|
|
|
|
|
<p>This request determines the final result of the drag-and-drop
|
|
|
|
|
|
operation. If the end result is that no action is accepted,
|
|
|
|
|
|
the drag source will receive wl_drag_source.cancelled.</p>
|
|
|
|
|
|
<p>The dnd_actions argument must contain only values expressed in the
|
|
|
|
|
|
wl_data_device_manager.dnd_actions enum, and the preferred_action
|
|
|
|
|
|
argument must only contain one of those values set, otherwise it
|
|
|
|
|
|
will result in a protocol error.</p>
|
|
|
|
|
|
<p>While managing an "ask" action, the destination drag-and-drop client
|
|
|
|
|
|
may perform further wl_data_offer.receive requests, and is expected
|
|
|
|
|
|
to perform one last wl_data_offer.set_actions request with a preferred
|
|
|
|
|
|
action other than "ask" (and optionally wl_data_offer.accept) before
|
|
|
|
|
|
requesting wl_data_offer.finish, in order to convey the action selected
|
|
|
|
|
|
by the user. If the preferred action is not in the
|
|
|
|
|
|
wl_data_offer.source_actions mask, an error will be raised.</p>
|
|
|
|
|
|
<p>If the "ask" action is dismissed (e.g. user cancellation), the client
|
|
|
|
|
|
is expected to perform wl_data_offer.destroy right away.</p>
|
|
|
|
|
|
<p>This request can only be made on drag-and-drop offers, a protocol error
|
|
|
|
|
|
will be raised otherwise.</p>
|
|
|
|
|
|
<p>Only available since version 3 of the interface.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-RequestsTrait' class='impl'><code class='in-band'>impl RequestsTrait for <a class="struct" href="../../../wayland_client/struct.Proxy.html" title="struct wayland_client::Proxy">Proxy</a><<a class="struct" href="../../../wayland_client/protocol/wl_data_offer/struct.WlDataOffer.html" title="struct wayland_client::protocol::wl_data_offer::WlDataOffer">WlDataOffer</a>></code><a href='#impl-RequestsTrait' class='anchor'></a><a class='srclink' href='../../../src/wayland_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.accept' class="method hidden"><code id='accept.v-1'>fn <a href='#method.accept' class='fnname'>accept</a>(&self, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, mime_type: <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="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>)</code><a class='srclink' href='../../../src/wayland_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></h4><h4 id='method.receive' class="method hidden"><code id='receive.v-1'>fn <a href='#method.receive' class='fnname'>receive</a>(&self, mime_type: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, fd: <a class="type" href="https://doc.rust-lang.org/nightly/std/sys/unix/ext/io/type.RawFd.html" title="type std::sys::unix::ext::io::RawFd">RawFd</a>)</code><a class='srclink' href='../../../src/wayland_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></h4><h4 id='method.destroy' class="method hidden"><code id='destroy.v-1'>fn <a href='#method.destroy' class='fnname'>destroy</a>(&self)</code><a class='srclink' href='../../../src/wayland_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></h4><h4 id='method.finish' class="method hidden"><code id='finish.v-1'>fn <a href='#method.finish' class='fnname'>finish</a>(&self)</code><a class='srclink' href='../../../src/wayland_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></h4><h4 id='method.set_actions' class="method hidden"><code id='set_actions.v-1'>fn <a href='#method.set_actions' class='fnname'>set_actions</a>(&self, dnd_actions: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, preferred_action: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class='srclink' href='../../../src/wayland_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../../../implementors/wayland_client/protocol/wl_data_offer/trait.RequestsTrait.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "wayland_client";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|
