Changeset 59359 in vbox for trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIKeyboardHandler.cpp

Timestamp:

Jan 15, 2016 11:39:44 AM (9 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

105047

Message:

FE/Qt: Qt5 migration (part 56): Reworking keyboard-handler: Some cleanup for Mac OS X.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIKeyboardHandler.cpp (modified) (12 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIKeyboardHandler.cpp

@@ -240 +240 @@
 #if defined(Q_WS_MAC)
 
-        /* On Mac, we use the Qt methods + disabling global hot keys + watching modifiers (for right/left separation). */
+        /* On Mac, keyboard grabbing is ineffective,
+         * a low-level keyboard-hook is used instead.
+         * It is being installed on focus-in event and uninstalled on focus-out.
+         * S.a. UIKeyboardHandler::eventFilter for more information. */
+
+        /* On Mac, we also
+         * use the Qt method to grab the keyboard,
+         * disable global hot keys and
+         * enable watching modifiers (for right/left separation). */
+        // TODO: Is that really needed?
         ::DarwinDisableGlobalHotKeys(true);
         m_views[m_iKeyboardCaptureViewIndex]->grabKeyboard();
@@ -246 +255 @@
 #elif defined(Q_WS_WIN)
 
-        /* On Win, keyboard grabbing is ineffective, a low-level keyboard hook is used instead. */
+        /* On Win, keyboard grabbing is ineffective,
+         * a low-level keyboard-hook is used instead.
+         * It is being installed on window-activate event and uninstalled on window-deactivate.
+         * S.a. UIKeyboardHandler::eventFilter for more information. */
 
 #elif defined(Q_WS_X11)
@@ -300 +312 @@
 #else
 
-        /* On other platforms we are just praying Qt method will work. */
+        /* On other platforms we are just praying Qt method to work: */
         m_views[m_iKeyboardCaptureViewIndex]->grabKeyboard();
 
@@ -324 +336 @@
 #if defined(Q_WS_MAC)
 
+        /* On Mac, keyboard grabbing is ineffective,
+         * a low-level keyboard-hook is used instead.
+         * It is being installed on focus-in event and uninstalled on focus-out.
+         * S.a. UIKeyboardHandler::eventFilter for more information. */
+
+        /* On Mac, we also
+         * use the Qt method to release the keyboard,
+         * enable global hot keys and
+         * disable watching modifiers (for right/left separation). */
+        // TODO: Is that really needed?
         ::DarwinDisableGlobalHotKeys(false);
         m_views[m_iKeyboardCaptureViewIndex]->releaseKeyboard();
@@ -329 +351 @@
 #elif defined(Q_WS_WIN)
 
-        /* On Win, keyboard grabbing is ineffective, a low-level keyboard hook is used instead. */
+        /* On Win, keyboard grabbing is ineffective,
+         * a low-level keyboard-hook is used instead.
+         * It is being installed on window-activate event and uninstalled on window-deactivate.
+         * S.a. UIKeyboardHandler::eventFilter for more information. */
 
 #elif defined(Q_WS_X11)
@@ -369 +394 @@
 #else
 
+        /* On other platforms we are just praying Qt method to work: */
         m_views[m_iKeyboardCaptureViewIndex]->releaseKeyboard();
 
 #endif
 
-        /* Reset keyboard-capture index: */
+        /* Forget which screen had captured keyboard: */
         m_iKeyboardCaptureViewIndex = -1;
 
@@ -459 +485 @@
 
 #ifdef Q_WS_WIN
-/** Tell keyboard event handler to skip host keyboard events. Used for HID LEDs sync
- * when on Windows host a keyboard event is generated in order to change corresponding LED. */
 void UIKeyboardHandler::winSkipKeyboardEvents(bool fSkip)
 {
@@ -974 +998 @@
 #if defined(Q_WS_MAC)
 
-    /* We have to make sure the callback for the keyboard events
-     * is released when closing this view. */
+    /* Cleanup keyboard-hook: */
     if (m_iKeyboardHookViewIndex != -1)
-        darwinGrabKeyboardEvents(false);
+    {
+        /* Ungrab the keyboard and unregister the event callback/hook: */
+        ::DarwinReleaseKeyboard();
+        UICocoaApplication::instance()->unregisterForNativeEvents(RT_BIT_32(10) | RT_BIT_32(11) | RT_BIT_32(12) /* NSKeyDown  | NSKeyUp | | NSFlagsChanged */,
+                                                                  UIKeyboardHandler::macKeyboardProc, this);
+        /* Update the id: */
+        m_iKeyboardHookViewIndex = -1;
+    }
 
 #elif defined(Q_WS_WIN)
@@ -985 +1015 @@
     m_pAltGrMonitor = 0;
 
-    /* Cleaning keyboard-hook: */
+    /* Cleanup keyboard-hook: */
     if (m_keyboardHook)
     {
-        UnhookWindowsHookEx(m_keyboardHook);
+        /* Uninstall existing keyboard-hook: */
+        ::UnhookWindowsHookEx(m_keyboardHook);
         m_keyboardHook = NULL;
+        /* Update the id: */
+        m_iKeyboardHookViewIndex = -1;
     }
 
@@ -1088 +1121 @@
             {
 #ifdef Q_WS_MAC
-                /* If keyboard-event handler is NOT currently installed;
+                /* If keyboard-hook is NOT installed;
                  * Or installed but NOT for that view: */
-                if (m_iKeyboardHookViewIndex != (int)uScreenId)
+                if ((int)uScreenId != m_iKeyboardHookViewIndex)
                 {
-                    /* If keyboard-event handler is NOT currently installed: */
+                    /* If keyboard-hook is NOT currently installed: */
                     if (m_iKeyboardHookViewIndex == -1)
                     {
-                        /* Install the keyboard-event handler: */
-                        darwinGrabKeyboardEvents(true);
+                        /* Disable mouse and keyboard event compression/delaying
+                         * to make sure we *really* get all of the events: */
+                        ::CGSetLocalEventsSuppressionInterval(0.0);
+                        ::darwinSetMouseCoalescingEnabled(false);
+
+                        /* Bring the caps lock state up to date,
+                         * otherwise e.g. a later Shift key press will accidentally inject a CapsLock key press and release,
+                         * see UIKeyboardHandler::macKeyboardEvent for the code handling modifier key state changes. */
+                        m_uDarwinKeyModifiers ^= (m_uDarwinKeyModifiers ^ ::GetCurrentEventKeyModifiers()) & alphaLock;
+
+                        /* Register the event callback/hook and grab the keyboard: */
+                        UICocoaApplication::instance()->registerForNativeEvents(RT_BIT_32(10) | RT_BIT_32(11) | RT_BIT_32(12) /* NSKeyDown  | NSKeyUp | | NSFlagsChanged */,
+                                                                                UIKeyboardHandler::macKeyboardProc, this);
+                        ::DarwinGrabKeyboard(false);
                     }
                     /* Update the id: */
@@ -1122 +1167 @@
             {
 #ifdef Q_WS_MAC
-                /* If keyboard-event handler is installed for that view: */
-                if (m_iKeyboardHookViewIndex == (int)uScreenId)
+                /* If keyboard-hook is installed: */
+                if ((int)uScreenId == m_iKeyboardHookViewIndex)
                 {
-                    /* Remove the keyboard-event handler: */
-                    darwinGrabKeyboardEvents(false);
+                    /* Ungrab the keyboard and unregister the event callback/hook: */
+                    ::DarwinReleaseKeyboard();
+                    UICocoaApplication::instance()->unregisterForNativeEvents(RT_BIT_32(10) | RT_BIT_32(11) | RT_BIT_32(12) /* NSKeyDown  | NSKeyUp | | NSFlagsChanged */,
+                                                                              UIKeyboardHandler::macKeyboardProc, this);
                     /* Update the id: */
                     m_iKeyboardHookViewIndex = -1;
@@ -1188 +1235 @@
 
 #if defined(Q_WS_MAC)
-
-void UIKeyboardHandler::darwinGrabKeyboardEvents(bool fGrab)
-{
-    if (fGrab)
-    {
-        /* Disable mouse and keyboard event compression/delaying to make sure we *really* get all of the events. */
-        ::CGSetLocalEventsSuppressionInterval(0.0);
-        ::darwinSetMouseCoalescingEnabled(false);
-
-        /* Bring the caps lock state up to date, otherwise e.g. a later Shift
-         * key press will accidentally inject a CapsLock key press and release,
-         * see UIKeyboardHandler::macKeyboardEvent for the code handling
-         * modifier key state changes */
-        m_uDarwinKeyModifiers ^= (m_uDarwinKeyModifiers ^ ::GetCurrentEventKeyModifiers()) & alphaLock;
-
-        /* Register the event callback/hook and grab the keyboard. */
-        UICocoaApplication::instance()->registerForNativeEvents(RT_BIT_32(10) | RT_BIT_32(11) | RT_BIT_32(12) /* NSKeyDown  | NSKeyUp | | NSFlagsChanged */,
-                                                                UIKeyboardHandler::macKeyboardProc, this);
-
-        ::DarwinGrabKeyboard (false);
-    }
-    else
-    {
-        ::DarwinReleaseKeyboard();
-        UICocoaApplication::instance()->unregisterForNativeEvents(RT_BIT_32(10) | RT_BIT_32(11) | RT_BIT_32(12) /* NSKeyDown  | NSKeyUp | | NSFlagsChanged */,
-                                                                  UIKeyboardHandler::macKeyboardProc, this);
-    }
-}
 
 bool UIKeyboardHandler::macKeyboardProc(const void *pvCocoaEvent, const void *pvCarbonEvent, void *pvUser)