Fix some typos and style in client.c, and add a comment.
[mikachu/openbox.git] / openbox / event.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    event.h for the Openbox window manager
4    Copyright (c) 2003-2007   Dana Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #ifndef __events_h
20 #define __events_h
21
22 #include <X11/Xlib.h>
23 #include <glib.h>
24
25 struct _ObClient;
26
27 /*! The amount of time before a window appears that is checked for user input
28     to determine if the user is working in another window */
29 #define OB_EVENT_USER_TIME_DELAY (500) /* 0.5 seconds */
30
31 /*! Time at which the last event with a timestamp occured. */
32 extern Time event_curtime;
33 /*! The last user-interaction time, as given by the clients */
34 extern Time event_last_user_time;
35
36 /*! The value of the mask for the NumLock modifier */
37 extern guint NumLockMask;
38 /*! The value of the mask for the ScrollLock modifier */
39 extern guint ScrollLockMask;
40
41 void event_startup(gboolean reconfig);
42 void event_shutdown(gboolean reconfig);
43
44 /*! Make as if the mouse just entered the client, use only when using focus
45     follows mouse */
46 void event_enter_client(struct _ObClient *client);
47
48 /*! Make mouse focus not move at all from the stuff that happens between these
49     two function calls. */
50 gulong event_start_ignore_all_enters();
51 void event_end_ignore_all_enters(gulong start);
52
53 /*! End *all* active and passive grabs on the keyboard
54     This is called in situations where if there is a grab going on, then
55     we need to cancel it. If we move focus during the grab, applications
56     will get NotifyWhileGrabbed events and ignore them!
57
58     Actions should not rely on being able to move focus during an
59     interactive grab. */
60 void event_cancel_all_key_grabs();
61
62 /* Halts any focus delay in progress, use this when the user is selecting a
63    window for focus */
64 void event_halt_focus_delay();
65
66 /*! Compare t1 and t2, taking into account wraparound. True if t1
67     comes at the same time or later than t2. */
68 gboolean event_time_after(Time t1, Time t2);
69
70 Time event_get_server_time();
71
72 #endif