|
|
<!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_toplevel` mod in crate `wayland_protocols`."><meta name="keywords" content="rust, rustlang, rust-lang, xdg_toplevel"><title>wayland_protocols::xdg_shell::client::xdg_toplevel - 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">☰</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_toplevel</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_toplevel', 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'>−</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_toplevel</a></span></h1><div class='docblock'><p>toplevel surface</p>
|
|
|
<p>This interface defines an xdg_surface role which allows a surface to,
|
|
|
among other things, set window-like properties such as maximize,
|
|
|
fullscreen, and minimize, set application-specific metadata like title and
|
|
|
id, and well as trigger user interactive operations such as interactive
|
|
|
resize and move.</p>
|
|
|
<p>Unmapping an xdg_toplevel means that the surface cannot be shown
|
|
|
by the compositor until it is explicitly mapped again.
|
|
|
All active operations (e.g., move, resize) are canceled and all
|
|
|
attributes (e.g. title, state, stacking, ...) are discarded for
|
|
|
an xdg_toplevel surface when it is unmapped.</p>
|
|
|
<p>Attaching a null buffer to a toplevel unmaps the surface.</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.XdgToplevel.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::XdgToplevel struct'>XdgToplevel</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.Event.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::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_toplevel::Request enum'>Request</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.ResizeEdge.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::ResizeEdge enum'>ResizeEdge</a></td><td class='docblock-short'><p>edge values for resizing</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.State.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::State enum'>State</a></td><td class='docblock-short'><p>types of state on the surface</p>
|
|
|
</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_CLOSE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::EVT_CLOSE_SINCE constant'>EVT_CLOSE_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_CONFIGURE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::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.REQ_DESTROY_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::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_MOVE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_MOVE_SINCE constant'>REQ_MOVE_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_RESIZE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_RESIZE_SINCE constant'>REQ_RESIZE_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_APP_ID_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_APP_ID_SINCE constant'>REQ_SET_APP_ID_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_FULLSCREEN_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_FULLSCREEN_SINCE constant'>REQ_SET_FULLSCREEN_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_MAXIMIZED_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_MAXIMIZED_SINCE constant'>REQ_SET_MAXIMIZED_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_MAX_SIZE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_MAX_SIZE_SINCE constant'>REQ_SET_MAX_SIZE_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_MINIMIZED_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_MINIMIZED_SINCE constant'>REQ_SET_MINIMIZED_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_MIN_SIZE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_MIN_SIZE_SINCE constant'>REQ_SET_MIN_SIZE_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_PARENT_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_PARENT_SINCE constant'>REQ_SET_PARENT_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_TITLE_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SET_TITLE_SINCE constant'>REQ_SET_TITLE_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_SHOW_WINDOW_MENU_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_SHOW_WINDOW_MENU_SINCE constant'>REQ_SHOW_WINDOW_MENU_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_UNSET_FULLSCREEN_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_UNSET_FULLSCREEN_SINCE constant'>REQ_UNSET_FULLSCREEN_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_UNSET_MAXIMIZED_SINCE.html" title='wayland_protocols::xdg_shell::client::xdg_toplevel::REQ_UNSET_MAXIMIZED_SINCE constant'>REQ_UNSET_MAXIMIZED_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_toplevel::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>⏎</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> |
