diff options
Diffstat (limited to '')
| -rw-r--r-- | Cargo.toml | 6 | ||||
| -rw-r--r-- | src/event.rs | 5 | ||||
| -rw-r--r-- | src/input/button_state.rs | 5 | ||||
| -rw-r--r-- | src/input/keyboard/event.rs | 5 | ||||
| -rw-r--r-- | src/input/keyboard/key_code.rs | 9 | ||||
| -rw-r--r-- | src/input/mouse/button.rs | 5 | ||||
| -rw-r--r-- | src/input/mouse/event.rs | 5 |
7 files changed, 37 insertions, 3 deletions
@@ -11,6 +11,12 @@ readme = "README.md" keywords = ["gui", "ui", "graphics", "interface", "widgets"] categories = ["gui"] +[badges] +maintenance = { status = "actively-developed" } + +[package.metadata.docs.rs] +features = ["winit"] + [dependencies] stretch = "0.2" twox-hash = "1.5" diff --git a/src/event.rs b/src/event.rs index fea0e462..71f06006 100644 --- a/src/event.rs +++ b/src/event.rs @@ -1,6 +1,11 @@ use crate::input::{keyboard, mouse}; /// A user interface event. +/// +/// _**Note:** This type is largely incomplete! If you need to track +/// additional events, feel free to [open an issue] and share your use case!_ +/// +/// [open an issue]: https://github.com/hecrj/iced/issues #[derive(PartialEq, Clone, Copy, Debug)] pub enum Event { /// A keyboard event diff --git a/src/input/button_state.rs b/src/input/button_state.rs index 3a3472fb..e9dc05d7 100644 --- a/src/input/button_state.rs +++ b/src/input/button_state.rs @@ -1,4 +1,9 @@ /// The state of a button. +/// +/// If you are using [`winit`], consider enabling the `winit` feature to get +/// conversion implementations for free! +/// +/// [`winit`]: https://docs.rs/winit/0.20.0-alpha3/winit/ #[derive(Debug, Hash, Ord, PartialOrd, PartialEq, Eq, Clone, Copy)] pub enum ButtonState { /// The button is pressed. diff --git a/src/input/keyboard/event.rs b/src/input/keyboard/event.rs index 5acd46c0..8118f112 100644 --- a/src/input/keyboard/event.rs +++ b/src/input/keyboard/event.rs @@ -3,6 +3,11 @@ use crate::input::ButtonState; #[derive(Debug, Clone, Copy, PartialEq)] /// A keyboard event. +/// +/// _**Note:** This type is largely incomplete! If you need to track +/// additional events, feel free to [open an issue] and share your use case!_ +/// +/// [open an issue]: https://github.com/hecrj/iced/issues pub enum Event { /// A keyboard key was pressed or released. Input { diff --git a/src/input/keyboard/key_code.rs b/src/input/keyboard/key_code.rs index 9b449735..207ddeac 100644 --- a/src/input/keyboard/key_code.rs +++ b/src/input/keyboard/key_code.rs @@ -1,8 +1,11 @@ /// The symbolic name of a keyboard key. /// -/// This is mostly the `KeyCode` type found in `winit`. If you are using -/// `winit`, consider enabling the `winit` feature to get conversion -/// implementations for free! +/// This is mostly the `KeyCode` type found in [`winit`]. +/// +/// If you are using [`winit`], consider enabling the `winit` feature to get +/// conversion implementations for free! +/// +/// [`winit`]: https://docs.rs/winit/0.20.0-alpha3/winit/ #[derive(Debug, Hash, Ord, PartialOrd, PartialEq, Eq, Clone, Copy)] #[repr(u32)] #[allow(missing_docs)] diff --git a/src/input/mouse/button.rs b/src/input/mouse/button.rs index e552af5a..6320d701 100644 --- a/src/input/mouse/button.rs +++ b/src/input/mouse/button.rs @@ -1,4 +1,9 @@ /// The button of a mouse. +/// +/// If you are using [`winit`], consider enabling the `winit` feature to get +/// conversion implementations for free! +/// +/// [`winit`]: https://docs.rs/winit/0.20.0-alpha3/winit/ #[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)] pub enum Button { /// The left mouse button. diff --git a/src/input/mouse/event.rs b/src/input/mouse/event.rs index 1f7a1547..7b68208f 100644 --- a/src/input/mouse/event.rs +++ b/src/input/mouse/event.rs @@ -2,6 +2,11 @@ use super::Button; use crate::input::ButtonState; /// A mouse event. +/// +/// _**Note:** This type is largely incomplete! If you need to track +/// additional events, feel free to [open an issue] and share your use case!_ +/// +/// [open an issue]: https://github.com/hecrj/iced/issues #[derive(Debug, Clone, Copy, PartialEq)] pub enum Event { /// The mouse cursor entered the window. |