Gdk::KeymapKey Class Reference

Describes a hardware key that can be mapped to a key value. More...

#include <gdkmm/keymapkey.h>

Public Member Functions
	KeymapKey ()
	KeymapKey (guint keycode, int group, int level)
	KeymapKey (const GdkKeymapKey * keymap_key)
guint	get_keycode () const
	The hardware keycode.
void	set_keycode (const guint & value)
int	get_group () const
	Indicates movement in a horizontal direction.
void	set_group (const int & value)
int	get_level () const
	Indicates which symbol on the key will be used, in a vertical direction.
void	set_level (const int & value)
GdkKeymapKey *	gobj ()
	Provides access to the underlying C object.
const GdkKeymapKey *	gobj () const
	Provides access to the underlying C object.

Protected Attributes
GdkKeymapKey	gobject_

Detailed Description

Describes a hardware key that can be mapped to a key value.

Since gtkmm 4.24

Constructor & Destructor Documentation

KeymapKey() [1/3]

Gdk::KeymapKey::KeymapKey

(

)

KeymapKey() [2/3]

Gdk::KeymapKey::KeymapKey	(	guint	keycode,
		int	group,
		int	level )

KeymapKey() [3/3]

Gdk::KeymapKey::KeymapKey ( const GdkKeymapKey * keymap_key )

explicit

Member Function Documentation

get_group()

int Gdk::KeymapKey::get_group

(

)

const

Indicates movement in a horizontal direction.

Usually groups are used for two different languages. In group 0, a key might have two English characters, and in group 1 it might have two Hebrew characters. The Hebrew characters will be printed on the key next to the English characters.

get_keycode()

guint Gdk::KeymapKey::get_keycode

(

)

const

The hardware keycode.

This is an identifying number for a physical key.

get_level()

int Gdk::KeymapKey::get_level

(

)

const

Indicates which symbol on the key will be used, in a vertical direction.

So on a standard US keyboard, the key with the number “1” on it also has the exclamation point ("!") character on it. The level indicates whether to use the “1” or the “!” symbol. The letter keys are considered to have a lowercase letter at level 0, and an uppercase letter at level 1, though only the uppercase letter is printed.

gobj() [1/2]

GdkKeymapKey * Gdk::KeymapKey::gobj ( )

inline

Provides access to the underlying C object.

gobj() [2/2]

const GdkKeymapKey * Gdk::KeymapKey::gobj ( ) const

inline

Provides access to the underlying C object.

set_group()

void Gdk::KeymapKey::set_group

(

const int &

value

)

set_keycode()

void Gdk::KeymapKey::set_keycode

(

const guint &

value

)

set_level()

void Gdk::KeymapKey::set_level

(

const int &

value

)

Member Data Documentation

gobject_

GdkKeymapKey Gdk::KeymapKey::gobject_

protected