|
|
<!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_protocols`."><meta name="keywords" content="rust, rustlang, rust-lang, RequestsTrait"><title>wayland_protocols::xdg_shell::client::xdg_popup::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_protocols/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.destroy">destroy</a><a href="#tymethod.grab">grab</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-RequestsTrait-for-Proxy%3CXdgPopup%3E">Proxy<XdgPopup></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../../index.html'>wayland_protocols</a>::<wbr><a href='../../index.html'>xdg_shell</a>::<wbr><a href='../index.html'>client</a>::<wbr><a href='index.html'>xdg_popup</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_protocols/home/mrh/source/Trac3r-rust/target/debug/build/wayland-protocols-1a9f4751ab847ca9/out/xdg-shell_c_client_api.rs.html#1' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../../index.html'>wayland_protocols</a>::<wbr><a href='../../index.html'>xdg_shell</a>::<wbr><a href='../index.html'>client</a>::<wbr><a href='index.html'>xdg_popup</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.destroy' class='fnname'>destroy</a>(&self);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.grab' class='fnname'>grab</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <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.destroy' class='method'><code id='destroy.v'>fn <a href='#tymethod.destroy' class='fnname'>destroy</a>(&self)</code></h3><div class='docblock'><p>remove xdg_popup interface</p>
|
|
|
<p>This destroys the popup. Explicitly destroying the xdg_popup
|
|
|
object will also dismiss the popup, and unmap the surface.</p>
|
|
|
<p>If this xdg_popup is not the "topmost" popup, a protocol error
|
|
|
will be sent.</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.grab' class='method'><code id='grab.v'>fn <a href='#tymethod.grab' class='fnname'>grab</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></h3><div class='docblock'><p>make the popup take an explicit grab</p>
|
|
|
<p>This request makes the created popup take an explicit grab. An explicit
|
|
|
grab will be dismissed when the user dismisses the popup, or when the
|
|
|
client destroys the xdg_popup. This can be done by the user clicking
|
|
|
outside the surface, using the keyboard, or even locking the screen
|
|
|
through closing the lid or a timeout.</p>
|
|
|
<p>If the compositor denies the grab, the popup will be immediately
|
|
|
dismissed.</p>
|
|
|
<p>This request must be used in response to some sort of user action like a
|
|
|
button press, key press, or touch down event. The serial number of the
|
|
|
event should be passed as 'serial'.</p>
|
|
|
<p>The parent of a grabbing popup must either be an xdg_toplevel surface or
|
|
|
another xdg_popup with an explicit grab. If the parent is another
|
|
|
xdg_popup it means that the popups are nested, with this popup now being
|
|
|
the topmost popup.</p>
|
|
|
<p>Nested popups must be destroyed in the reverse order they were created
|
|
|
in, e.g. the only popup you are allowed to destroy at all times is the
|
|
|
topmost one.</p>
|
|
|
<p>When compositors choose to dismiss a popup, they may dismiss every
|
|
|
nested grabbing popup as well. When a compositor dismisses popups, it
|
|
|
will follow the same dismissing order as required from the client.</p>
|
|
|
<p>The parent of a grabbing popup must either be another xdg_popup with an
|
|
|
active explicit grab, or an xdg_popup or xdg_toplevel, if there are no
|
|
|
explicit grabs already taken.</p>
|
|
|
<p>If the topmost grabbing popup is destroyed, the grab will be returned to
|
|
|
the parent of the popup, if that parent previously had an explicit grab.</p>
|
|
|
<p>If the parent is a grabbing popup which has already been dismissed, this
|
|
|
popup will be immediately dismissed. If the parent is a popup that did
|
|
|
not take an explicit grab, an error will be raised.</p>
|
|
|
<p>During a popup grab, the client owning the grab will receive pointer
|
|
|
and touch events for all their surfaces as normal (similar to an
|
|
|
"owner-events" grab in X11 parlance), while the top most grabbing popup
|
|
|
will always have keyboard focus.</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-RequestsTrait-for-Proxy%3CXdgPopup%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../wayland_protocols/xdg_shell/client/xdg_popup/trait.RequestsTrait.html" title="trait wayland_protocols::xdg_shell::client::xdg_popup::RequestsTrait">RequestsTrait</a> for <a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_protocols/xdg_shell/client/xdg_popup/struct.XdgPopup.html" title="struct wayland_protocols::xdg_shell::client::xdg_popup::XdgPopup">XdgPopup</a>></code><a href='#impl-RequestsTrait-for-Proxy%3CXdgPopup%3E' class='anchor'></a><a class='srclink' href='../../../../src/wayland_protocols/home/mrh/source/Trac3r-rust/target/debug/build/wayland-protocols-1a9f4751ab847ca9/out/xdg-shell_c_client_api.rs.html#1' title='goto source code'>[src]</a></h3><div class='impl-items'><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_protocols/home/mrh/source/Trac3r-rust/target/debug/build/wayland-protocols-1a9f4751ab847ca9/out/xdg-shell_c_client_api.rs.html#1' title='goto source code'>[src]</a></h4><h4 id='method.grab' class="method hidden"><code id='grab.v-1'>fn <a href='#method.grab' class='fnname'>grab</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class='srclink' href='../../../../src/wayland_protocols/home/mrh/source/Trac3r-rust/target/debug/build/wayland-protocols-1a9f4751ab847ca9/out/xdg-shell_c_client_api.rs.html#1' title='goto source code'>[src]</a></h4></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'></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_protocols/xdg_shell/client/xdg_popup/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_protocols";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script defer src="../../../../search-index.js"></script></body></html> |
