[gtkmm/gtkmm-3-24] Documentation: Explain key values

[Kjell Ahlstedt <kjellahl src gnome org>]

commit 61cd6e68f763adbdce5a2fcf3123cdaad99ad998
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Tue Oct 6 13:00:01 2020 +0200

    Documentation: Explain key values
    
    and add links to gdk/gdkkeysyms.h. Fixes #6

 gdk/src/device.hg            | 5 +++++
 gtk/gtkmm/accelkey.h         | 9 +++++++--
 gtk/src/accelgroup.hg        | 5 +++++
 gtk/src/accellabel.hg        | 5 +++++
 gtk/src/cellrendereraccel.hg | 5 +++++
 gtk/src/label.hg             | 5 +++++
 gtk/src/stockitem.hg         | 5 +++++
 gtk/src/widget.hg            | 5 +++++
 gtk/src/window.hg            | 6 ++++++
 9 files changed, 48 insertions(+), 2 deletions(-)
---
diff --git a/gdk/src/device.hg b/gdk/src/device.hg
index 64f67338..9091c664 100644
--- a/gdk/src/device.hg
+++ b/gdk/src/device.hg
@@ -43,6 +43,11 @@ class GDKMM_API Seat;
 class GDKMM_API Window;
 
 /** A Gdk::Device instance contains a detailed description of an extended input device.
+ *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
  */
 class GDKMM_API Device : public Glib::Object
 {
diff --git a/gtk/gtkmm/accelkey.h b/gtk/gtkmm/accelkey.h
index 54ff69ca..9948078b 100644
--- a/gtk/gtkmm/accelkey.h
+++ b/gtk/gtkmm/accelkey.h
@@ -32,11 +32,16 @@ namespace Gtk
 
 /** Defines accelerator key combinations.
  * For instance, pressing Control-Q to activate the File|Quit menu item.
- * Typedefed as Gtk::Menu::AccelKey
  *
  * By defining accelerator paths you can allow the user of your application
  * to change accelerators himself. An example of an accelerator might be
- * "<MainWindow>/File/Open". Modified accelerators may be saved
+ * "<MainWindow>/File/Open". Modified accelerators may be saved.
+ *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
+ *
  * @see Gtk::AccelMap
  * @ingroup Menus
  */
diff --git a/gtk/src/accelgroup.hg b/gtk/src/accelgroup.hg
index 12b5bb72..aafd8ee1 100644
--- a/gtk/src/accelgroup.hg
+++ b/gtk/src/accelgroup.hg
@@ -38,6 +38,11 @@ namespace Gtk
  * menu item.  Mnemonics are shortcuts for GUI elements such as text entries or
  * buttons; they appear as underlined characters. See the Gtk::Label
  * constructor. Menu items can have both accelerators and mnemonics, of course.
+ *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
  */
 class GTKMM_API AccelGroup : public Glib::Object
 {
diff --git a/gtk/src/accellabel.hg b/gtk/src/accellabel.hg
index ca1c16e9..d0ffaa23 100644
--- a/gtk/src/accellabel.hg
+++ b/gtk/src/accellabel.hg
@@ -28,6 +28,11 @@ namespace Gtk
 /** A label which displays an accelerator key on the right of the text.
  * Used for menu item labels, for instance.
  *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
+ *
  * @ingroup Widgets
  */
 class GTKMM_API AccelLabel : public Label
diff --git a/gtk/src/cellrendereraccel.hg b/gtk/src/cellrendereraccel.hg
index 5a7db038..6a0e6764 100644
--- a/gtk/src/cellrendereraccel.hg
+++ b/gtk/src/cellrendereraccel.hg
@@ -36,6 +36,11 @@ _WRAP_ENUM(CellRendererAccelMode, GtkCellRendererAccelMode, decl_prefix GTKMM_AP
  * If the cell renderer is editable, the accelerator can be changed by
  * simply typing the new combination.
  *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
+ *
  * @ingroup TreeView
  * @newin{2,10}
  */
diff --git a/gtk/src/label.hg b/gtk/src/label.hg
index bb8cf9e0..f3d36417 100644
--- a/gtk/src/label.hg
+++ b/gtk/src/label.hg
@@ -32,6 +32,11 @@ class GTKMM_API Menu;
  *
  * A simple setable widget for holding a Glib::ustring.
  *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
+ *
  * The Label widget looks like this:
  * @image html label1.png
  *
diff --git a/gtk/src/stockitem.hg b/gtk/src/stockitem.hg
index f2d20598..df591665 100644
--- a/gtk/src/stockitem.hg
+++ b/gtk/src/stockitem.hg
@@ -38,6 +38,11 @@ namespace Gtk
 {
 
 /** @deprecated Use icon names instead of StockItem, StockID and BuiltinStockID.
+ *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
  */
 class GTKMM_API StockItem
 {
diff --git a/gtk/src/widget.hg b/gtk/src/widget.hg
index 424c849e..4c7b2689 100644
--- a/gtk/src/widget.hg
+++ b/gtk/src/widget.hg
@@ -102,6 +102,11 @@ typedef Gdk::Rectangle Allocation;
  * Only widgets with a Gdk::Window on the server side are allowed to
  * capture events.  Widgets in the Gtk::Misc group for example lack
  * a Gdk::Window.
+ *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
  */
 class GTKMM_API Widget
 : public Object,
diff --git a/gtk/src/window.hg b/gtk/src/window.hg
index 5d4e1f03..3a977515 100644
--- a/gtk/src/window.hg
+++ b/gtk/src/window.hg
@@ -39,6 +39,12 @@ class GTKMM_API WindowGroup;
  * The window will be hidden when the window manager's close button is clicked. Override on_delete_event() 
to stop this.
  *
  * Gtk::manage() has no effect on Windows because they have no parent Containers.
+ *
+ * Key values are the codes which are sent whenever a key is pressed or released.
+ * The complete list of key values can be found in the
+ * <a href="https://gitlab.gnome.org/GNOME/gtk/tree/gtk-3-24/gdk/gdkkeysyms.h";>gdk/gdkkeysyms.h</a>
+ * header file. They are prefixed with <tt>GDK_KEY_</tt>.
+ *
  * @ingroup Widgets
  */
 class GTKMM_API Window : public Bin