summaryrefslogtreecommitdiff
path: root/gtk/gtkmenu.c
diff options
context:
space:
mode:
authorTim Janik <timj@imendio.com>2007-08-17 09:36:15 +0000
committerTim Janik <timj@src.gnome.org>2007-08-17 09:36:15 +0000
commitfda0eb309b33b2bf078caa33d92c89fcf7cdc880 (patch)
treebbbb65c4f3b74d6613544a01ff6841182d09ab0f /gtk/gtkmenu.c
parent2c0f4daeb1e7a809b7f02d7a8829866e9ff7475b (diff)
downloadgtk+-fda0eb309b33b2bf078caa33d92c89fcf7cdc880.tar.gz
Clarified activate_time docs.
Fri Aug 17 11:36:29 2007 Tim Janik <timj@imendio.com> * gtk/gtkmenu.c (gtk_menu_popup): Clarified activate_time docs. svn path=/trunk/; revision=18643
Diffstat (limited to 'gtk/gtkmenu.c')
-rw-r--r--gtk/gtkmenu.c10
1 files changed, 6 insertions, 4 deletions
diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c
index 6e99ce0bf1..7d44efbfd3 100644
--- a/gtk/gtkmenu.c
+++ b/gtk/gtkmenu.c
@@ -1251,10 +1251,12 @@ popup_grab_on_window (GdkWindow *window,
* a mouse button press, such as a mouse button release or a keypress,
* @button should be 0.
*
- * The @activate_time parameter should be the time stamp of the event that
- * initiated the popup. If such an event is not available, use
- * gtk_get_current_event_time() instead.
- *
+ * The @activate_time parameter is used to conflict-resolve initiation of
+ * concurrent requests for mouse/keyboard grab requests. To function
+ * properly, this needs to be the time stamp of the user event (such as
+ * a mouse click or key press) that caused the initiation of the popup.
+ * Only if no such event is available, gtk_get_current_event_time() can
+ * be used instead.
*/
void
gtk_menu_popup (GtkMenu *menu,