git.sur5r.net Git - i3/i3/blob - include/handlers.h

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2010 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  */
  11 #ifndef _HANDLERS_H
  12 #define _HANDLERS_H
  13
  14 #include <xcb/randr.h>
  15
  16 extern int randr_base;
  17
  18 /**
  19  * Takes an xcb_generic_event_t and calls the appropriate handler, based on the
  20  * event type.
  21  *
  22  */
  23 void handle_event(int type, xcb_generic_event_t *event);
  24
  25 /**
  26  * Requests the property and invokes the appropriate callback.
  27  *
  28  */
  29 int property_notify(uint8_t state, xcb_window_t window, xcb_atom_t atom);
  30
  31 /**
  32  * Sets the appropriate atoms for the property handlers after the atoms were
  33  * received from X11
  34  *
  35  */
  36 void property_handlers_init();
  37
  38 /**
  39  * There was a key press. We compare this key code with our bindings table and
  40  * pass the bound action to parse_command().
  41  *
  42  */
  43 int handle_key_press(void *ignored, xcb_connection_t *conn,
  44                      xcb_key_press_event_t *event);
  45
  46 /**
  47  * When the user moves the mouse pointer onto a window, this callback gets
  48  * called.
  49  *
  50  */
  51 int handle_enter_notify(void *ignored, xcb_connection_t *conn,
  52                         xcb_enter_notify_event_t *event);
  53
  54 /**
  55  * When the user moves the mouse but does not change the active window
  56  * (e.g. when having no windows opened but moving mouse on the root screen
  57  * and crossing virtual screen boundaries), this callback gets called.
  58  *
  59  */
  60 int handle_motion_notify(void *ignored, xcb_connection_t *conn,
  61                          xcb_motion_notify_event_t *event);
  62
  63 /**
  64  * Called when the keyboard mapping changes (for example by using Xmodmap),
  65  * we need to update our key bindings then (re-translate symbols).
  66  *
  67  */
  68 int handle_mapping_notify(void *ignored, xcb_connection_t *conn,
  69                           xcb_mapping_notify_event_t *event);
  70
  71 /**
  72  * Checks if the button press was on a stack window, handles focus setting and
  73  * returns true if so, or false otherwise.
  74  *
  75  */
  76 int handle_button_press(void *ignored, xcb_connection_t *conn,
  77                         xcb_button_press_event_t *event);
  78
  79 /**
  80  * A new window appeared on the screen (=was mapped), so let’s manage it.
  81  *
  82  */
  83 int handle_map_request(void *prophs, xcb_connection_t *conn,
  84                        xcb_map_request_event_t *event);
  85
  86 /**
  87  * Configuration notifies are only handled because we need to set up ignore
  88  * for the following enter notify events
  89  *
  90  */
  91 int handle_configure_event(void *prophs, xcb_connection_t *conn, xcb_configure_notify_event_t *event);
  92
  93 /**
  94  * Gets triggered upon a RandR screen change event, that is when the user
  95  * changes the screen configuration in any way (mode, position, …)
  96  *
  97  */
  98 int handle_screen_change(void *prophs, xcb_connection_t *conn,
  99                          xcb_generic_event_t *e);
 100
 101 /**
 102  * Configure requests are received when the application wants to resize
 103  * windows on their own.
 104  *
 105  * We generate a synthethic configure notify event to signalize the client its
 106  * "new" position.
 107  *
 108  */
 109 int handle_configure_request(void *prophs, xcb_connection_t *conn,
 110                              xcb_configure_request_event_t *event);
 111
 112 /**
 113  * Our window decorations were unmapped. That means, the window will be killed
 114  * now, so we better clean up before.
 115  *
 116  */
 117 int handle_unmap_notify_event(void *data, xcb_connection_t *conn, xcb_unmap_notify_event_t *event);
 118
 119 /**
 120  * A destroy notify event is sent when the window is not unmapped, but
 121  * immediately destroyed (for example when starting a window and immediately
 122  * killing the program which started it).
 123  *
 124  * We just pass on the event to the unmap notify handler (by copying the
 125  * important fields in the event data structure).
 126  *
 127  */
 128 int handle_destroy_notify_event(void *data, xcb_connection_t *conn,
 129                                 xcb_destroy_notify_event_t *event);
 130
 131 /**
 132  * Called when a window changes its title
 133  *
 134  */
 135 int handle_windowname_change(void *data, xcb_connection_t *conn, uint8_t state,
 136                              xcb_window_t window, xcb_atom_t atom,
 137                              xcb_get_property_reply_t *prop);
 138
 139 /**
 140  * We handle legacy window names (titles) which are in COMPOUND_TEXT
 141  * encoding. However, we just pass them along, so when containing non-ASCII
 142  * characters, those will be rendering incorrectly. In order to correctly
 143  * render unicode window titles in i3, an application has to set _NET_WM_NAME,
 144  * which is in UTF-8 encoding.
 145  *
 146  * On every update, a message is put out to the user, so he may improve the
 147  * situation and update applications which display filenames in their title to
 148  * correctly use _NET_WM_NAME and therefore support unicode.
 149  *
 150  */
 151 int handle_windowname_change_legacy(void *data, xcb_connection_t *conn,
 152                                     uint8_t state, xcb_window_t window,
 153                                     xcb_atom_t atom, xcb_get_property_reply_t
 154                                     *prop);
 155
 156 /**
 157  * Store the window classes for jumping to them later.
 158  *
 159  */
 160 int handle_windowclass_change(void *data, xcb_connection_t *conn, uint8_t state,
 161                               xcb_window_t window, xcb_atom_t atom,
 162                               xcb_get_property_reply_t *prop);
 163
 164
 165 /**
 166  * Expose event means we should redraw our windows (= title bar)
 167  *
 168  */
 169 int handle_expose_event(void *data, xcb_connection_t *conn,
 170                         xcb_expose_event_t *event);
 171
 172 /**
 173  * Handle client messages (EWMH)
 174  *
 175  */
 176 int handle_client_message(void *data, xcb_connection_t *conn,
 177                           xcb_client_message_event_t *event);
 178
 179 /**
 180  * Handles _NET_WM_WINDOW_TYPE changes
 181  *
 182  */
 183 int handle_window_type(void *data, xcb_connection_t *conn, uint8_t state,
 184                        xcb_window_t window, xcb_atom_t atom,
 185                        xcb_get_property_reply_t *property);
 186
 187 /**
 188  * Handles the size hints set by a window, but currently only the part
 189  * necessary for displaying clients proportionally inside their frames
 190  * (mplayer for example)
 191  *
 192  * See ICCCM 4.1.2.3 for more details
 193  *
 194  */
 195 int handle_normal_hints(void *data, xcb_connection_t *conn, uint8_t state,
 196                         xcb_window_t window, xcb_atom_t name,
 197                         xcb_get_property_reply_t *reply);
 198
 199 /**
 200  * Handles the WM_HINTS property for extracting the urgency state of the window.
 201  *
 202  */
 203 int handle_hints(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
 204                   xcb_atom_t name, xcb_get_property_reply_t *reply);
 205
 206 /**
 207  * Handles the transient for hints set by a window, signalizing that this
 208  * window is a popup window for some other window.
 209  *
 210  * See ICCCM 4.1.2.6 for more details
 211  *
 212  */
 213 int handle_transient_for(void *data, xcb_connection_t *conn, uint8_t state,
 214                          xcb_window_t window, xcb_atom_t name,
 215                          xcb_get_property_reply_t *reply);
 216
 217 /**
 218  * Handles changes of the WM_CLIENT_LEADER atom which specifies if this is a
 219  * toolwindow (or similar) and to which window it belongs (logical parent).
 220  *
 221  */
 222 int handle_clientleader_change(void *data, xcb_connection_t *conn,
 223                                uint8_t state, xcb_window_t window,
 224                                xcb_atom_t name, xcb_get_property_reply_t *prop);
 225
 226 #endif