Struct fltk::enums::Key

pub struct Key { /* fields omitted */ }

Defines the inputted virtual keycode

Implementations

impl Key

pub const None: Key

None

pub const Button: Key

Button

pub const BackSpace: Key

BackSpace

pub const Tab: Key

Tab

pub const IsoKey: Key

IsoKey

pub const Enter: Key

Enter

pub const Pause: Key

Pause

pub const ScrollLock: Key

ScrollLock

pub const Escape: Key

Escape

pub const Kana: Key

Kana

pub const Eisu: Key

Eisu

pub const Yen: Key

Yen

pub const JISUnderscore: Key

JISUnderscore

pub const Home: Key

Home

pub const Left: Key

Left

pub const Up: Key

Up

pub const Right: Key

Right

pub const Down: Key

Down

pub const PageUp: Key

PageUp

pub const PageDown: Key

PageDown

pub const End: Key

End

pub const Print: Key

Print

pub const Insert: Key

Insert

pub const Menu: Key

Menu

pub const Help: Key

Help

pub const NumLock: Key

NumLock

pub const KP: Key

Keypad

pub const KPEnter: Key

Keypad Enter

pub const KPLast: Key

Keypad Last

pub const FLast: Key

FLast

pub const ShiftL: Key

Shift Left

pub const ShiftR: Key

Shift Right

pub const ControlL: Key

Control Left

pub const ControlR: Key

Control Right

pub const CapsLock: Key

Caps Lock

pub const MetaL: Key

Meta Left

pub const MetaR: Key

Meta Right

pub const AltL: Key

Alt Left

pub const AltR: Key

Alt Right

pub const Delete: Key

Delete

pub const fn empty() -> Key

Returns an empty set of flags

pub const fn all() -> Key

Returns the set containing all flags.

pub const fn bits(&self) -> i32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: i32) -> Option<Key>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: i32) -> Key

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: i32) -> Key

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Key) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Key) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Key)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Key)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Key)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Key, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl Key

pub fn from_i32(val: i32) -> Key

Gets a Key from an i32

pub fn from_char(val: char) -> Key

Gets a Key from a char

Trait Implementations

impl Binary for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<Key> for Key

type Output = Key

The resulting type after applying the & operator.

fn bitand(self, other: Key) -> Key

Returns the intersection between the two sets of flags.

impl BitAndAssign<Key> for Key

fn bitand_assign(&mut self, other: Key)

Disables all flags disabled in the set.

impl BitOr<Key> for Key

type Output = Key

The resulting type after applying the | operator.

fn bitor(self, other: Key) -> Key

Returns the union of the two sets of flags.

impl BitOr<Key> for Shortcut

type Output = Shortcut

The resulting type after applying the | operator.

fn bitor(self, other: Key) -> Self::Output

Performs the | operation.

impl BitOrAssign<Key> for Key

fn bitor_assign(&mut self, other: Key)

Adds the set of flags.

impl BitXor<Key> for Key

type Output = Key

The resulting type after applying the ^ operator.

fn bitxor(self, other: Key) -> Key

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Key> for Key

fn bitxor_assign(&mut self, other: Key)

Toggles the set of flags.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Key

impl Extend<Key> for Key

fn extend<T: IntoIterator<Item = Key>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Key> for Key

fn from_iter<T: IntoIterator<Item = Key>>(iterator: T) -> Key

Creates a value from an iterator.

impl Hash for Key

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for Key

type Output = Key

The resulting type after applying the ! operator.

fn not(self) -> Key

Returns the complement of this set of flags.

impl Octal for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Key> for Key

fn eq(&self, other: &Key) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Key) -> bool

This method tests for !=.

impl PartialOrd<Key> for Key

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Key

impl StructuralPartialEq for Key

impl Sub<Key> for Key

type Output = Key

The resulting type after applying the - operator.

fn sub(self, other: Key) -> Key

Returns the set difference of the two sets of flags.

impl SubAssign<Key> for Key

fn sub_assign(&mut self, other: Key)

Disables all flags enabled in the set.

impl UpperHex for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.