31 lines
11 KiB
HTML
31 lines
11 KiB
HTML
<!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 `wl_shell_surface` mod in crate `wayland_client`."><meta name="keywords" content="rust, rustlang, rust-lang, wl_shell_surface"><title>wayland_client::protocol::wl_shell_surface - 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_client/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module wl_shell_surface</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_client</a>::<wbr><a href='../index.html'>protocol</a></p><script>window.sidebarCurrent = {name: 'wl_shell_surface', 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_client/home/mrh/source/Trac3r-rust/target/debug/build/wayland-client-893466244f089367/out/wayland_c_api.rs.html#1' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>wayland_client</a>::<wbr><a href='../index.html'>protocol</a>::<wbr><a class="mod" href=''>wl_shell_surface</a></span></h1><div class='docblock'><p>desktop-style metadata interface</p>
|
||
<p>An interface that may be implemented by a wl_surface, for
|
||
implementations that provide a desktop-style user interface.</p>
|
||
<p>It provides requests to treat surfaces like toplevel, fullscreen
|
||
or popup windows, move, resize or maximize them, associate
|
||
metadata like title and class, etc.</p>
|
||
<p>On the server side the object is automatically destroyed when
|
||
the related wl_surface is destroyed. On the client side,
|
||
wl_shell_surface_destroy() must be called before destroying
|
||
the wl_surface object.</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.Resize.html" title='wayland_client::protocol::wl_shell_surface::Resize struct'>Resize</a></td><td class='docblock-short'><p>edge values for resizing</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Transient.html" title='wayland_client::protocol::wl_shell_surface::Transient struct'>Transient</a></td><td class='docblock-short'><p>details of transient behaviour</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WlShellSurface.html" title='wayland_client::protocol::wl_shell_surface::WlShellSurface struct'>WlShellSurface</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_client::protocol::wl_shell_surface::Event enum'>Event</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.FullscreenMethod.html" title='wayland_client::protocol::wl_shell_surface::FullscreenMethod enum'>FullscreenMethod</a></td><td class='docblock-short'><p>different method to set the surface fullscreen</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Request.html" title='wayland_client::protocol::wl_shell_surface::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_client::protocol::wl_shell_surface::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_PING_SINCE.html" title='wayland_client::protocol::wl_shell_surface::EVT_PING_SINCE constant'>EVT_PING_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_client::protocol::wl_shell_surface::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_MOVE_SINCE.html" title='wayland_client::protocol::wl_shell_surface::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_PONG_SINCE.html" title='wayland_client::protocol::wl_shell_surface::REQ_PONG_SINCE constant'>REQ_PONG_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_client::protocol::wl_shell_surface::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_CLASS_SINCE.html" title='wayland_client::protocol::wl_shell_surface::REQ_SET_CLASS_SINCE constant'>REQ_SET_CLASS_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_client::protocol::wl_shell_surface::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_client::protocol::wl_shell_surface::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_POPUP_SINCE.html" title='wayland_client::protocol::wl_shell_surface::REQ_SET_POPUP_SINCE constant'>REQ_SET_POPUP_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_client::protocol::wl_shell_surface::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_SET_TOPLEVEL_SINCE.html" title='wayland_client::protocol::wl_shell_surface::REQ_SET_TOPLEVEL_SINCE constant'>REQ_SET_TOPLEVEL_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_TRANSIENT_SINCE.html" title='wayland_client::protocol::wl_shell_surface::REQ_SET_TRANSIENT_SINCE constant'>REQ_SET_TRANSIENT_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_client::protocol::wl_shell_surface::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_client";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |