|
|
<!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_positioner::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.set_anchor">set_anchor</a><a href="#tymethod.set_anchor_rect">set_anchor_rect</a><a href="#tymethod.set_constraint_adjustment">set_constraint_adjustment</a><a href="#tymethod.set_gravity">set_gravity</a><a href="#tymethod.set_offset">set_offset</a><a href="#tymethod.set_size">set_size</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-RequestsTrait-for-Proxy%3CXdgPositioner%3E">Proxy<XdgPositioner></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_positioner</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_positioner</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.set_size' class='fnname'>set_size</a>(&self, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_anchor_rect' class='fnname'>set_anchor_rect</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_anchor' class='fnname'>set_anchor</a>(&self, anchor: <a class="enum" href="../../../../wayland_protocols/xdg_shell/client/xdg_positioner/enum.Anchor.html" title="enum wayland_protocols::xdg_shell::client::xdg_positioner::Anchor">Anchor</a>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_gravity' class='fnname'>set_gravity</a>(&self, gravity: <a class="enum" href="../../../../wayland_protocols/xdg_shell/client/xdg_positioner/enum.Gravity.html" title="enum wayland_protocols::xdg_shell::client::xdg_positioner::Gravity">Gravity</a>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_constraint_adjustment' class='fnname'>set_constraint_adjustment</a>(&self, constraint_adjustment: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_offset' class='fnname'>set_offset</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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>destroy the xdg_positioner object</p>
|
|
|
<p>Notify the compositor that the xdg_positioner will no longer be used.</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.set_size' class='method'><code id='set_size.v'>fn <a href='#tymethod.set_size' class='fnname'>set_size</a>(&self, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>)</code></h3><div class='docblock'><p>set the size of the to-be positioned rectangle</p>
|
|
|
<p>Set the size of the surface that is to be positioned with the positioner
|
|
|
object. The size is in surface-local coordinates and corresponds to the
|
|
|
window geometry. See xdg_surface.set_window_geometry.</p>
|
|
|
<p>If a zero or negative size is set the invalid_input error is raised.</p>
|
|
|
</div><h3 id='tymethod.set_anchor_rect' class='method'><code id='set_anchor_rect.v'>fn <a href='#tymethod.set_anchor_rect' class='fnname'>set_anchor_rect</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>)</code></h3><div class='docblock'><p>set the anchor rectangle within the parent surface</p>
|
|
|
<p>Specify the anchor rectangle within the parent surface that the child
|
|
|
surface will be placed relative to. The rectangle is relative to the
|
|
|
window geometry as defined by xdg_surface.set_window_geometry of the
|
|
|
parent surface.</p>
|
|
|
<p>When the xdg_positioner object is used to position a child surface, the
|
|
|
anchor rectangle may not extend outside the window geometry of the
|
|
|
positioned child's parent surface.</p>
|
|
|
<p>If a negative size is set the invalid_input error is raised.</p>
|
|
|
</div><h3 id='tymethod.set_anchor' class='method'><code id='set_anchor.v'>fn <a href='#tymethod.set_anchor' class='fnname'>set_anchor</a>(&self, anchor: <a class="enum" href="../../../../wayland_protocols/xdg_shell/client/xdg_positioner/enum.Anchor.html" title="enum wayland_protocols::xdg_shell::client::xdg_positioner::Anchor">Anchor</a>)</code></h3><div class='docblock'><p>set anchor rectangle anchor</p>
|
|
|
<p>Defines the anchor point for the anchor rectangle. The specified anchor
|
|
|
is used derive an anchor point that the child surface will be
|
|
|
positioned relative to. If a corner anchor is set (e.g. 'top_left' or
|
|
|
'bottom_right'), the anchor point will be at the specified corner;
|
|
|
otherwise, the derived anchor point will be centered on the specified
|
|
|
edge, or in the center of the anchor rectangle if no edge is specified.</p>
|
|
|
</div><h3 id='tymethod.set_gravity' class='method'><code id='set_gravity.v'>fn <a href='#tymethod.set_gravity' class='fnname'>set_gravity</a>(&self, gravity: <a class="enum" href="../../../../wayland_protocols/xdg_shell/client/xdg_positioner/enum.Gravity.html" title="enum wayland_protocols::xdg_shell::client::xdg_positioner::Gravity">Gravity</a>)</code></h3><div class='docblock'><p>set child surface gravity</p>
|
|
|
<p>Defines in what direction a surface should be positioned, relative to
|
|
|
the anchor point of the parent surface. If a corner gravity is
|
|
|
specified (e.g. 'bottom_right' or 'top_left'), then the child surface
|
|
|
will be placed towards the specified gravity; otherwise, the child
|
|
|
surface will be centered over the anchor point on any axis that had no
|
|
|
gravity specified.</p>
|
|
|
</div><h3 id='tymethod.set_constraint_adjustment' class='method'><code id='set_constraint_adjustment.v'>fn <a href='#tymethod.set_constraint_adjustment' class='fnname'>set_constraint_adjustment</a>(&self, constraint_adjustment: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></h3><div class='docblock'><p>set the adjustment to be done when constrained</p>
|
|
|
<p>Specify how the window should be positioned if the originally intended
|
|
|
position caused the surface to be constrained, meaning at least
|
|
|
partially outside positioning boundaries set by the compositor. The
|
|
|
adjustment is set by constructing a bitmask describing the adjustment to
|
|
|
be made when the surface is constrained on that axis.</p>
|
|
|
<p>If no bit for one axis is set, the compositor will assume that the child
|
|
|
surface should not change its position on that axis when constrained.</p>
|
|
|
<p>If more than one bit for one axis is set, the order of how adjustments
|
|
|
are applied is specified in the corresponding adjustment descriptions.</p>
|
|
|
<p>The default adjustment is none.</p>
|
|
|
</div><h3 id='tymethod.set_offset' class='method'><code id='set_offset.v'>fn <a href='#tymethod.set_offset' class='fnname'>set_offset</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>)</code></h3><div class='docblock'><p>set surface position offset</p>
|
|
|
<p>Specify the surface position offset relative to the position of the
|
|
|
anchor on the anchor rectangle and the anchor on the surface. For
|
|
|
example if the anchor of the anchor rectangle is at (x, y), the surface
|
|
|
has the gravity bottom|right, and the offset is (ox, oy), the calculated
|
|
|
surface position will be (x + ox, y + oy). The offset position of the
|
|
|
surface is the one used for constraint testing. See
|
|
|
set_constraint_adjustment.</p>
|
|
|
<p>An example use case is placing a popup menu on top of a user interface
|
|
|
element, while aligning the user interface element of the parent surface
|
|
|
with some user interface element placed somewhere in the popup surface.</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%3CXdgPositioner%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../wayland_protocols/xdg_shell/client/xdg_positioner/trait.RequestsTrait.html" title="trait wayland_protocols::xdg_shell::client::xdg_positioner::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_positioner/struct.XdgPositioner.html" title="struct wayland_protocols::xdg_shell::client::xdg_positioner::XdgPositioner">XdgPositioner</a>></code><a href='#impl-RequestsTrait-for-Proxy%3CXdgPositioner%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.set_size' class="method hidden"><code id='set_size.v-1'>fn <a href='#method.set_size' class='fnname'>set_size</a>(&self, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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><h4 id='method.set_anchor_rect' class="method hidden"><code id='set_anchor_rect.v-1'>fn <a href='#method.set_anchor_rect' class='fnname'>set_anchor_rect</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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><h4 id='method.set_anchor' class="method hidden"><code id='set_anchor.v-1'>fn <a href='#method.set_anchor' class='fnname'>set_anchor</a>(&self, anchor: <a class="enum" href="../../../../wayland_protocols/xdg_shell/client/xdg_positioner/enum.Anchor.html" title="enum wayland_protocols::xdg_shell::client::xdg_positioner::Anchor">Anchor</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><h4 id='method.set_gravity' class="method hidden"><code id='set_gravity.v-1'>fn <a href='#method.set_gravity' class='fnname'>set_gravity</a>(&self, gravity: <a class="enum" href="../../../../wayland_protocols/xdg_shell/client/xdg_positioner/enum.Gravity.html" title="enum wayland_protocols::xdg_shell::client::xdg_positioner::Gravity">Gravity</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><h4 id='method.set_constraint_adjustment' class="method hidden"><code id='set_constraint_adjustment.v-1'>fn <a href='#method.set_constraint_adjustment' class='fnname'>set_constraint_adjustment</a>(&self, constraint_adjustment: <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><h4 id='method.set_offset' class="method hidden"><code id='set_offset.v-1'>fn <a href='#method.set_offset' class='fnname'>set_offset</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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_positioner/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> |
