Changeset 59346 in vbox

Timestamp:

Jan 14, 2016 1:21:25 PM (9 years ago)

Author:

vboxsync

Message:

FE/Qt: Qt5 migration (part 53): Reworking keyboard-handler: Some of doxy stuff.

File:

• trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIKeyboardHandler.h (modified) (4 diffs)

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

@@ -100 +100 @@
 
 #ifdef Q_WS_WIN
+    /** Tells the 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 winSkipKeyboardEvents(bool fSkip);
 #endif /* Q_WS_WIN */
@@ -105 +108 @@
 #if QT_VERSION < 0x050000
 # if defined(Q_WS_WIN)
+    /** Qt4: Win: Performs final pre-processing of all the native events. */
     bool winEventFilter(MSG *pMsg, ulong uScreenId);
 # elif defined(Q_WS_X11)
+    /** Qt4: X11: Performs final pre-processing of all the native events. */
     bool x11EventFilter(XEvent *pEvent, ulong uScreenId);
 # endif /* Q_WS_X11 */
 #else /* QT_VERSION >= 0x050000 */
+    /** Qt5: Performs final pre-processing of all the native events. */
     bool nativeEventFilter(void *pMessage, ulong uScreenId);
 #endif /* QT_VERSION >= 0x050000 */
@@ -144 +150 @@
 
 #if defined(Q_WS_MAC)
+    /** Mac: Installs/deinstalls low level keyboard hook. */
     void darwinGrabKeyboardEvents(bool fGrab);
+    /** Mac: Performs initial pre-processing of all the native keyboard events. */
     static bool darwinEventHandlerProc(const void *pvCocoaEvent, const void *pvCarbonEvent, void *pvUser);
+    /** Mac: Performs initial pre-processing of all the native keyboard events. */
     bool darwinKeyboardEvent(const void *pvCocoaEvent, EventRef inEvent);
 #elif defined(Q_WS_WIN)
+    /** Win: Performs initial pre-processing of all the native keyboard events. */
     static LRESULT CALLBACK lowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam);
+    /** Win: Performs initial pre-processing of all the native keyboard events. */
     bool winLowKeyboardEvent(UINT msg, const KBDLLHOOKSTRUCT &event);
 #endif /* Q_WS_WIN */
@@ -201 +212 @@
 
 #if defined(Q_WS_MAC)
-    /* The current modifier key mask. Used to figure out which modifier
-     * key was pressed when we get a kEventRawKeyModifiersChanged event. */
+    /** Holds the current modifiers key mask. */
     UInt32 m_darwinKeyModifiers;
+    /** Holds whether the keyboard is grabbed. */
     bool m_fKeyboardGrabbed;
+    /** Holds the keyboard hook view index. */
     int m_iKeyboardGrabViewIndex;
 #elif defined(Q_WS_WIN)
     /* Currently this is used in winLowKeyboardEvent() only: */
     bool m_bIsHostkeyInCapture;
-    /* Keyboard hook required to capture keyboard event under windows. */
+    /** Holds the keyboard handler reference to be accessible from the keyboard hook. */
     static UIKeyboardHandler *m_spKeyboardHandler;
+    /** Holds the keyboard hook instance. */
     HHOOK m_keyboardHook;
+    /** Holds the keyboard hook view index. */
     int m_iKeyboardHookViewIndex;
-    /* A flag that used to tell kbd event filter to ignore keyboard events */
+    /** Holds whether the keyboard event filter should ignore keyboard events. */
     bool m_fSkipKeyboardEvents;
     /** Holds the object monitoring key event stream for problematic AltGr events. */