Struct fltk::enums::Key

pub struct Key(_);

Defines the inputted virtual keycode

Implementations

impl Key

pub const None: Self = _

None

pub const Button: Self = _

Button

pub const BackSpace: Self = _

BackSpace

pub const Tab: Self = _

Tab

pub const IsoKey: Self = _

IsoKey

pub const Enter: Self = _

Enter

pub const Pause: Self = _

Pause

pub const ScrollLock: Self = _

ScrollLock

pub const Escape: Self = _

Escape

pub const Kana: Self = _

Kana

pub const Eisu: Self = _

Eisu

pub const Yen: Self = _

Yen

pub const JISUnderscore: Self = _

JISUnderscore

pub const Home: Self = _

Home

pub const Left: Self = _

Left

pub const Up: Self = _

Up

pub const Right: Self = _

Right

pub const Down: Self = _

Down

pub const PageUp: Self = _

PageUp

pub const PageDown: Self = _

PageDown

pub const End: Self = _

End

pub const Print: Self = _

Print

pub const Insert: Self = _

Insert

pub const Menu: Self = _

Menu

pub const Help: Self = _

Help

pub const NumLock: Self = _

NumLock

pub const KP: Self = _

Keypad

pub const KPEnter: Self = _

Keypad Enter

pub const KPLast: Self = _

Keypad Last

pub const F1: Self = _

F1

pub const F2: Self = _

F2

pub const F3: Self = _

F3

pub const F4: Self = _

F4

pub const F5: Self = _

F5

pub const F6: Self = _

F6

pub const F7: Self = _

F7

pub const F8: Self = _

F8

pub const F9: Self = _

F9

pub const F10: Self = _

F10

pub const F11: Self = _

F11

pub const F12: Self = _

F12

pub const FLast: Self = _

Function key last

pub const ShiftL: Self = _

Shift Left

pub const ShiftR: Self = _

Shift Right

pub const ControlL: Self = _

Control Left

pub const ControlR: Self = _

Control Right

pub const CapsLock: Self = _

Caps Lock

pub const MetaL: Self = _

Meta Left

pub const MetaR: Self = _

Meta Right

pub const AltL: Self = _

Alt Left

pub const AltR: Self = _

Alt Right

pub const Delete: Self = _

Delete

impl Key

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> i32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: i32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Key

pub const fn iter(&self) -> Iter<Key>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Key>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl Key

pub const fn from_i32(val: i32) -> Key

Gets a Key from an i32

pub const fn from_char(val: char) -> Key

Gets a Key from a char

pub const fn to_char(&self) -> Option<char>

Get the char representation of a Key.

pub const fn is_fn_key(key: Key) -> bool

Returns whether a key is a function key

pub const fn fn_key(val: i32) -> Key

Return the corresponding function key

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

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

The bitwise and (&) of the bits in two flags values.

type Output = Key

The resulting type after applying the & operator.

impl BitAndAssign<Key> for Key

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr<Key> for Key

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

The bitwise or (|) of the bits in two flags values.

type Output = Key

The resulting type after applying the | operator.

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: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor<Key> for Key

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Key

The resulting type after applying the ^ operator.

impl BitXorAssign<Key> for Key

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Extend<Key> for Key

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

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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 Flags for Key

const FLAGS: &'static [Flag<Key>] = _

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> i32

Get the underlying bits value.

fn from_bits_retain(bits: i32) -> Key

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> boolwhere Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Key> for Key

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

The bitwise or (|) of the bits in each flags value.

impl Hash for Key

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Key

type Item = Key

The type of the elements being iterated over.

type IntoIter = Iter<Key>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Key

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

Formats the value using the given formatter.

impl Not for Key

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Key

The resulting type after applying the ! operator.

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.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 PublicFlags for Key

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub<Key> for Key

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Key

The resulting type after applying the - operator.

impl SubAssign<Key> for Key

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Key

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

Formats the value using the given formatter.

impl Copy for Key

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key