Set wxKeyEvent::m_rawFlags to hardware key code in wxGTK.

The raw flags were previously unused in wxGTK but hardware key code is an
important information which may be useful to the application, so pass it in
the flags (this is rather symmetric with passing lParam in it under MSW as
lParam contains the scan code, among other things).

Also document the meaning of raw key code and flags in all the major ports.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65893 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 47b779a3eeb9bf34d80f1d0cd900473af8d632f9..64adc9862eca62b906902daa27378cf7f66098ec 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -1386,8 +1386,19 @@ public:
     //@}
 
     /**
     //@}
 
     /**

-        Returns the raw key code for this event. This is a platform-dependent scan code
-        which should only be used in advanced applications.
+        Returns the raw key code for this event.
+
+        The flags are platform-dependent and should only be used if the
+        functionality provided by other wxKeyEvent methods is insufficient.
+
+        Under MSW, the raw key code is the value of @c wParam parameter of the
+        corresponding message.
+
+        Under GTK, the raw key code is the @c keyval field of the corresponding
+        GDK event.
+
+        Under OS X, the raw key code is the @c keyCode field of the
+        corresponding NSEvent.

 
         @note Currently the raw key codes are not supported by all ports, use
               @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
 
         @note Currently the raw key codes are not supported by all ports, use
               @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.


@@ -1395,8 +1406,18 @@ public:
     wxUint32 GetRawKeyCode() const;
 
     /**
     wxUint32 GetRawKeyCode() const;
 
     /**

-        Returns the low level key flags for this event. The flags are
-        platform-dependent and should only be used in advanced applications.
+        Returns the low level key flags for this event.
+
+        The flags are platform-dependent and should only be used if the
+        functionality provided by other wxKeyEvent methods is insufficient.
+
+        Under MSW, the raw flags are just the value of @c lParam parameter of
+        the corresponding message.
+
+        Under GTK, the raw flags contain the @c hardware_keycode field of the
+        corresponding GDK event.
+
+        Under OS X, the raw flags contain the modifiers state.

 
         @note Currently the raw key flags are not supported by all ports, use
               @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
 
         @note Currently the raw key flags are not supported by all ports, use
               @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.

diff --git a/src/gtk/window.cpp b/src/gtk/window.cpp
index fa02dbc397e8e835b669d1dfc837f3e07b910289..1e4523f340272f80d631e5f32598ee704218a08b 100644 (file)
--- a/src/gtk/window.cpp
+++ b/src/gtk/window.cpp
@@ -729,7 +729,7 @@ static void wxFillOtherKeyEventFields(wxKeyEvent& event,
     }
 
     event.m_rawCode = (wxUint32) gdk_event->keyval;
     }
 
     event.m_rawCode = (wxUint32) gdk_event->keyval;

-    event.m_rawFlags = 0;
+    event.m_rawFlags = gdk_event->hardware_keycode;

 
     wxGetMousePosition( &x, &y );
     win->ScreenToClient( &x, &y );
 
     wxGetMousePosition( &x, &y );
     win->ScreenToClient( &x, &y );