Struct gdk4::Key

source ·
pub struct Key(_);
Expand description

A wrapper around GDK_KEY_ constants and keyval methods.

Implementations§

Converts a key name to a key value.

The names are the same as those in the gdk/gdkkeysyms.h header file but without the leading “GDK_KEY_”.

keyval_name

a key name

Returns

the corresponding key value, or GDK_KEY_VoidSymbol if the key name is not a valid key

Obtains the upper- and lower-case versions of the keyval @symbol.

Examples of keyvals are GDK_KEY_a, GDK_KEY_Enter, GDK_KEY_F1, etc.

symbol

a keyval

Returns
lower

return location for lowercase version of @symbol

upper

return location for uppercase version of @symbol

Convert from a GDK key symbol to the corresponding Unicode character.

Note that the conversion does not take the current locale into consideration, which might be expected for particular keyvals, such as GDK_KEY_KP_Decimal.

keyval

a GDK key symbol

Returns

the corresponding unicode character, or 0 if there is no corresponding character.

Converts a key value into a symbolic name.

The names are the same as those in the gdk/gdkkeysyms.h header file but without the leading “GDK_KEY_”.

keyval

a key value

Returns

a string containing the name of the key

Returns true if the given key value is in upper case.

keyval

a key value.

Returns

true if @keyval is in upper case, or if @keyval is not subject to case conversion.

Returns true if the given key value is in lower case.

keyval

a key value.

Returns

true if @keyval is in lower case, or if @keyval is not subject to case conversion.

Converts a key value to upper case, if applicable.

keyval

a key value.

Returns

the upper case form of @keyval, or @keyval itself if it is already in upper case or it is not subject to case conversion.

Converts a key value to lower case, if applicable.

keyval

a key value.

Returns

the lower case form of @keyval, or @keyval itself if it is already in lower case or it is not subject to case conversion.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more
Value type checker.
Get the contained value from a Value. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==.
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Returns the type identifier of Self.
Convert a value to a Value.
Returns the type identifer of self. Read more
Type to get the Type from. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Ensures that the type has been registered with the type system.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Returns a SendValue clone of self.
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.