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.