NAME¶
Gtk2::Gdk::Keysyms - key codes for Gtk2 programs
SYNOPSIS¶
use Gtk2;
use Gtk2::Gdk::Keysyms;
#
# the most common use is for deciphering keycodes in key events,
# like this:
#
sub key_press_handler {
my ($widget, $event) = @_;
if ($event->keyval == $Gtk2::Gdk::Keysyms{Escape}) {
abort_whatever ();
return 1;
}
elsif ($event->keyval == $Gtk2::Gdk::Keysyms{F1}) {
do_help_thing ();
return 1;
}
elsif ($event->keyval == $Gtk2::Gdk::Keysyms{KP_Enter}) {
execute_selected_text_as_command ();
return 1;
}
# we didn't handle it, pass it on...
return 0;
}
DESCRIPTION¶
Gdk defines symbolic names for the codes associated with each key on a keyboard,
so that you don't go nuts with numeric values in your programs. The hash
%Gtk2::Gdk::Keysyms holds all those keycodes, indexed by the name, for use in
your perl programs when you need to do custom key handling. This commonly
occurs when you want to bind an action to a key that isn't usable as an
accelerator, or when you don't have accelerators, or if you're trying to write
an easter egg, or whatever.
As the list of keycodes is quite large and rather rarely used in application
code, we've put it in a separately-loaded module to save space. As an
alternative, you might want to investigate
"Gtk2::Gdk->keyval_from_name" which offers basically the same
functionality as the hash.
To get a list of all available keys, either dump %Gtk2::Gdk::Keysyms, or look at
the source of this module with "perldoc -m Gtk2::Gdk::Keysyms".
AUTHOR¶
This module was automatically generated by a very simple perl script from
gdk/gdkkeysyms.h. Programs that write programs are the happiest programs of
all.
COPYRIGHT¶
Copyright (C) 2003, 2009 by the gtk2-perl team (see the file AUTHORS for the
full list)
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Library General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option)
any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU Library General Public License for more
details.
You should have received a copy of the GNU Library General Public License along
with this library; if not, write to the Free Software Foundation, Inc., 59
Temple Place - Suite 330, Boston, MA 02111-1307 USA.
SEE ALSO¶
perl, Gtk2, Gtk2::Gdk