mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4b8fffc6bf'
${ noResults }
Trac3r-rust/doc/wayland_protocols/xdg_shell/client/xdg_positioner/index.html

30 lines
10 KiB
Raw Normal View History Unescape

add doc
5 years ago
<!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 `xdg_positioner` mod in crate `wayland_protocols`."><meta name="keywords" content="rust, rustlang, rust-lang, xdg_positioner"><title>wayland_protocols::xdg_shell::client::xdg_positioner - 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 mod"><!--[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">&#9776;</div><a href='../../../../wayland_protocols/index.html'><div class='logo-container'><img src='../../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module xdg_positioner</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li></ul></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></p><script>window.sidebarCurrent = {name: 'xdg_positioner', ty: 'mod', 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'>&#x2212;</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'>Module <a href='../../../index.html'>wayland_protocols</a>::<wbr><a href='../../index.html'>xdg_shell</a>::<wbr><a href='../index.html'>client</a>::<wbr><a class="mod" href=''>xdg_positioner</a></span></h1><div class='docblock'><p>child surface positioner</p>
<p>The xdg_positioner provides a collection of rules for the placement of a
child surface relative to a parent surface. Rules can be defined to ensure
the child surface remains within the visible area's borders, and to
specify how the child surface changes its position, such as sliding along
an axis, or flipping around a rectangle. These positioner-created rules are
constrained by the requirement that a child surface must intersect with or
be at least partially adjacent to its parent surface.</p>
<p>See the various requests for details about possible rules.</p>
<p>At the time of the request, the compositor makes a copy of the rules
specified by the xdg_positioner. Thus, after the request is complete the
xdg_positioner object can be destroyed or reused; further changes to the
object will have no effect on previous usages.</p>
<p>For an xdg_positioner object to be considered complete, it must have a
non-zero size set by set_size, and a non-zero anchor rectangle set by
set_anchor_rect. Passing an incomplete xdg_positioner object when
positioning a surface raises an error.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.ConstraintAdjustment.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::ConstraintAdjustment struct'>ConstraintAdjustment</a></td><td class='docblock-short'><p>constraint adjustments</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.XdgPositioner.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::XdgPositioner struct'>XdgPositioner</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.Anchor.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::Anchor enum'>Anchor</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Error.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::Error enum'>Error</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Event.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::Event enum'>Event</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Gravity.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::Gravity enum'>Gravity</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Request.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::Request enum'>Request</a></td><td class='docblock-short'></td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table><tr class='module-item'><td><a class="constant" href="constant.REQ_DESTROY_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::REQ_DESTROY_SINCE constant'>REQ_DESTROY_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this request</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REQ_SET_ANCHOR_RECT_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::REQ_SET_ANCHOR_RECT_SINCE constant'>REQ_SET_ANCHOR_RECT_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this request</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REQ_SET_ANCHOR_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::REQ_SET_ANCHOR_SINCE constant'>REQ_SET_ANCHOR_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this request</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REQ_SET_CONSTRAINT_ADJUSTMENT_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::REQ_SET_CONSTRAINT_ADJUSTMENT_SINCE constant'>REQ_SET_CONSTRAINT_ADJUSTMENT_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this request</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REQ_SET_GRAVITY_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::REQ_SET_GRAVITY_SINCE constant'>REQ_SET_GRAVITY_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this request</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REQ_SET_OFFSET_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::REQ_SET_OFFSET_SINCE constant'>REQ_SET_OFFSET_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this request</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REQ_SET_SIZE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::REQ_SET_SIZE_SINCE constant'>REQ_SET_SIZE_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this request</p>
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.RequestsTrait.html" title='wayland_protocols::xdg_shell::client::xdg_positioner::RequestsTrait trait'>RequestsTrait</a></td><td class='docblock-short'></td></tr></table></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>&#9166;</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>