Merge branch 'backport' into 3.4

[mikachu/openbox.git] / openbox / event.h

diff --git a/openbox/event.h b/openbox/event.h
index 6ff5a7f..1dec416 100644 (file)
--- a/openbox/event.h
+++ b/openbox/event.h
@@ -25,7 +25,7 @@
 struct _ObClient;
 
 /*! The amount of time before a window appears that is checked for user input
-  to determine if the user is working in another window */
+    to determine if the user is working in another window */
 #define OB_EVENT_USER_TIME_DELAY (500) /* 0.5 seconds */
 
 /*! Time at which the last event with a timestamp occured. */
@@ -42,15 +42,21 @@ void event_startup(gboolean reconfig);
 void event_shutdown(gboolean reconfig);
 
 /*! Make as if the mouse just entered the client, use only when using focus
-  follows mouse */
+    follows mouse */
 void event_enter_client(struct _ObClient *client);
 
 /*! Make mouse focus not move at all from the stuff that happens between these
- two function calls. */
+    two function calls. */
 gulong event_start_ignore_all_enters(void);
 void event_end_ignore_all_enters(gulong start);
 
-/*! End *all* active and passive grabs on the keyboard */
+/*! End *all* active and passive grabs on the keyboard
+    This is called in situations where if there is a grab going on, then
+    we need to cancel it. If we move focus during the grab, applications
+    will get NotifyWhileGrabbed events and ignore them!
+
+    Actions should not rely on being able to move focus during an
+    interactive grab. */
 void event_cancel_all_key_grabs(void);
 
 /* Halts any focus delay in progress, use this when the user is selecting a
@@ -58,7 +64,7 @@ void event_cancel_all_key_grabs(void);
 void event_halt_focus_delay(void);
 
 /*! Compare t1 and t2, taking into account wraparound. True if t1
-  comes at the same time or later than t2. */
+    comes at the same time or later than t2. */
 gboolean event_time_after(Time t1, Time t2);
 
 Time event_get_server_time(void);