|
|
<!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_toplevel::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._move">_move</a><a href="#tymethod.destroy">destroy</a><a href="#tymethod.resize">resize</a><a href="#tymethod.set_app_id">set_app_id</a><a href="#tymethod.set_fullscreen">set_fullscreen</a><a href="#tymethod.set_max_size">set_max_size</a><a href="#tymethod.set_maximized">set_maximized</a><a href="#tymethod.set_min_size">set_min_size</a><a href="#tymethod.set_minimized">set_minimized</a><a href="#tymethod.set_parent">set_parent</a><a href="#tymethod.set_title">set_title</a><a href="#tymethod.show_window_menu">show_window_menu</a><a href="#tymethod.unset_fullscreen">unset_fullscreen</a><a href="#tymethod.unset_maximized">unset_maximized</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-RequestsTrait-for-Proxy%3CXdgToplevel%3E">Proxy<XdgToplevel></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_toplevel</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_toplevel</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_parent' class='fnname'>set_parent</a>(&self, parent: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<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_toplevel/struct.XdgToplevel.html" title="struct wayland_protocols::xdg_shell::client::xdg_toplevel::XdgToplevel">XdgToplevel</a>>>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_title' class='fnname'>set_title</a>(&self, title: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_app_id' class='fnname'>set_app_id</a>(&self, app_id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.show_window_menu' class='fnname'>show_window_menu</a>(<br> &self, <br> seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, <br> serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><br> );
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod._move' class='fnname'>_move</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <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.resize' class='fnname'>resize</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, edges: <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_max_size' class='fnname'>set_max_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_min_size' class='fnname'>set_min_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_maximized' class='fnname'>set_maximized</a>(&self);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.unset_maximized' class='fnname'>unset_maximized</a>(&self);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_fullscreen' class='fnname'>set_fullscreen</a>(&self, output: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_output/struct.WlOutput.html" title="struct wayland_client::generated::c_api::wl_output::WlOutput">WlOutput</a>>>);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.unset_fullscreen' class='fnname'>unset_fullscreen</a>(&self);
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_minimized' class='fnname'>set_minimized</a>(&self);
|
|
|
}</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_toplevel</p>
|
|
|
<p>This request destroys the role surface and unmaps the surface;
|
|
|
see "Unmapping" behavior in interface section for details.</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_parent' class='method'><code id='set_parent.v'>fn <a href='#tymethod.set_parent' class='fnname'>set_parent</a>(&self, parent: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<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_toplevel/struct.XdgToplevel.html" title="struct wayland_protocols::xdg_shell::client::xdg_toplevel::XdgToplevel">XdgToplevel</a>>>)</code></h3><div class='docblock'><p>set the parent of this surface</p>
|
|
|
<p>Set the "parent" of this surface. This surface should be stacked
|
|
|
above the parent surface and all other ancestor surfaces.</p>
|
|
|
<p>Parent windows should be set on dialogs, toolboxes, or other
|
|
|
"auxiliary" surfaces, so that the parent is raised when the dialog
|
|
|
is raised.</p>
|
|
|
<p>Setting a null parent for a child window removes any parent-child
|
|
|
relationship for the child. Setting a null parent for a window which
|
|
|
currently has no parent is a no-op.</p>
|
|
|
<p>If the parent is unmapped then its children are managed as
|
|
|
though the parent of the now-unmapped parent has become the
|
|
|
parent of this surface. If no parent exists for the now-unmapped
|
|
|
parent then the children are managed as though they have no
|
|
|
parent surface.</p>
|
|
|
</div><h3 id='tymethod.set_title' class='method'><code id='set_title.v'>fn <a href='#tymethod.set_title' class='fnname'>set_title</a>(&self, title: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></h3><div class='docblock'><p>set surface title</p>
|
|
|
<p>Set a short title for the surface.</p>
|
|
|
<p>This string may be used to identify the surface in a task bar,
|
|
|
window list, or other user interface elements provided by the
|
|
|
compositor.</p>
|
|
|
<p>The string must be encoded in UTF-8.</p>
|
|
|
</div><h3 id='tymethod.set_app_id' class='method'><code id='set_app_id.v'>fn <a href='#tymethod.set_app_id' class='fnname'>set_app_id</a>(&self, app_id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></h3><div class='docblock'><p>set application ID</p>
|
|
|
<p>Set an application identifier for the surface.</p>
|
|
|
<p>The app ID identifies the general class of applications to which
|
|
|
the surface belongs. The compositor can use this to group multiple
|
|
|
surfaces together, or to determine how to launch a new application.</p>
|
|
|
<p>For D-Bus activatable applications, the app ID is used as the D-Bus
|
|
|
service name.</p>
|
|
|
<p>The compositor shell will try to group application surfaces together
|
|
|
by their app ID. As a best practice, it is suggested to select app
|
|
|
ID's that match the basename of the application's .desktop file.
|
|
|
For example, "org.freedesktop.FooViewer" where the .desktop file is
|
|
|
"org.freedesktop.FooViewer.desktop".</p>
|
|
|
<p>See the desktop-entry specification [0] for more details on
|
|
|
application identifiers and how they relate to well-known D-Bus
|
|
|
names and .desktop files.</p>
|
|
|
<p>[0] http://standards.freedesktop.org/desktop-entry-spec/</p>
|
|
|
</div><h3 id='tymethod.show_window_menu' class='method'><code id='show_window_menu.v'>fn <a href='#tymethod.show_window_menu' class='fnname'>show_window_menu</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, 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>show the window menu</p>
|
|
|
<p>Clients implementing client-side decorations might want to show
|
|
|
a context menu when right-clicking on the decorations, giving the
|
|
|
user a menu that they can use to maximize or minimize the window.</p>
|
|
|
<p>This request asks the compositor to pop up such a window menu at
|
|
|
the given position, relative to the local surface coordinates of
|
|
|
the parent surface. There are no guarantees as to what menu items
|
|
|
the window menu contains.</p>
|
|
|
<p>This request must be used in response to some sort of user action
|
|
|
like a button press, key press, or touch down event.</p>
|
|
|
</div><h3 id='tymethod._move' class='method'><code id='_move.v'>fn <a href='#tymethod._move' class='fnname'>_move</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></h3><div class='docblock'><p>start an interactive move</p>
|
|
|
<p>Start an interactive, user-driven move of the surface.</p>
|
|
|
<p>This request must be used in response to some sort of user action
|
|
|
like a button press, key press, or touch down event. The passed
|
|
|
serial is used to determine the type of interactive move (touch,
|
|
|
pointer, etc).</p>
|
|
|
<p>The server may ignore move requests depending on the state of
|
|
|
the surface (e.g. fullscreen or maximized), or if the passed serial
|
|
|
is no longer valid.</p>
|
|
|
<p>If triggered, the surface will lose the focus of the device
|
|
|
(wl_pointer, wl_touch, etc) used for the move. It is up to the
|
|
|
compositor to visually indicate that the move is taking place, such as
|
|
|
updating a pointer cursor, during the move. There is no guarantee
|
|
|
that the device focus will return when the move is completed.</p>
|
|
|
</div><h3 id='tymethod.resize' class='method'><code id='resize.v'>fn <a href='#tymethod.resize' class='fnname'>resize</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, edges: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code></h3><div class='docblock'><p>start an interactive resize</p>
|
|
|
<p>Start a user-driven, interactive resize of the surface.</p>
|
|
|
<p>This request must be used in response to some sort of user action
|
|
|
like a button press, key press, or touch down event. The passed
|
|
|
serial is used to determine the type of interactive resize (touch,
|
|
|
pointer, etc).</p>
|
|
|
<p>The server may ignore resize requests depending on the state of
|
|
|
the surface (e.g. fullscreen or maximized).</p>
|
|
|
<p>If triggered, the client will receive configure events with the
|
|
|
"resize" state enum value and the expected sizes. See the "resize"
|
|
|
enum value for more details about what is required. The client
|
|
|
must also acknowledge configure events using "ack_configure". After
|
|
|
the resize is completed, the client will receive another "configure"
|
|
|
event without the resize state.</p>
|
|
|
<p>If triggered, the surface also will lose the focus of the device
|
|
|
(wl_pointer, wl_touch, etc) used for the resize. It is up to the
|
|
|
compositor to visually indicate that the resize is taking place,
|
|
|
such as updating a pointer cursor, during the resize. There is no
|
|
|
guarantee that the device focus will return when the resize is
|
|
|
completed.</p>
|
|
|
<p>The edges parameter specifies how the surface should be resized,
|
|
|
and is one of the values of the resize_edge enum. The compositor
|
|
|
may use this information to update the surface position for
|
|
|
example when dragging the top left corner. The compositor may also
|
|
|
use this information to adapt its behavior, e.g. choose an
|
|
|
appropriate cursor image.</p>
|
|
|
</div><h3 id='tymethod.set_max_size' class='method'><code id='set_max_size.v'>fn <a href='#tymethod.set_max_size' class='fnname'>set_max_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 maximum size</p>
|
|
|
<p>Set a maximum size for the window.</p>
|
|
|
<p>The client can specify a maximum size so that the compositor does
|
|
|
not try to configure the window beyond this size.</p>
|
|
|
<p>The width and height arguments are in window geometry coordinates.
|
|
|
See xdg_surface.set_window_geometry.</p>
|
|
|
<p>Values set in this way are double-buffered. They will get applied
|
|
|
on the next commit.</p>
|
|
|
<p>The compositor can use this information to allow or disallow
|
|
|
different states like maximize or fullscreen and draw accurate
|
|
|
animations.</p>
|
|
|
<p>Similarly, a tiling window manager may use this information to
|
|
|
place and resize client windows in a more effective way.</p>
|
|
|
<p>The client should not rely on the compositor to obey the maximum
|
|
|
size. The compositor may decide to ignore the values set by the
|
|
|
client and request a larger size.</p>
|
|
|
<p>If never set, or a value of zero in the request, means that the
|
|
|
client has no expected maximum size in the given dimension.
|
|
|
As a result, a client wishing to reset the maximum size
|
|
|
to an unspecified state can use zero for width and height in the
|
|
|
request.</p>
|
|
|
<p>Requesting a maximum size to be smaller than the minimum size of
|
|
|
a surface is illegal and will result in a protocol error.</p>
|
|
|
<p>The width and height must be greater than or equal to zero. Using
|
|
|
strictly negative values for width and height will result in a
|
|
|
protocol error.</p>
|
|
|
</div><h3 id='tymethod.set_min_size' class='method'><code id='set_min_size.v'>fn <a href='#tymethod.set_min_size' class='fnname'>set_min_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 minimum size</p>
|
|
|
<p>Set a minimum size for the window.</p>
|
|
|
<p>The client can specify a minimum size so that the compositor does
|
|
|
not try to configure the window below this size.</p>
|
|
|
<p>The width and height arguments are in window geometry coordinates.
|
|
|
See xdg_surface.set_window_geometry.</p>
|
|
|
<p>Values set in this way are double-buffered. They will get applied
|
|
|
on the next commit.</p>
|
|
|
<p>The compositor can use this information to allow or disallow
|
|
|
different states like maximize or fullscreen and draw accurate
|
|
|
animations.</p>
|
|
|
<p>Similarly, a tiling window manager may use this information to
|
|
|
place and resize client windows in a more effective way.</p>
|
|
|
<p>The client should not rely on the compositor to obey the minimum
|
|
|
size. The compositor may decide to ignore the values set by the
|
|
|
client and request a smaller size.</p>
|
|
|
<p>If never set, or a value of zero in the request, means that the
|
|
|
client has no expected minimum size in the given dimension.
|
|
|
As a result, a client wishing to reset the minimum size
|
|
|
to an unspecified state can use zero for width and height in the
|
|
|
request.</p>
|
|
|
<p>Requesting a minimum size to be larger than the maximum size of
|
|
|
a surface is illegal and will result in a protocol error.</p>
|
|
|
<p>The width and height must be greater than or equal to zero. Using
|
|
|
strictly negative values for width and height will result in a
|
|
|
protocol error.</p>
|
|
|
</div><h3 id='tymethod.set_maximized' class='method'><code id='set_maximized.v'>fn <a href='#tymethod.set_maximized' class='fnname'>set_maximized</a>(&self)</code></h3><div class='docblock'><p>maximize the window</p>
|
|
|
<p>Maximize the surface.</p>
|
|
|
<p>After requesting that the surface should be maximized, the compositor
|
|
|
will respond by emitting a configure event. Whether this configure
|
|
|
actually sets the window maximized is subject to compositor policies.
|
|
|
The client must then update its content, drawing in the configured
|
|
|
state. The client must also acknowledge the configure when committing
|
|
|
the new content (see ack_configure).</p>
|
|
|
<p>It is up to the compositor to decide how and where to maximize the
|
|
|
surface, for example which output and what region of the screen should
|
|
|
be used.</p>
|
|
|
<p>If the surface was already maximized, the compositor will still emit
|
|
|
a configure event with the "maximized" state.</p>
|
|
|
<p>If the surface is in a fullscreen state, this request has no direct
|
|
|
effect. It may alter the state the surface is returned to when
|
|
|
unmaximized unless overridden by the compositor.</p>
|
|
|
</div><h3 id='tymethod.unset_maximized' class='method'><code id='unset_maximized.v'>fn <a href='#tymethod.unset_maximized' class='fnname'>unset_maximized</a>(&self)</code></h3><div class='docblock'><p>unmaximize the window</p>
|
|
|
<p>Unmaximize the surface.</p>
|
|
|
<p>After requesting that the surface should be unmaximized, the compositor
|
|
|
will respond by emitting a configure event. Whether this actually
|
|
|
un-maximizes the window is subject to compositor policies.
|
|
|
If available and applicable, the compositor will include the window
|
|
|
geometry dimensions the window had prior to being maximized in the
|
|
|
configure event. The client must then update its content, drawing it in
|
|
|
the configured state. The client must also acknowledge the configure
|
|
|
when committing the new content (see ack_configure).</p>
|
|
|
<p>It is up to the compositor to position the surface after it was
|
|
|
unmaximized; usually the position the surface had before maximizing, if
|
|
|
applicable.</p>
|
|
|
<p>If the surface was already not maximized, the compositor will still
|
|
|
emit a configure event without the "maximized" state.</p>
|
|
|
<p>If the surface is in a fullscreen state, this request has no direct
|
|
|
effect. It may alter the state the surface is returned to when
|
|
|
unmaximized unless overridden by the compositor.</p>
|
|
|
</div><h3 id='tymethod.set_fullscreen' class='method'><code id='set_fullscreen.v'>fn <a href='#tymethod.set_fullscreen' class='fnname'>set_fullscreen</a>(&self, output: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_output/struct.WlOutput.html" title="struct wayland_client::generated::c_api::wl_output::WlOutput">WlOutput</a>>>)</code></h3><div class='docblock'><p>set the window as fullscreen on an output</p>
|
|
|
<p>Make the surface fullscreen.</p>
|
|
|
<p>After requesting that the surface should be fullscreened, the
|
|
|
compositor will respond by emitting a configure event. Whether the
|
|
|
client is actually put into a fullscreen state is subject to compositor
|
|
|
policies. The client must also acknowledge the configure when
|
|
|
committing the new content (see ack_configure).</p>
|
|
|
<p>The output passed by the request indicates the client's preference as
|
|
|
to which display it should be set fullscreen on. If this value is NULL,
|
|
|
it's up to the compositor to choose which display will be used to map
|
|
|
this surface.</p>
|
|
|
<p>If the surface doesn't cover the whole output, the compositor will
|
|
|
position the surface in the center of the output and compensate with
|
|
|
with border fill covering the rest of the output. The content of the
|
|
|
border fill is undefined, but should be assumed to be in some way that
|
|
|
attempts to blend into the surrounding area (e.g. solid black).</p>
|
|
|
<p>If the fullscreened surface is not opaque, the compositor must make
|
|
|
sure that other screen content not part of the same surface tree (made
|
|
|
up of subsurfaces, popups or similarly coupled surfaces) are not
|
|
|
visible below the fullscreened surface.</p>
|
|
|
</div><h3 id='tymethod.unset_fullscreen' class='method'><code id='unset_fullscreen.v'>fn <a href='#tymethod.unset_fullscreen' class='fnname'>unset_fullscreen</a>(&self)</code></h3><div class='docblock'><p>unset the window as fullscreen</p>
|
|
|
<p>Make the surface no longer fullscreen.</p>
|
|
|
<p>After requesting that the surface should be unfullscreened, the
|
|
|
compositor will respond by emitting a configure event.
|
|
|
Whether this actually removes the fullscreen state of the client is
|
|
|
subject to compositor policies.</p>
|
|
|
<p>Making a surface unfullscreen sets states for the surface based on the following:</p>
|
|
|
<ul>
|
|
|
<li>the state(s) it may have had before becoming fullscreen</li>
|
|
|
<li>any state(s) decided by the compositor</li>
|
|
|
<li>any state(s) requested by the client while the surface was fullscreen</li>
|
|
|
</ul>
|
|
|
<p>The compositor may include the previous window geometry dimensions in
|
|
|
the configure event, if applicable.</p>
|
|
|
<p>The client must also acknowledge the configure when committing the new
|
|
|
content (see ack_configure).</p>
|
|
|
</div><h3 id='tymethod.set_minimized' class='method'><code id='set_minimized.v'>fn <a href='#tymethod.set_minimized' class='fnname'>set_minimized</a>(&self)</code></h3><div class='docblock'><p>set the window as minimized</p>
|
|
|
<p>Request that the compositor minimize your surface. There is no
|
|
|
way to know if the surface is currently minimized, nor is there
|
|
|
any way to unset minimization on this surface.</p>
|
|
|
<p>If you are looking to throttle redrawing when minimized, please
|
|
|
instead use the wl_surface.frame event for this, as this will
|
|
|
also work with live previews on windows in Alt-Tab, Expose or
|
|
|
similar compositor features.</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%3CXdgToplevel%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../wayland_protocols/xdg_shell/client/xdg_toplevel/trait.RequestsTrait.html" title="trait wayland_protocols::xdg_shell::client::xdg_toplevel::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_toplevel/struct.XdgToplevel.html" title="struct wayland_protocols::xdg_shell::client::xdg_toplevel::XdgToplevel">XdgToplevel</a>></code><a href='#impl-RequestsTrait-for-Proxy%3CXdgToplevel%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_parent' class="method hidden"><code id='set_parent.v-1'>fn <a href='#method.set_parent' class='fnname'>set_parent</a>(&self, parent: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<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_toplevel/struct.XdgToplevel.html" title="struct wayland_protocols::xdg_shell::client::xdg_toplevel::XdgToplevel">XdgToplevel</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_title' class="method hidden"><code id='set_title.v-1'>fn <a href='#method.set_title' class='fnname'>set_title</a>(&self, title: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</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_app_id' class="method hidden"><code id='set_app_id.v-1'>fn <a href='#method.set_app_id' class='fnname'>set_app_id</a>(&self, app_id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</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.show_window_menu' class="method hidden"><code id='show_window_menu.v-1'>fn <a href='#method.show_window_menu' class='fnname'>show_window_menu</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, 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><h4 id='method._move' class="method hidden"><code id='_move.v-1'>fn <a href='#method._move' class='fnname'>_move</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <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.resize' class="method hidden"><code id='resize.v-1'>fn <a href='#method.resize' class='fnname'>resize</a>(&self, seat: &<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_seat/struct.WlSeat.html" title="struct wayland_client::generated::c_api::wl_seat::WlSeat">WlSeat</a>>, serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, edges: <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_max_size' class="method hidden"><code id='set_max_size.v-1'>fn <a href='#method.set_max_size' class='fnname'>set_max_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_min_size' class="method hidden"><code id='set_min_size.v-1'>fn <a href='#method.set_min_size' class='fnname'>set_min_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_maximized' class="method hidden"><code id='set_maximized.v-1'>fn <a href='#method.set_maximized' class='fnname'>set_maximized</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.unset_maximized' class="method hidden"><code id='unset_maximized.v-1'>fn <a href='#method.unset_maximized' class='fnname'>unset_maximized</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_fullscreen' class="method hidden"><code id='set_fullscreen.v-1'>fn <a href='#method.set_fullscreen' class='fnname'>set_fullscreen</a>(&self, output: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../../../wayland_client/proxy/struct.Proxy.html" title="struct wayland_client::proxy::Proxy">Proxy</a><<a class="struct" href="../../../../wayland_client/generated/c_api/wl_output/struct.WlOutput.html" title="struct wayland_client::generated::c_api::wl_output::WlOutput">WlOutput</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.unset_fullscreen' class="method hidden"><code id='unset_fullscreen.v-1'>fn <a href='#method.unset_fullscreen' class='fnname'>unset_fullscreen</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_minimized' class="method hidden"><code id='set_minimized.v-1'>fn <a href='#method.set_minimized' class='fnname'>set_minimized</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></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_toplevel/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> |
