From 17f5bb8c9cece4fbfb00d3e47b04e266e18430f0 Mon Sep 17 00:00:00 2001 From: fabianlars Date: Tue, 7 Jan 2025 12:15:42 +0100 Subject: [PATCH] usage warnings --- src/lib.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 001219c58..c35b5d4e9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1251,7 +1251,8 @@ pub trait WebViewBuilderExtDarwin { /// Move the window controls to the specified position. /// Normally this is handled by the Window but because `WebViewBuilder::build()` overwrites the window's NSView the controls will flicker on resizing. /// Note: This method has no effects if the WebView is injected via `WebViewBuilder::build_as_child();` and there should be no flickers. - /// Note: Do not use this if your chosen window library does not support traffic light insets. + /// Warning: Do not use this if your chosen window library does not support traffic light insets. + /// Warning: Only use this in **decorated** windows with a **hidden titlebar**! fn with_traffic_light_inset>(self, position: P) -> Self; } @@ -1931,7 +1932,8 @@ pub trait WebViewExtMacOS { /// Move the window controls to the specified position. /// Normally this is handled by the Window but because `WebViewBuilder::build()` overwrites the window's NSView the controls will flicker on resizing. /// Note: This method has no effects if the WebView is injected via `WebViewBuilder::build_as_child();` and there should be no flickers. - /// Note: Do not use this if your chosen window library does not support traffic light insets. + /// Warning: Do not use this if your chosen window library does not support traffic light insets. + /// Warning: Only use this in **decorated** windows with a **hidden titlebar**! fn set_traffic_light_inset>(&self, position: P) -> Result<()>; }