cc441405a4638e582f0119149ec76b5ff991981a
[dana/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 (1000) /* milliseconds */
30
31 /*! The last user-interaction time, as given by the clients */
32 extern Time event_last_user_time;
33
34 void event_startup(gboolean reconfig);
35 void event_shutdown(gboolean reconfig);
36
37 /*! Make as if the mouse just entered the client, use only when using focus
38     follows mouse */
39 void event_enter_client(struct _ObClient *client);
40
41 /*! Make as if the mouse just left the client, use only when using focus
42     follows mouse */
43 void event_leave_client(struct _ObClient *client);
44
45 /*! Make mouse focus not move at all from the stuff that happens between these
46     two function calls. */
47 gulong event_start_ignore_all_enters(void);
48 void event_end_ignore_all_enters(gulong start);
49
50 /*! End *all* active and passive grabs on the keyboard
51     This is called in situations where if there is a grab going on, then
52     we need to cancel it. If we move focus during the grab, applications
53     will get NotifyWhileGrabbed events and ignore them!
54
55     Actions should not rely on being able to move focus during an
56     interactive grab. */
57 void event_cancel_all_key_grabs(void);
58
59 /* Halts any focus delay in progress, use this when the user is selecting a
60    window for focus */
61 void event_halt_focus_delay(void);
62
63 /*! Compare t1 and t2, taking into account wraparound. True if t1
64     comes at the same time or later than t2. */
65 gboolean event_time_after(guint32 t1, guint32 t2);
66
67 /*! Time at which the current event occured.  If this is not known, this
68   is a time at or after it, but at or before any other events we will process
69 */
70 Time event_time(void);
71
72 /*! Force event_time() to skip the current timestamp and look for the next
73   one. */
74 void event_reset_time(void);
75
76 /*! A time at which an event happened that caused this current event to be
77   generated.  This is a user-provided time and not to be trusted.
78   Returns CurrentTime if there was no source time provided.
79 */
80 Time event_source_time(void);
81
82 /*! Update the timestamp for when the user has last used the focused window.
83   This updates the timestamp to the time of the last event, given by
84   event_time().
85 */
86 void event_update_user_time(void);
87
88 /*! Reset the timestamp for when the user has last used the focused window. */
89 void event_reset_user_time(void);
90
91 #endif