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_popup/index.html

33 lines
8.6 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_popup` mod in crate `wayland_protocols`."><meta name="keywords" content="rust, rustlang, rust-lang, xdg_popup"><title>wayland_protocols::xdg_shell::client::xdg_popup - 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_popup</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_popup', 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_popup</a></span></h1><div class='docblock'><p>short-lived, popup surfaces for menus</p>
<p>A popup surface is a short-lived, temporary surface. It can be used to
implement for example menus, popovers, tooltips and other similar user
interface concepts.</p>
<p>A popup can be made to take an explicit grab. See xdg_popup.grab for
details.</p>
<p>When the popup is dismissed, a popup_done event will be sent out, and at
the same time the surface will be unmapped. See the xdg_popup.popup_done
event for details.</p>
<p>Explicitly destroying the xdg_popup object will also dismiss the popup and
unmap the surface. Clients that want to dismiss the popup when another
surface of their own is clicked should dismiss the popup using the destroy
request.</p>
<p>A newly created xdg_popup will be stacked on top of all previously created
xdg_popup surfaces associated with the same xdg_toplevel.</p>
<p>The parent of an xdg_popup must be mapped (see the xdg_surface
description) before the xdg_popup itself.</p>
<p>The x and y arguments passed when creating the popup object specify
where the top left of the popup should be placed, relative to the
local surface coordinates of the parent surface. See
xdg_surface.get_popup. An xdg_popup must intersect with or be at least
partially adjacent to its parent surface.</p>
<p>The client must call wl_surface.commit on the corresponding wl_surface
for the xdg_popup state to take effect.</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.XdgPopup.html" title='wayland_protocols::xdg_shell::client::xdg_popup::XdgPopup struct'>XdgPopup</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.Error.html" title='wayland_protocols::xdg_shell::client::xdg_popup::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_popup::Event enum'>Event</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_popup::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.EVT_CONFIGURE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_popup::EVT_CONFIGURE_SINCE constant'>EVT_CONFIGURE_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this event</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.EVT_POPUP_DONE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_popup::EVT_POPUP_DONE_SINCE constant'>EVT_POPUP_DONE_SINCE</a></td><td class='docblock-short'><p>The minimal object version supporting this event</p>
</td></tr><tr class='module-item'><td><a class="constant" href="constant.REQ_DESTROY_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_popup::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_GRAB_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_popup::REQ_GRAB_SINCE constant'>REQ_GRAB_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_popup::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>