|
|
|
|
|
<!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 `Window` struct in crate `smithay_client_toolkit`."><meta name="keywords" content="rust, rustlang, rust-lang, Window"><title>smithay_client_toolkit::window::Window - 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 struct"><!--[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='../../smithay_client_toolkit/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Window</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.init">init</a><a href="#method.init_from_env">init_from_env</a><a href="#method.init_with_decorations">init_with_decorations</a><a href="#method.new_seat">new_seat</a><a href="#method.refresh">refresh</a><a href="#method.resize">resize</a><a href="#method.set_app_id">set_app_id</a><a href="#method.set_decorate">set_decorate</a><a href="#method.set_fullscreen">set_fullscreen</a><a href="#method.set_max_size">set_max_size</a><a href="#method.set_maximized">set_maximized</a><a href="#method.set_min_size">set_min_size</a><a href="#method.set_minimized">set_minimized</a><a href="#method.set_resizable">set_resizable</a><a href="#method.set_theme">set_theme</a><a href="#method.set_title">set_title</a><a href="#method.surface">surface</a><a href="#method.unset_fullscreen">unset_fullscreen</a><a href="#method.unset_maximized">unset_maximized</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Drop">Drop</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>window</a></p><script>window.sidebarCurrent = {name: 'Window', ty: 'struct', 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="../.
|
|
|
|
|
|
<p>This wrapper handles for you the decoration of your window
|
|
|
|
|
|
and the interaction with the server regarding the shell protocol.</p>
|
|
|
|
|
|
<p>You are still entirely responsible for drawing the contents of your
|
|
|
|
|
|
window.</p>
|
|
|
|
|
|
<p>Note also that as the dimensions of wayland surfaces is defined by
|
|
|
|
|
|
their attached buffer, you need to keep the decorations in sync with
|
|
|
|
|
|
your contents via the <code>resize(..)</code> method.</p>
|
|
|
|
|
|
<p>Different kind of decorations can be used by customizing the type
|
|
|
|
|
|
parameter. A few are provided in this crate, but any type implementing
|
|
|
|
|
|
the <code>Frame</code> trait can do.</p>
|
|
|
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<F: <a class="trait" href="../../smithay_client_toolkit/window/trait.Frame.html" title="trait smithay_client_toolkit::window::Frame">Frame</a> + 'static> <a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#125-556' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.init_from_env' class="method"><code id='init_from_env.v'>pub fn <a href='#method.init_from_env' class='fnname'>init_from_env</a><Impl>(<br> env: &<a class="struct" href="../../smithay_client_toolkit/struct.Environment.html" title="struct smithay_client_toolkit::Environment">Environment</a>, <br> surface: <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_surface/struct.WlSurface.html" title="struct wayland_client::generated::c_api::wl_surface::WlSurface">WlSurface</a>>, <br> initial_dims: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <br> implementation: Impl<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F>, F::<a class="type" href="../../smithay_client_toolkit/window/trait.Frame.html#associatedtype.Error" title="type smithay_client_toolkit::window::Frame::Error">Error</a>> <span class="where fmt-newline">where<br> Impl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="../../smithay_client_toolkit/window/enum.Event.html" title="enum smithay_client_toolkit::window::Event">Event</a>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#128-147' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new window wrapping a given wayland surface as its main content and
|
|
|
|
|
|
following the compositor's preference regarding server-side decorations.</p>
|
|
|
|
|
|
</div><h4 id='method.init' class="method"><code id='init.v'>pub fn <a href='#method.init' class='fnname'>init</a><Impl>(<br> surface: <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_surface/struct.WlSurface.html" title="struct wayland_client::generated::c_api::wl_surface::WlSurface">WlSurface</a>>, <br> initial_dims: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <br> compositor: &<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_compositor/struct.WlCompositor.html" title="struct wayland_client::generated::c_api::wl_compositor::WlCompositor">WlCompositor</a>>, <br> subcompositor: &<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_subcompositor/struct.WlSubcompositor.html" title="struct wayland_client::generated::c_api::wl_subcompositor::WlSubcompositor">WlSubcompositor</a>>, <br> shm: &<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_shm/struct.WlShm.html" title="struct wayland_client::generated::c_api::wl_shm::WlShm">WlShm</a>>, <br> shell: &<a class="enum" href="../../smithay_client_toolkit/enum.Shell.html" title="enum smithay_client_toolkit::Shell">Shell</a>, <br> implementation: Impl<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F>, F::<a class="type" href="../../smithay_client_toolkit/window/trait.Frame.html#associatedtype.Error" title="type smithay_client_toolkit::window::Frame::Error">Error</a>> <span class="where fmt-newline">where<br> Impl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="../../smithay_client_toolkit/window/enum.Event.html" title="enum smithay_client_toolkit::window::Event">Event</a>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#153-175' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new window wrapping a given wayland surface as its main content</p>
|
|
|
|
|
|
<p>It can fail if the initialization of the frame fails (for example if the
|
|
|
|
|
|
frame class fails to initialize its SHM).</p>
|
|
|
|
|
|
</div><h4 id='method.init_with_decorations' class="method"><code id='init_with_decorations.v'>pub fn <a href='#method.init_with_decorations' class='fnname'>init_with_decorations</a><Impl>(<br> surface: <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_surface/struct.WlSurface.html" title="struct wayland_client::generated::c_api::wl_surface::WlSurface">WlSurface</a>>, <br> initial_dims: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <br> compositor: &<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_compositor/struct.WlCompositor.html" title="struct wayland_client::generated::c_api::wl_compositor::WlCompositor">WlCompositor</a>>, <br> subcompositor: &<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_subcompositor/struct.WlSubcompositor.html" title="struct wayland_client::generated::c_api::wl_subcompositor::WlSubcompositor">WlSubcompositor</a>>, <br> shm: &<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_shm/struct.WlShm.html" title="struct wayland_client::generated::c_api::wl_shm::WlShm">WlShm</a>>, <br> shell: &<a class="enum" href="../../smithay_client_toolkit/enum.Shell.html" title="enum smithay_client_toolkit::Shell">Shell</a>, <br> decoration_mgr: <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/unstable/xdg_decoration/v1/generated/client/zxdg_decoration_manager_v1/struct.ZxdgDecorationManagerV1.html" title="struct wayland_protocols::unstable::xdg_decoration::v1::generated::client::zxdg_decoration_manager_v1::ZxdgDecorationManagerV1">ZxdgDecorationManagerV1</a>>>, <br> implementation: Impl<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F>, F::<a class="type" href="../../smithay_client_toolkit/window/trait.Frame.html#associatedtype.Error" title="type smithay_client_toolkit::window::Frame::Error">Error</a>> <span class="where fmt-newline">where<br> Impl: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="../../smithay_client_toolkit/window/enum.Event.html" title="enum smithay_client_toolkit::window::Event">Event</a>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#182-306' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new window wrapping a given wayland surface as its mai
|
|
|
|
|
|
following the compositor's preference regarding server-side decorations</p>
|
|
|
|
|
|
<p>It can fail if the initialization of the frame fails (for example if the
|
|
|
|
|
|
frame class fails to initialize its SHM).</p>
|
|
|
|
|
|
</div><h4 id='method.new_seat' class="method"><code id='new_seat.v'>pub fn <a href='#method.new_seat' class='fnname'>new_seat</a>(&mut 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>>)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#363-365' title='goto source code'>[src]</a></h4><div class='docblock'><p>Notify this window that a new seat is accessible</p>
|
|
|
|
|
|
<p>This allows the decoration manager to get an handle to the pointer
|
|
|
|
|
|
to manage pointer events and change the pointer image appropriately.</p>
|
|
|
|
|
|
</div><h4 id='method.surface' class="method"><code id='surface.v'>pub fn <a href='#method.surface' class='fnname'>surface</a>(&self) -> &<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_surface/struct.WlSurface.html" title="struct wayland_client::generated::c_api::wl_surface::WlSurface">WlSurface</a>></code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#368-370' title='goto source code'>[src]</a></h4><div class='docblock'><p>Access the surface wrapped in this Window</p>
|
|
|
|
|
|
</div><h4 id='method.refresh' class="method"><code id='refresh.v'>pub fn <a href='#method.refresh' class='fnname'>refresh</a>(&mut self)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#383-385' title='goto source code'>[src]</a></h4><div class='docblock'><p>Refreshes the frame</p>
|
|
|
|
|
|
<p>Redraws the frame to match its requested state (dimensions, presence/
|
|
|
|
|
|
absence of decorations, ...)</p>
|
|
|
|
|
|
<p>You need to call this method after every change to the dimensions or state
|
|
|
|
|
|
of the decorations of your window, otherwise the drawn decorations may go
|
|
|
|
|
|
out of sync with the state of your content.</p>
|
|
|
|
|
|
<p>Your implementation will also receive <code>Refresh</code> events when the frame requests
|
|
|
|
|
|
to be redrawn (to provide some frame animations for example).</p>
|
|
|
|
|
|
</div><h4 id='method.set_title' class="method"><code id='set_title.v'>pub 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/smithay_client_toolkit/window/mod.rs.html#394-397' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set a short title for the window.</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>You need to call <code>refresh()</code> afterwards for this to properly
|
|
|
|
|
|
take effect.</p>
|
|
|
|
|
|
</div><h4 id='method.set_app_id' class="method"><code id='set_app_id.v'>pub 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/smithay_client_toolkit/window/mod.rs.html#406-408' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set an app id for the surface.</p>
|
|
|
|
|
|
<p>The surface class identifies the general class of applications to which the surface
|
|
|
|
|
|
belongs.</p>
|
|
|
|
|
|
<p>Several wayland compositors will try to find a <code>.desktop</code> file matching this name
|
|
|
|
|
|
to find metadata about your apps.</p>
|
|
|
|
|
|
</div><h4 id='method.set_decorate' class="method"><code id='set_decorate.v'>pub fn <a href='#method.set_decorate' class='fnname'>set_decorate</a>(&self, decorate: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#414-428' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set whether the window should be decorated or not</p>
|
|
|
|
|
|
<p>You need to call <code>refresh()</code> afterwards for this to properly
|
|
|
|
|
|
take effect.</p>
|
|
|
|
|
|
</div><h4 id='method.set_resizable' class="method"><code id='set_resizable.v'>pub fn <a href='#method.set_resizable' class='fnname'>set_resizable</a>(&self, resizable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#442-466' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set whether the window should be resizeable by the user</p>
|
|
|
|
|
|
<p>This is not an hard blocking, as the compositor can always
|
|
|
|
|
|
resize you forcibly if it wants. However it signals it that
|
|
|
|
|
|
you don't want this window to be resized.</p>
|
|
|
|
|
|
<p>Additionally, the decorations will stop suggesting the user
|
|
|
|
|
|
to resize by dragging the borders if you set the window as
|
|
|
|
|
|
non-resizable.</p>
|
|
|
|
|
|
<p>When re-activating resizability, any previously set min/max
|
|
|
|
|
|
sizes are restored.</p>
|
|
|
|
|
|
</div><h4 id='method.resize' class="method"><code id='resize.v'>pub fn <a href='#method.resize' class='fnname'>resize</a>(&mut self, w: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, h: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#475-487' title='goto source code'>[src]</a></h4><div class='docblock'><p>Resize the decorations</p>
|
|
|
|
|
|
<p>You should call this whenever you change the size of the contents
|
|
|
|
|
|
of your window, with the new <em>inner size</em> of your window.</p>
|
|
|
|
|
|
<p>You need to call <code>refresh()</code> afterwards for this to properly
|
|
|
|
|
|
take effect.</p>
|
|
|
|
|
|
</div><h4 id='method.set_maximized' class="method"><code id='set_maximized.v'>pub fn <a href='#method.set_maximized' class='fnname'>set_maximized</a>(&self)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#490-492' title='goto source code'>[src]</a></h4><div class='docblock'><p>Request the window to be maximized</p>
|
|
|
|
|
|
</div><h4 id='method.unset_maximized' class="method"><code id='unset_maximized.v'>pub fn <a href='#method.unset_maximized' class='fnname'>unset_maximized</a>(&self)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#495-497' title='goto source code'>[src]</a></h4><div class='docblock'><p>Request the window to be un-maximized</p>
|
|
|
|
|
|
</div><h4 id='method.set_minimized' class="method"><code id='set_minimized.v'>pub fn <a href='#method.set_minimized' class='fnname'>set_minimized</a>(&self)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#500-502' title='goto source code'>[src]</a></h4><div class='docblock'><p>Request the window to be minimized</p>
|
|
|
|
|
|
</div><h4 id='method.set_fullscreen' class="method"><code id='set_fullscreen.v'>pub 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/smithay_client_toolkit/window/mod.rs.html#508-510' title='goto source code'>[src]</a></h4><div class='docblock'><p>Request the window to be set fullscreen</p>
|
|
|
|
|
|
<p>Note: you need to manually disable the decorations if you
|
|
|
|
|
|
want to hide them!</p>
|
|
|
|
|
|
</div><h4 id='method.unset_fullscreen' class="method"><code id='unset_fullscreen.v'>pub fn <a href='#method.unset_fullscreen' class='fnname'>unset_fullscreen</a>(&self)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#513-515' title='goto source code'>[src]</a></h4><div class='docblock'><p>Request the window to quit fullscreen mode</p>
|
|
|
|
|
|
</div><h4 id='method.set_min_size' class="method"><code id='set_min_size.v'>pub fn <a href='#method.set_min_size' class='fnname'>set_min_size</a>(&mut self, size: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#523-530' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the minimum possible size for this window</p>
|
|
|
|
|
|
<p>Provide either a tuple <code>Some((width, height))</code> or <code>None</code> to unset the
|
|
|
|
|
|
minimum size.</p>
|
|
|
|
|
|
<p>The provided size is the interior size, not counting decorations</p>
|
|
|
|
|
|
</div><h4 id='method.set_max_size' class="method"><code id='set_max_size.v'>pub fn <a href='#method.set_max_size' class='fnname'>set_max_size</a>(&mut self, size: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#538-545' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the maximum possible size for this window</p>
|
|
|
|
|
|
<p>Provide either a tuple <code>Some((width, height))</code> or <code>None</code> to unset the
|
|
|
|
|
|
maximum size.</p>
|
|
|
|
|
|
<p>The provided size is the interior size, not counting decorations</p>
|
|
|
|
|
|
</div><h4 id='method.set_theme' class="method"><code id='set_theme.v'>pub fn <a href='#method.set_theme' class='fnname'>set_theme</a><T: <a class="trait" href="../../smithay_client_toolkit/window/trait.Theme.html" title="trait smithay_client_toolkit::window::Theme">Theme</a>>(&mut self, theme: T)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#553-555' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the theme for the window</p>
|
|
|
|
|
|
<p>Provide a type that implements the 'Theme' trait to adjust
|
|
|
|
|
|
the look of the windows decorations</p>
|
|
|
|
|
|
<p>The theme must return colors of the format of ARGB8888</p>
|
|
|
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Drop' class='impl'><code class='in-band'>impl<F: <a class="trait" href="../../smithay_client_toolkit/window/trait.Frame.html" title="trait smithay_client_toolkit::window::Frame">Frame</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F></code><a href='#impl-Drop' class='anchor'></a><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#558-562' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.drop' class="method hidden"><code id='drop.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code><a class='srclink' href='../../src/smithay_client_toolkit/window/mod.rs.html#559-561' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
|
|
|
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<F> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<F> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../smithay_client_toolkit/window/struct.Window.html" title="struct smithay_client_toolkit::window::Window">Window</a><F></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
|
|
|
</div></div></div></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 = "smithay_client_toolkit";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
