slint/
lib.rs

1// Copyright © SixtyFPS GmbH <[email protected]>
2// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0
3
4// cSpell: ignore buildrs
5
6#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
7
8/*!
9# Slint
10
11This crate is the main entry point for embedding user interfaces designed with
12[Slint](https://slint.rs/) in Rust programs.
13*/
14#![doc = i_slint_core_macros::slint_doc_str!("If you are new to Slint, start with the [Walk-through **tutorial**](slint:quickstart).")]
15/*! If you are already familiar with Slint, the following topics provide related information.
16
17## Topics
18
19*/
20#![doc = i_slint_core_macros::slint_doc_str!("- [The Slint Language Documentation](slint:index)")]
21/*! - [Type mappings between .slint and Rust](docs::type_mappings)
22 - [Feature flags and backend selection](docs::cargo_features)
23 - [Slint on Microcontrollers](docs::mcu)
24
25## How to use this crate:
26
27Designs of user interfaces are described in the `.slint` design markup language. There are three ways
28of including them in Rust:
29
30 - The `.slint` code is [inline in a macro](#the-slint-code-in-a-macro).
31 - The `.slint` code in [external files compiled with `build.rs`](#the-slint-code-in-external-files-is-compiled-with-buildrs)
32*/
33#![doc = i_slint_core_macros::slint_doc_str!(" - The `.slint` code is loaded dynamically at run-time from the file system, by using the [interpreter API](slint:rust:slint_interpreter/).")]
34/*!
35
36With the first two methods, the markup code is translated to Rust code and each component is turned into a Rust
37struct with functions. Use these functions to instantiate and show the component, and
38to access declared properties. Check out our [sample component](docs::generated_code::SampleComponent) for more
39information about the generation functions and how to use them.
40
41### The .slint code in a macro
42
43This method combines your Rust code with the `.slint` design markup in one file, using a macro:
44
45```rust,no_run
46slint::slint!{
47    export component HelloWorld inherits Window {
48        Text {
49            text: "hello world";
50            color: green;
51        }
52    }
53}
54fn main() {
55    HelloWorld::new().unwrap().run().unwrap();
56}
57```
58
59### The .slint code in external files is compiled with `build.rs`
60
61When your design becomes bigger in terms of markup code, you may want move it to a dedicated
62`.slint` file. */
63#![doc = i_slint_core_macros::slint_doc_str!("It's also possible to split a `.slint` file into multiple files using [modules](slint:modules).")]
64/*!Use a [build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) to compile
65your main `.slint` file:
66
67*/
68#![doc = i_slint_core_macros::slint_doc_str!("In your Cargo.toml add a `build` assignment and use the [`slint-build`](slint:rust:slint_build/) crate in `build-dependencies`:")]
69/*!
70
71```toml
72[package]
73...
74build = "build.rs"
75edition = "2021"
76
77[dependencies]
78slint = "1.13"
79...
80
81[build-dependencies]
82slint-build = "1.13"
83```
84
85Use the API of the slint-build crate in the `build.rs` file:
86
87```rust,no_run
88fn main() {
89    slint_build::compile("ui/hello.slint").unwrap();
90}
91```
92
93Finally, use the [`include_modules!`] macro in your `main.rs`:
94
95```ignore
96slint::include_modules!();
97fn main() {
98    HelloWorld::new().unwrap().run().unwrap();
99}
100```
101
102Use our [Template Repository](https://github.com/slint-ui/slint-rust-template) to create a skeleton file
103hierarchy that uses this method:
104
1051. Download and extract the [ZIP archive of the Rust Template](https://github.com/slint-ui/slint-rust-template/archive/refs/heads/main.zip).
1062. Rename the extracted directory and change into it:
107
108```bash
109mv slint-rust-template-main my-project
110cd my-project
111```
112
113## Generated components
114
115Exported component from the macro or the main file that inherit `Window` or `Dialog` is mapped to a Rust structure.
116
117The components are generated and re-exported to the location of the [`include_modules!`] or [`slint!`] macro.
118It is represented as a struct with the same name as the component.
119
120For example, if you have
121
122```slint,no-preview
123export component MyComponent inherits Window { /*...*/ }
124```
125
126in the .slint file, it will create a
127```rust
128struct MyComponent { /*...*/ }
129```
130
131See also our [sample component](docs::generated_code::SampleComponent) for more information about the API of the generated struct.
132
133A component is instantiated using the [`fn new() -> Self`](docs::generated_code::SampleComponent::new) function. The following
134convenience functions are available through the [`ComponentHandle`] implementation:
135
136  - [`fn clone_strong(&self) -> Self`](docs::generated_code::SampleComponent::clone_strong): creates a strongly referenced clone of the component instance.
137  - [`fn as_weak(&self) -> Weak`](docs::generated_code::SampleComponent::as_weak): to create a [weak](Weak) reference to the component instance.
138  - [`fn show(&self)`](docs::generated_code::SampleComponent::show): to show the window of the component.
139  - [`fn hide(&self)`](docs::generated_code::SampleComponent::hide): to hide the window of the component.
140  - [`fn run(&self)`](docs::generated_code::SampleComponent::run): a convenience function that first calls `show()`,
141    followed by spinning the event loop, and `hide()` when returning from the event loop.
142  - [`fn global<T: Global<Self>>(&self) -> T`](docs::generated_code::SampleComponent::global): an accessor to the global singletons,
143
144For each top-level property
145  - A setter [`fn set_<property_name>(&self, value: <PropertyType>)`](docs::generated_code::SampleComponent::set_counter)
146  - A getter [`fn get_<property_name>(&self) -> <PropertyType>`](docs::generated_code::SampleComponent::get_counter)
147
148For each top-level callback
149  - [`fn invoke_<callback_name>(&self)`](docs::generated_code::SampleComponent::invoke_hello): to invoke the callback
150  - [`fn on_<callback_name>(&self, callback: impl Fn(<CallbackArgs>) + 'static)`](docs::generated_code::SampleComponent::on_hello): to set the callback handler.
151
152Note: All dashes (`-`) are replaced by underscores (`_`) in names of types or functions.
153
154After instantiating the component, call [`ComponentHandle::run()`] on show it on the screen and spin the event loop to
155react to input events. To show multiple components simultaneously, call [`ComponentHandle::show()`] on each instance.
156Call [`run_event_loop()`] when you're ready to enter the event loop.
157
158The generated component struct acts as a handle holding a strong reference (similar to an `Rc`). The `Clone` trait is
159not implemented. Instead you need to make explicit [`ComponentHandle::clone_strong`] and [`ComponentHandle::as_weak`]
160calls. A strong reference should not be captured by the closures given to a callback, as this would produce a reference
161loop and leak the component. Instead, the callback function should capture a weak component.
162
163## Threading and Event-loop
164
165For platform-specific reasons, the event loop must run in the main thread, in most backends, and all the components
166must be created in the same thread as the thread the event loop is running or is going to run.
167
168You should perform the minimum amount of work in the main thread and delegate the actual logic to another
169thread to avoid blocking animations. Use the [`invoke_from_event_loop`] function to communicate from your worker thread to the UI thread.
170
171To run a function with a delay or with an interval use a [`Timer`].
172
173To run an async function or a future, use [`spawn_local()`].
174
175## Exported Global singletons
176
177*/
178#![doc = i_slint_core_macros::slint_doc_str!("When you export a [global singleton](slint:globals) from the main file,")]
179/*! it is also generated with the exported name. Like the main component, the generated struct have
180inherent method to access the properties and callback:
181
182For each property
183  - A setter: `fn set_<property_name>(&self, value: <PropertyType>)`
184  - A getter: `fn get_<property_name>(&self) -> <PropertyType>`
185
186For each callback
187  - `fn invoke_<callback_name>(&self, <CallbackArgs>) -> <ReturnValue>` to invoke the callback
188  - `fn on_<callback_name>(&self, callback: impl Fn(<CallbackArgs>) + 'static)` to set the callback handler.
189
190The global can be accessed with the [`ComponentHandle::global()`] function, or with [`Global::get()`]
191
192See the [documentation of the `Global` trait](Global) for an example.
193
194**Note**: Global singletons are instantiated once per component. When declaring multiple components for `export` to Rust,
195each instance will have their own instance of associated globals singletons.
196*/
197
198#![warn(missing_docs)]
199#![deny(unsafe_code)]
200#![doc(html_logo_url = "https://slint.dev/logo/slint-logo-square-light.svg")]
201#![cfg_attr(not(feature = "std"), no_std)]
202#![allow(clippy::needless_doctest_main)] // We document how to write a main function
203
204extern crate alloc;
205
206#[cfg(not(feature = "compat-1-2"))]
207compile_error!(
208    "The feature `compat-1-2` must be enabled to ensure \
209    forward compatibility with future version of this crate"
210);
211
212pub use slint_macros::slint;
213
214pub use i_slint_core::api::*;
215#[doc(hidden)]
216#[deprecated(note = "Experimental type was made public by mistake")]
217pub use i_slint_core::component_factory::ComponentFactory;
218#[cfg(not(target_arch = "wasm32"))]
219pub use i_slint_core::graphics::{BorrowedOpenGLTextureBuilder, BorrowedOpenGLTextureOrigin};
220// keep in sync with internal/interpreter/api.rs
221pub use i_slint_core::graphics::{
222    Brush, Color, Image, LoadImageError, Rgb8Pixel, Rgba8Pixel, RgbaColor, SharedPixelBuffer,
223};
224pub use i_slint_core::model::{
225    FilterModel, MapModel, Model, ModelExt, ModelNotify, ModelPeer, ModelRc, ModelTracker,
226    ReverseModel, SortModel, StandardListViewItem, TableColumn, VecModel,
227};
228pub use i_slint_core::sharedvector::SharedVector;
229pub use i_slint_core::timers::{Timer, TimerMode};
230pub use i_slint_core::translations::{select_bundled_translation, SelectBundledTranslationError};
231pub use i_slint_core::{
232    format,
233    string::{SharedString, ToSharedString},
234};
235
236pub mod private_unstable_api;
237
238/// Enters the main event loop. This is necessary in order to receive
239/// events from the windowing system for rendering to the screen
240/// and reacting to user input.
241/// This function will run until the last window is closed or until
242/// [`quit_event_loop()`] is called.
243///
244/// See also [`run_event_loop_until_quit()`] to keep the event loop running until
245/// [`quit_event_loop()`] is called, even if all windows are closed.
246pub fn run_event_loop() -> Result<(), PlatformError> {
247    i_slint_backend_selector::with_platform(|b| b.run_event_loop())
248}
249
250/// Similar to [`run_event_loop()`], but this function enters the main event loop
251/// and continues to run even when the last window is closed, until
252/// [`quit_event_loop()`] is called.
253///
254/// This is useful for system tray applications where the application needs to stay alive
255/// even if no windows are visible.
256pub fn run_event_loop_until_quit() -> Result<(), PlatformError> {
257    i_slint_backend_selector::with_platform(|b| {
258        #[allow(deprecated)]
259        b.set_event_loop_quit_on_last_window_closed(false);
260        b.run_event_loop()
261    })
262}
263
264/// Spawns a [`Future`](core::future::Future) to execute in the Slint event loop.
265///
266/// This function is intended to be invoked only from the main Slint thread that runs the event loop.
267///
268/// For spawning a `Send` future from a different thread, this function should be called from a closure
269/// passed to [`invoke_from_event_loop()`].
270///
271/// This function is typically called from a UI callback.
272///
273/// # Example
274///
275/// ```rust,no_run
276/// slint::spawn_local(async move {
277///     // your async code goes here
278/// }).unwrap();
279/// ```
280///
281/// # Compatibility with Tokio and other runtimes
282///
283/// The runtime used to execute the future on the main thread is platform-dependent,
284/// for instance, it could be the winit event loop. Therefore, futures that assume a specific runtime
285/// may not work. This may be an issue if you call `.await` on a future created by another
286/// runtime, or pass the future directly to `spawn_local`.
287///
288/// Futures from the [smol](https://docs.rs/smol/latest/smol/) runtime always hand off their work to
289/// separate I/O threads that run in parallel to the Slint event loop.
290///
291/// The [Tokio](https://docs.rs/tokio/latest/tokio/index.html) runtime is subject to the following constraints:
292///
293/// * Tokio futures require entering the context of a global Tokio runtime.
294/// * Tokio futures aren't guaranteed to hand off their work to separate threads and may therefore not complete, because
295/// the Slint runtime can't drive the Tokio runtime.
296/// * Tokio futures require regular yielding to the Tokio runtime for fairness, a constraint that also can't be met by Slint.
297/// * Tokio's [current-thread schedule](https://docs.rs/tokio/latest/tokio/runtime/index.html#current-thread-scheduler)
298/// cannot be used in Slint main thread, because Slint cannot yield to it.
299///
300/// To address these constraints, use [async_compat](https://docs.rs/async-compat/latest/async_compat/index.html)'s [Compat::new()](https://docs.rs/async-compat/latest/async_compat/struct.Compat.html#method.new)
301/// to implicitly allocate a shared, multi-threaded Tokio runtime that will be used for Tokio futures.
302///
303/// The following little example demonstrates the use of Tokio's [`TcpStream`](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html) to
304/// read from a network socket. The entire future passed to `spawn_local()` is wrapped in `Compat::new()` to make it run:
305///
306/// ```rust,no_run
307/// // A dummy TCP server that once reports "Hello World"
308/// # i_slint_backend_testing::init_integration_test_with_mock_time();
309/// use std::io::Write;
310///
311/// let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
312/// let local_addr = listener.local_addr().unwrap();
313/// let server = std::thread::spawn(move || {
314///     let mut stream = listener.incoming().next().unwrap().unwrap();
315///     stream.write("Hello World".as_bytes()).unwrap();
316/// });
317///
318/// let slint_future = async move {
319///     use tokio::io::AsyncReadExt;
320///     let mut stream = tokio::net::TcpStream::connect(local_addr).await.unwrap();
321///     let mut data = Vec::new();
322///     stream.read_to_end(&mut data).await.unwrap();
323///     assert_eq!(data, "Hello World".as_bytes());
324///     slint::quit_event_loop().unwrap();
325/// };
326///
327/// // Wrap the future that includes Tokio futures in async_compat's `Compat` to ensure
328/// // presence of a Tokio run-time.
329/// slint::spawn_local(async_compat::Compat::new(slint_future)).unwrap();
330///
331/// slint::run_event_loop_until_quit().unwrap();
332///
333/// server.join().unwrap();
334/// ```
335///
336/// The use of `#[tokio::main]` is **not recommended**. If it's necessary to use though, wrap the call to enter the Slint
337/// event loop  in a call to [`tokio::task::block_in_place`](https://docs.rs/tokio/latest/tokio/task/fn.block_in_place.html):
338///
339/// ```rust, no_run
340/// // Wrap the call to run_event_loop to ensure presence of a Tokio run-time.
341/// tokio::task::block_in_place(slint::run_event_loop).unwrap();
342/// ```
343#[cfg(target_has_atomic = "ptr")]
344pub fn spawn_local<F: core::future::Future + 'static>(
345    fut: F,
346) -> Result<JoinHandle<F::Output>, EventLoopError> {
347    i_slint_backend_selector::with_global_context(|ctx| ctx.spawn_local(fut))
348        .map_err(|_| EventLoopError::NoEventLoopProvider)?
349}
350
351#[i_slint_core_macros::slint_doc]
352/// Include the code generated with the slint-build crate from the build script. After calling `slint_build::compile`
353/// in your `build.rs` build script, the use of this macro includes the generated Rust code and makes the exported types
354/// available for you to instantiate.
355///
356/// Check the documentation of the [`slint-build`](slint:rust:slint_build) crate for more information.
357#[macro_export]
358macro_rules! include_modules {
359    () => {
360        include!(env!("SLINT_INCLUDE_GENERATED"));
361    };
362}
363
364#[i_slint_core_macros::slint_doc]
365/// Initialize translations when using the `gettext` feature.
366///
367/// Call this in your main function with the path where translations are located.
368/// This macro internally calls the [`bindtextdomain`](https://man7.org/linux/man-pages/man3/bindtextdomain.3.html) function from gettext.
369///
370/// The first argument of the macro must be an expression that implements `Into<std::path::PathBuf>`.
371/// It specifies the directory in which gettext should search for translations.
372///
373/// Translations are expected to be found at `<dirname>/<locale>/LC_MESSAGES/<crate>.mo`,
374/// where `dirname` is the directory passed as an argument to this macro,
375/// `locale` is a locale name (e.g., `en`, `en_GB`, `fr`), and
376/// `crate` is the package name obtained from the `CARGO_PKG_NAME` environment variable.
377///
378/// See also the [Translation documentation](slint:translations).
379///
380/// ### Example
381/// ```rust
382/// fn main() {
383///    slint::init_translations!(concat!(env!("CARGO_MANIFEST_DIR"), "/translations/"));
384///    // ...
385/// }
386/// ```
387///
388/// For example, assuming this is in a crate called `example` and the default locale
389/// is configured to be French, it will load translations at runtime from
390/// `/path/to/example/translations/fr/LC_MESSAGES/example.mo`.
391///
392/// Another example of loading translations relative to the executable:
393/// ```rust
394/// slint::init_translations!(std::env::current_exe().unwrap().parent().unwrap().join("translations"));
395/// ```
396#[cfg(feature = "gettext")]
397#[macro_export]
398macro_rules! init_translations {
399    ($dirname:expr) => {
400        $crate::private_unstable_api::init_translations(env!("CARGO_PKG_NAME"), $dirname);
401    };
402}
403
404/// This module contains items that you need to use or implement if you want use Slint in an environment without
405/// one of the supplied platform backends such as qt or winit.
406///
407/// The primary interface is the [`platform::Platform`] trait. Pass your implementation of it to Slint by calling
408/// [`platform::set_platform()`] early on in your application, before creating any Slint components.
409///
410/// The [Slint on Microcontrollers](crate::docs::mcu) documentation has additional examples.
411pub mod platform {
412    pub use i_slint_core::platform::*;
413
414    /// This module contains the [`femtovg_renderer::FemtoVGRenderer`] and related types.
415    ///
416    /// It is only enabled when the `renderer-femtovg` Slint feature is enabled.
417    #[cfg(all(feature = "renderer-femtovg", not(target_os = "android")))]
418    pub mod femtovg_renderer {
419        pub use i_slint_renderer_femtovg::opengl::OpenGLInterface;
420        pub use i_slint_renderer_femtovg::FemtoVGOpenGLRenderer as FemtoVGRenderer;
421    }
422}
423
424#[cfg(any(
425    doc,
426    all(
427        target_os = "android",
428        any(feature = "backend-android-activity-05", feature = "backend-android-activity-06")
429    )
430))]
431pub mod android;
432
433pub use i_slint_backend_selector::api::*;
434
435/// Helper type that helps checking that the generated code is generated for the right version
436#[doc(hidden)]
437#[allow(non_camel_case_types)]
438pub struct VersionCheck_1_13_1;
439
440#[cfg(doctest)]
441mod compile_fail_tests;
442
443#[cfg(doc)]
444pub mod docs;
445
446#[cfg(feature = "unstable-wgpu-26")]
447pub mod wgpu_26 {
448    //! WGPU 26.x specific types and re-exports.
449    //!
450    //! *Note*: This module is behind a feature flag and may be removed or changed in future minor releases,
451    //!         as new major WGPU releases become available.
452    //!
453    //! Use the types in this module in combination with other APIs to integrate external, WGPU-based rendering engines
454    //! into a UI with Slint.
455    //!
456    //! First, ensure that WGPU is used for rendering with Slint by using [`slint::BackendSelector::require_wgpu_26()`](i_slint_backend_selector::api::BackendSelector::require_wgpu_26()).
457    //! This function accepts a pre-configured WGPU setup or configuration hints such as required features or memory limits.
458    //!
459    //! For rendering, it's crucial that you're using the same [`wgpu::Device`] and [`wgpu::Queue`] for allocating textures or submitting commands as Slint. Obtain the same queue
460    //! by either using [`WGPUConfiguration::Manual`] to make Slint use an existing WGPU configuration, or use [`slint::Window::set_rendering_notifier()`](i_slint_core::api::Window::set_rendering_notifier())
461    //! to let Slint invoke a callback that provides access device, queue, etc. in [`slint::GraphicsAPI::WGPU26`](i_slint_core::api::GraphicsAPI::WGPU26).
462    //!
463    //! To integrate rendering content into a scene shared with a Slint UI, use either [`slint::Window::set_rendering_notifier()`](i_slint_core::api::Window::set_rendering_notifier()) to render an underlay
464    //! or overlay, or integrate externally produced [`wgpu::Texture`]s using [`slint::Image::try_from<wgpu::Texture>()`](i_slint_core::graphics::Image::try_from).
465    //!
466    //! The following example allocates a [`wgpu::Texture`] and, for the sake of simplicity in this documentation, fills with green as color, and then proceeds to set it as a `slint::Image` in the scene.
467    //!
468    //! `Cargo.toml`:
469    //! ```toml
470    //! slint = { version = "~1.13", features = ["unstable-wgpu-26"] }
471    //! ```
472    //!
473    //! `main.rs`:
474    //!```rust,no_run
475    //!
476    //! use slint::wgpu_26::wgpu;
477    //! use wgpu::util::DeviceExt;
478    //!
479    //!slint::slint!{
480    //!    export component HelloWorld inherits Window {
481    //!        preferred-width: 320px;
482    //!        preferred-height: 300px;
483    //!        in-out property <image> app-texture;
484    //!        VerticalLayout {
485    //!            Text {
486    //!                text: "hello world";
487    //!                color: green;
488    //!            }
489    //!            Image { source: root.app-texture; }
490    //!        }
491    //!    }
492    //!}
493    //!fn main() -> Result<(), Box<dyn std::error::Error>> {
494    //!    slint::BackendSelector::new()
495    //!        .require_wgpu_26(slint::wgpu_26::WGPUConfiguration::default())
496    //!        .select()?;
497    //!    let app = HelloWorld::new()?;
498    //!
499    //!    let app_weak = app.as_weak();
500    //!
501    //!    app.window().set_rendering_notifier(move |state, graphics_api| {
502    //!        let (Some(app), slint::RenderingState::RenderingSetup, slint::GraphicsAPI::WGPU26{ device, queue, ..}) = (app_weak.upgrade(), state, graphics_api) else {
503    //!            return;
504    //!        };
505    //!
506    //!        let mut pixels = slint::SharedPixelBuffer::<slint::Rgba8Pixel>::new(320, 200);
507    //!        pixels.make_mut_slice().fill(slint::Rgba8Pixel {
508    //!            r: 0,
509    //!            g: 255,
510    //!            b :0,
511    //!            a: 255,
512    //!        });
513    //!
514    //!        let texture = device.create_texture_with_data(queue,
515    //!            &wgpu::TextureDescriptor {
516    //!                label: None,
517    //!                size: wgpu::Extent3d { width: 320, height: 200, depth_or_array_layers: 1 },
518    //!                mip_level_count: 1,
519    //!                sample_count: 1,
520    //!                dimension: wgpu::TextureDimension::D2,
521    //!                format: wgpu::TextureFormat::Rgba8Unorm,
522    //!                usage: wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::TEXTURE_BINDING,
523    //!                view_formats: &[],
524    //!            },
525    //!            wgpu::util::TextureDataOrder::default(),
526    //!            pixels.as_bytes(),
527    //!        );
528    //!
529    //!        let imported_image = slint::Image::try_from(texture).unwrap();
530    //!
531    //!        app.set_app_texture(imported_image);
532    //!    })?;
533    //!
534    //!    app.run()?;
535    //!
536    //!    Ok(())
537    //!}
538    //!```
539    //!
540    pub use i_slint_core::graphics::wgpu_26::api::*;
541}
542
543#[cfg(feature = "unstable-winit-030")]
544pub mod winit_030 {
545    //! Winit 0.30.x specific types and re-exports.
546    //!
547    //! *Note*: This module is behind a feature flag and may be removed or changed in future minor releases,
548    //!         as new major Winit releases become available.
549    //!
550    //! Use the types and traits in this module in combination with other APIs to access additional window properties,
551    //! create custom windows, or hook into the winit event loop.
552    //!
553    //! For example, use the [`WinitWindowAccessor`] to obtain access to the underling [`winit::window::Window`]:
554    //!
555    //! `Cargo.toml`:
556    //! ```toml
557    //! slint = { version = "~1.12", features = ["unstable-winit-030"] }
558    //! ```
559    //!
560    //! `main.rs`:
561    //! ```rust,no_run
562    //! // Bring winit and accessor traits into scope.
563    //! use slint::winit_030::{WinitWindowAccessor, winit};
564    //!
565    //! slint::slint!{
566    //!     import { VerticalBox, Button } from "std-widgets.slint";
567    //!     export component HelloWorld inherits Window {
568    //!         callback clicked;
569    //!         VerticalBox {
570    //!             Text {
571    //!                 text: "hello world";
572    //!                 color: green;
573    //!             }
574    //!             Button {
575    //!                 text: "Click me";
576    //!                 clicked => { root.clicked(); }
577    //!             }
578    //!         }
579    //!     }
580    //! }
581    //! fn main() -> Result<(), Box<dyn std::error::Error>> {
582    //!     // Make sure the winit backed is selected:
583    //!    slint::BackendSelector::new()
584    //!        .backend_name("winit".into())
585    //!        .select()?;
586    //!
587    //!     let app = HelloWorld::new()?;
588    //!     let app_weak = app.as_weak();
589    //!     app.on_clicked(move || {
590    //!         // access the winit window
591    //!         let app = app_weak.unwrap();
592    //!         app.window().with_winit_window(|winit_window: &winit::window::Window| {
593    //!             eprintln!("window id = {:#?}", winit_window.id());
594    //!         });
595    //!     });
596    //!     app.run()?;
597    //!     Ok(())
598    //! }
599    //! ```
600    //! See also [`BackendSelector::with_winit_event_loop_builder()`](crate::BackendSelector::with_winit_event_loop_builder())
601    //! and [`BackendSelector::with_winit_window_attributes_hook()`](crate::BackendSelector::with_winit_window_attributes_hook()).
602
603    pub use i_slint_backend_winit::{
604        winit, CustomApplicationHandler, EventLoopBuilder, EventResult, SlintEvent,
605        WinitWindowAccessor,
606    };
607
608    #[deprecated(note = "Renamed to `EventResult`")]
609    /// Deprecated alias to [`EventResult`]
610    pub type WinitWindowEventResult = EventResult;
611}