summaryrefslogtreecommitdiffstats
path: root/core/src/keyboard
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón <hector0193@gmail.com>2022-05-02 21:21:24 +0200
committerLibravatar GitHub <noreply@github.com>2022-05-02 21:21:24 +0200
commit5acba65c1135d8ebbda94efc74ea0bebb29c438a (patch)
tree88673403313ad90cec226ee92d4ebf4ef0a24bdc /core/src/keyboard
parenta17a7103d382f02c64e7b271d953ea6babffac97 (diff)
parent7e111f273fb22a6ffc7a4fd24bea5e838d276758 (diff)
downloadiced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.tar.gz
iced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.tar.bz2
iced-5acba65c1135d8ebbda94efc74ea0bebb29c438a.zip
Merge pull request #1327 from iced-rs/update-docs
Update documentation
Diffstat (limited to 'core/src/keyboard')
-rw-r--r--core/src/keyboard/modifiers.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/core/src/keyboard/modifiers.rs b/core/src/keyboard/modifiers.rs
index e61f145a..ff5b08f2 100644
--- a/core/src/keyboard/modifiers.rs
+++ b/core/src/keyboard/modifiers.rs
@@ -41,21 +41,29 @@ impl Modifiers {
};
/// Returns true if the [`SHIFT`] key is pressed in the [`Modifiers`].
+ ///
+ /// [`SHIFT`]: Self::SHIFT
pub fn shift(self) -> bool {
self.contains(Self::SHIFT)
}
/// Returns true if the [`CTRL`] key is pressed in the [`Modifiers`].
+ ///
+ /// [`CTRL`]: Self::CTRL
pub fn control(self) -> bool {
self.contains(Self::CTRL)
}
/// Returns true if the [`ALT`] key is pressed in the [`Modifiers`].
+ ///
+ /// [`ALT`]: Self::ALT
pub fn alt(self) -> bool {
self.contains(Self::ALT)
}
/// Returns true if the [`LOGO`] key is pressed in the [`Modifiers`].
+ ///
+ /// [`LOGO`]: Self::LOGO
pub fn logo(self) -> bool {
self.contains(Self::LOGO)
}