.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::Gdk::Keymap 3pm"
.TH Gtk2::Gdk::Keymap 3pm "2019-09-16" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Gtk2::Gdk::Keymap \- wrapper for GdkKeymap
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Object
\&  +\-\-\-\-Gtk2::Gdk::Keymap
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "modifiertype = $keymap\->\fBadd_virtual_modifiers\fP ($state)"
.el .SS "modifiertype = \f(CW$keymap\fP\->\fBadd_virtual_modifiers\fP ($state)"
.IX Subsection "modifiertype = $keymap->add_virtual_modifiers ($state)"
.IP "\(bu" 4
\&\f(CW$state\fR (Gtk2::Gdk::ModifierType)
.PP
Since: gtk+ 2.20
.ie n .SS "boolean = $keymap\->\fBget_caps_lock_state\fP"
.el .SS "boolean = \f(CW$keymap\fP\->\fBget_caps_lock_state\fP"
.IX Subsection "boolean = $keymap->get_caps_lock_state"
Since: gtk+ 2.16
.SS "keymap = Gtk2::Gdk::Keymap\->\fBget_default\fP"
.IX Subsection "keymap = Gtk2::Gdk::Keymap->get_default"
.ie n .SS "direction = $keymap\->\fBget_direction\fP"
.el .SS "direction = \f(CW$keymap\fP\->\fBget_direction\fP"
.IX Subsection "direction = $keymap->get_direction"
.ie n .SS "({ key1, keyval1 }, { ... }) = $keymap\->\fBget_entries_for_keycode\fP (hardware_keycode)"
.el .SS "({ key1, keyval1 }, { ... }) = \f(CW$keymap\fP\->\fBget_entries_for_keycode\fP (hardware_keycode)"
.IX Subsection "({ key1, keyval1 }, { ... }) = $keymap->get_entries_for_keycode (hardware_keycode)"
.IP "\(bu" 4
\&\f(CW$hardware_keycode\fR (integer)
.PP
Returns a list of hash references, each with two keys: \*(L"key\*(R" pointing to a
\&\fIGdkKeymapKey\fR and \*(L"keyval\*(R" pointing to the corresponding key value.
.ie n .SS "keys = $keymap\->\fBget_entries_for_keyval\fP (keyval)"
.el .SS "keys = \f(CW$keymap\fP\->\fBget_entries_for_keyval\fP (keyval)"
.IX Subsection "keys = $keymap->get_entries_for_keyval (keyval)"
.IP "\(bu" 4
\&\f(CW$keyval\fR (integer)
.PP
Returns a list of \fIGdkKeymapKey\fRs.
.PP
Obtains a list of keycode/group/level combinations that will generate
\&\fI\f(CI$keyval\fI\fR.  Groups and levels are two kinds of keyboard mode; in general, the
level determines whether the top or bottom symbol on a key is used, and the
group determines whether the left or right symbol is used.  On \s-1US\s0 keyboards,
the shift key changes the keyboard level, and there are no groups.  A group
switch key might convert a keyboard between Hebrew to English modes, for
example.  Gtk2::Gdk::Event::Key contains a group field that indicates
the active keyboard group.  The level is computed from the modifier
mask.
.SS "keymap = Gtk2::Gdk::Keymap\->\fBget_for_display\fP ($display)"
.IX Subsection "keymap = Gtk2::Gdk::Keymap->get_for_display ($display)"
.IP "\(bu" 4
\&\f(CW$display\fR (Gtk2::Gdk::Display)
.PP
Since: gtk+ 2.2
.ie n .SS "boolean = $keymap\->\fBhave_bidi_layouts\fP"
.el .SS "boolean = \f(CW$keymap\fP\->\fBhave_bidi_layouts\fP"
.IX Subsection "boolean = $keymap->have_bidi_layouts"
Since: gtk+ 2.12
.ie n .SS "integer = $keymap\->\fBlookup_key\fP ($key)"
.el .SS "integer = \f(CW$keymap\fP\->\fBlookup_key\fP ($key)"
.IX Subsection "integer = $keymap->lookup_key ($key)"
.IP "\(bu" 4
\&\f(CW$key\fR (scalar)
.ie n .SS "(bool, new_state) = $keymap\->\fBmap_virtual_modifiers\fP (keymap, state)"
.el .SS "(bool, new_state) = \f(CW$keymap\fP\->\fBmap_virtual_modifiers\fP (keymap, state)"
.IX Subsection "(bool, new_state) = $keymap->map_virtual_modifiers (keymap, state)"
.IP "\(bu" 4
\&\f(CW$state\fR (Gtk2::Gdk::ModifierType)
.PP
Since: gtk+ 2.20
.ie n .SS "(keyval, effective_group, level, consumed_modifiers) = $keymap\->\fBtranslate_keyboard_state\fP (hardware_keycode, state, group)"
.el .SS "(keyval, effective_group, level, consumed_modifiers) = \f(CW$keymap\fP\->\fBtranslate_keyboard_state\fP (hardware_keycode, state, group)"
.IX Subsection "(keyval, effective_group, level, consumed_modifiers) = $keymap->translate_keyboard_state (hardware_keycode, state, group)"
.IP "\(bu" 4
\&\f(CW$hardware_keycode\fR (integer)
.IP "\(bu" 4
\&\f(CW$state\fR (Gtk2::Gdk::ModifierType)
.IP "\(bu" 4
\&\f(CW$group\fR (integer)
.SH "SIGNALS"
.IX Header "SIGNALS"
.IP "\fBdirection-changed\fR (Gtk2::Gdk::Keymap)" 4
.IX Item "direction-changed (Gtk2::Gdk::Keymap)"
.PD 0
.IP "\fBkeys-changed\fR (Gtk2::Gdk::Keymap)" 4
.IX Item "keys-changed (Gtk2::Gdk::Keymap)"
.IP "\fBstate-changed\fR (Gtk2::Gdk::Keymap)" 4
.IX Item "state-changed (Gtk2::Gdk::Keymap)"
.PD
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "flags Gtk2::Gdk::ModifierType"
.IX Subsection "flags Gtk2::Gdk::ModifierType"
.IP "\(bu" 4
\&'shift\-mask' / '\s-1GDK_SHIFT_MASK\s0'
.IP "\(bu" 4
\&'lock\-mask' / '\s-1GDK_LOCK_MASK\s0'
.IP "\(bu" 4
\&'control\-mask' / '\s-1GDK_CONTROL_MASK\s0'
.IP "\(bu" 4
\&'mod1\-mask' / '\s-1GDK_MOD1_MASK\s0'
.IP "\(bu" 4
\&'mod2\-mask' / '\s-1GDK_MOD2_MASK\s0'
.IP "\(bu" 4
\&'mod3\-mask' / '\s-1GDK_MOD3_MASK\s0'
.IP "\(bu" 4
\&'mod4\-mask' / '\s-1GDK_MOD4_MASK\s0'
.IP "\(bu" 4
\&'mod5\-mask' / '\s-1GDK_MOD5_MASK\s0'
.IP "\(bu" 4
\&'button1\-mask' / '\s-1GDK_BUTTON1_MASK\s0'
.IP "\(bu" 4
\&'button2\-mask' / '\s-1GDK_BUTTON2_MASK\s0'
.IP "\(bu" 4
\&'button3\-mask' / '\s-1GDK_BUTTON3_MASK\s0'
.IP "\(bu" 4
\&'button4\-mask' / '\s-1GDK_BUTTON4_MASK\s0'
.IP "\(bu" 4
\&'button5\-mask' / '\s-1GDK_BUTTON5_MASK\s0'
.IP "\(bu" 4
\&'super\-mask' / '\s-1GDK_SUPER_MASK\s0'
.IP "\(bu" 4
\&'hyper\-mask' / '\s-1GDK_HYPER_MASK\s0'
.IP "\(bu" 4
\&'meta\-mask' / '\s-1GDK_META_MASK\s0'
.IP "\(bu" 4
\&'release\-mask' / '\s-1GDK_RELEASE_MASK\s0'
.IP "\(bu" 4
\&'modifier\-mask' / '\s-1GDK_MODIFIER_MASK\s0'
.SS "enum Pango::Direction"
.IX Subsection "enum Pango::Direction"
.IP "\(bu" 4
\&'ltr' / '\s-1PANGO_DIRECTION_LTR\s0'
.IP "\(bu" 4
\&'rtl' / '\s-1PANGO_DIRECTION_RTL\s0'
.IP "\(bu" 4
\&'ttb\-ltr' / '\s-1PANGO_DIRECTION_TTB_LTR\s0'
.IP "\(bu" 4
\&'ttb\-rtl' / '\s-1PANGO_DIRECTION_TTB_RTL\s0'
.IP "\(bu" 4
\&'weak\-ltr' / '\s-1PANGO_DIRECTION_WEAK_LTR\s0'
.IP "\(bu" 4
\&'weak\-rtl' / '\s-1PANGO_DIRECTION_WEAK_RTL\s0'
.IP "\(bu" 4
\&'neutral' / '\s-1PANGO_DIRECTION_NEUTRAL\s0'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL.\s0  See Gtk2 for a full notice.