winio-handle 0.7.0

Window handle for winio.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Handles for winio.
//!
//! # Window
//!
//! A window handle represents a window chrome, such as title bar and borders.
//! It interoperates with the underlying windowing system, such as Win32 or
//! WinUI on Windows, and AppKit on macOS.
//!
//! A window is usually both a window and a container, so it implements both
//! [`AsWindow`] and [`AsContainer`] traits.
//!
//! | Platform | Native Type      |
//! | -------- | ---------------- |
//! | Win32    | [`HWND`]         |
//! | WinUI    | [`Window`]       |
//! | Qt       | [`QWidget`]      |
//! | Gtk      | [`GtkWindow`]    |
//! | AppKit   | [`NSWindow`]     |
//! | UIKit    | [`UIWindow`]     |
//! | Android  | [`GameActivity`] |
//!
//! ## Platform specific
//! * Qt: The window is a [`QMainWindow`].
//!
//! # Container
//!
//! A container handle represents a container, such as a window or a scroll
//! view.
//!
//! | Platform | Native Type     |
//! | -------- | --------------- |
//! | Win32    | [`HWND`]        |
//! | WinUI    | [`Canvas`]      |
//! | Qt       | [`QWidget`]     |
//! | Gtk      | [`GtkFixed`]    |
//! | AppKit   | [`NSView`]      |
//! | UIKit    | [`UIView`]      |
//! | Android  | [`FrameLayout`] |
//!
//! ## Platform specific
//! * WinUI: The parent of all widgets must be a [`Canvas`], and the widget will
//!   be set to center alignment. The window of WinUI contains a [`Canvas`].
//! * Gtk: The parent of all widgets must be a [`GtkFixed`]. The window of Gtk
//!   contains a [`GtkScrolledWindow`], and the scrolled window contains a
//!   [`GtkFixed`].
//!
//! # Widget
//!
//! A widget handle represents a widget, such as a button or a text box.
//!
//! | Platform | Native Type          |
//! | -------- | -------------------- |
//! | Win32    | [`HWND`]             |
//! | WinUI    | [`FrameworkElement`] |
//! | Qt       | [`QWidget`]          |
//! | Gtk      | [`GtkWidget`]        |
//! | AppKit   | [`NSView`]           |
//! | UIKit    | [`UIView`]           |
//! | Android  | [`View`]             |
//!
//! [`HWND`]: https://learn.microsoft.com/en-us/windows/apps/develop/ui/retrieve-hwnd
//! [`Window`]: https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.window
//! [`Canvas`]: https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.controls.canvas
//! [`FrameworkElement`]: https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.ui.xaml.frameworkelement
//! [`QWidget`]: https://doc.qt.io/qt-6/qwidget.html
//! [`QMainWindow`]: https://doc.qt.io/qt-6/qmainwindow.html
//! [`GtkWindow`]: https://docs.gtk.org/gtk4/class.Window.html
//! [`GtkFixed`]: https://docs.gtk.org/gtk4/class.Fixed.html
//! [`GtkScrolledWindow`]: https://docs.gtk.org/gtk4/class.ScrolledWindow.html
//! [`GtkWidget`]: https://docs.gtk.org/gtk4/class.Widget.html
//! [`NSWindow`]: https://developer.apple.com/documentation/appkit/nswindow
//! [`NSView`]: https://developer.apple.com/documentation/appkit/nsview
//! [`UIWindow`]: https://developer.apple.com/documentation/uikit/uiwindow
//! [`UIView`]: https://developer.apple.com/documentation/uikit/uiview
//! [`GameActivity`]: https://developer.android.com/games/agdk/game-activity
//! [`FrameLayout`]: https://developer.android.com/reference/android/widget/FrameLayout
//! [`View`]: https://developer.android.com/reference/android/view/View

#![cfg_attr(docsrs, feature(doc_cfg))]
#![warn(missing_docs)]

mod window;
pub use window::*;

mod widget;
pub use widget::*;

mod container;
pub use container::*;