41 lines
No EOL
9.2 KiB
HTML
41 lines
No EOL
9.2 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="Handler for toplevel operations on a `Window`."><title>WindowHandler in cosmic::cctk::sctk::shell::xdg::window - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../../../" data-static-root-path="../../../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../../../static.files/storage-68b7e25d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Window<wbr>Handler</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.configure" title="configure">configure</a></li><li><a href="#tymethod.request_close" title="request_close">request_close</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>cctk::<wbr>sctk::<wbr>shell::<wbr>xdg::<wbr>window</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../../../index.html">cosmic</a>::<wbr><a href="../../../../index.html">cctk</a>::<wbr><a href="../../../index.html">sctk</a>::<wbr><a href="../../index.html">shell</a>::<wbr><a href="../index.html">xdg</a>::<wbr><a href="index.html">window</a></div><h1>Trait <span class="trait">WindowHandler</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>pub trait WindowHandler: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.request_close" class="fn">request_close</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
window: &<a class="struct" href="struct.Window.html" title="struct cosmic::cctk::sctk::shell::xdg::window::Window">Window</a>,
|
||
);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.configure" class="fn">configure</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
window: &<a class="struct" href="struct.Window.html" title="struct cosmic::cctk::sctk::shell::xdg::window::Window">Window</a>,
|
||
configure: <a class="struct" href="struct.WindowConfigure.html" title="struct cosmic::cctk::sctk::shell::xdg::window::WindowConfigure">WindowConfigure</a>,
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
);
|
||
}</code></pre><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>wayland</code> and Linux</strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Handler for toplevel operations on a <a href="struct.Window.html" title="struct cosmic::cctk::sctk::shell::xdg::window::Window"><code>Window</code></a>.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.request_close" class="method"><h4 class="code-header">fn <a href="#tymethod.request_close" class="fn">request_close</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
window: &<a class="struct" href="struct.Window.html" title="struct cosmic::cctk::sctk::shell::xdg::window::Window">Window</a>,
|
||
)</h4></section></summary><div class="docblock"><p>Request to close a window.</p>
|
||
<p>This request does not destroy the window. You must drop all <a href="struct.Window.html" title="struct cosmic::cctk::sctk::shell::xdg::window::Window"><code>Window</code></a> handles to destroy the window.
|
||
This request may be sent either by the compositor or by some other mechanism (such as client side decorations).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.configure" class="method"><h4 class="code-header">fn <a href="#tymethod.configure" class="fn">configure</a>(
|
||
&mut self,
|
||
conn: &<a class="struct" href="../../../reexports/client/struct.Connection.html" title="struct cosmic::cctk::sctk::reexports::client::Connection">Connection</a>,
|
||
qh: &<a class="struct" href="../../../reexports/client/struct.QueueHandle.html" title="struct cosmic::cctk::sctk::reexports::client::QueueHandle">QueueHandle</a><Self>,
|
||
window: &<a class="struct" href="struct.Window.html" title="struct cosmic::cctk::sctk::shell::xdg::window::Window">Window</a>,
|
||
configure: <a class="struct" href="struct.WindowConfigure.html" title="struct cosmic::cctk::sctk::shell::xdg::window::WindowConfigure">WindowConfigure</a>,
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
)</h4></section></summary><div class="docblock"><p>Apply a suggested surface change.</p>
|
||
<p>When this function is called, the compositor is requesting the window’s size or state to change.</p>
|
||
<p>Internally this function is called when the underlying <code>xdg_surface</code> is configured. Any extension
|
||
protocols that interface with xdg-shell are able to be notified that the surface’s configure sequence
|
||
is complete by using this function.</p>
|
||
<h5 id="double-buffering"><a class="doc-anchor" href="#double-buffering">§</a>Double buffering</h5>
|
||
<p>Configure events in Wayland are considered to be double buffered and the state of the window does not
|
||
change until committed.</p>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../../../../trait.impl/smithay_client_toolkit/shell/xdg/window/trait.WindowHandler.js" async></script></section></div></main></body></html> |