leyoda/winit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of WindowBuilderExtWebSys methods (#2952)

Browse source
This commit is contained in:
daxpedda 2023-07-12 17:11:17 +02:00 • committed by GitHub
parent d7ec899d69
commit 5b5ebc25d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/platform/web.rs
View file

@ -41,6 +41,12 @@ pub trait WindowExtWebSys {
} }
pub trait WindowBuilderExtWebSys { pub trait WindowBuilderExtWebSys {
/// Pass an [`HtmlCanvasElement`] to be used for this [`Window`](crate::window::Window). If
/// [`None`], [`WindowBuilder::build()`] will create one.
///
/// In any case, the canvas won't be automatically inserted into the web page.
///
/// [`None`] by default.
fn with_canvas(self, canvas: Option<HtmlCanvasElement>) -> Self; fn with_canvas(self, canvas: Option<HtmlCanvasElement>) -> Self;
/// Whether `event.preventDefault` should be automatically called to prevent event propagation /// Whether `event.preventDefault` should be automatically called to prevent event propagation
@ -51,10 +57,14 @@ pub trait WindowBuilderExtWebSys {
/// ///
/// Some events are impossible to prevent. E.g. Firefox allows to access the native browser /// Some events are impossible to prevent. E.g. Firefox allows to access the native browser
/// context menu with Shift+Rightclick. /// context menu with Shift+Rightclick.
///
/// Enabled by default.
fn with_prevent_default(self, prevent_default: bool) -> Self; fn with_prevent_default(self, prevent_default: bool) -> Self;
/// Whether the canvas should be focusable using the tab key. This is necessary to capture /// Whether the canvas should be focusable using the tab key. This is necessary to capture
/// canvas keyboard events. /// canvas keyboard events.
///
/// Enabled by default.
fn with_focusable(self, focusable: bool) -> Self; fn with_focusable(self, focusable: bool) -> Self;
} }