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  * (c) 2009 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  */
  11 #ifndef _HANDLERS_H
  12 #define _HANDLERS_H
  13
  14 /**
  15  * Due to bindings like Mode_switch + <a>, we need to bind some keys in
  16  * XCB_GRAB_MODE_SYNC.  Therefore, we just replay all key presses.
  17  *
  18  */
  19 int handle_key_release(void *ignored, xcb_connection_t *conn,
  20                        xcb_key_release_event_t *event);
  21
  22 /**
  23  * There was a key press. We compare this key code with our bindings table and
  24  * pass the bound action to parse_command().
  25  *
  26  */
  27 int handle_key_press(void *ignored, xcb_connection_t *conn,
  28                      xcb_key_press_event_t *event);
  29
  30 /**
  31  * When the user moves the mouse pointer onto a window, this callback gets
  32  * called.
  33  *
  34  */
  35 int handle_enter_notify(void *ignored, xcb_connection_t *conn,
  36                         xcb_enter_notify_event_t *event);
  37
  38 /**
  39  * When the user moves the mouse but does not change the active window
  40  * (e.g. when having no windows opened but moving mouse on the root screen
  41  * and crossing virtual screen boundaries), this callback gets called.
  42  *
  43  */
  44 int handle_motion_notify(void *ignored, xcb_connection_t *conn,
  45                          xcb_motion_notify_event_t *event);
  46
  47 /**
  48  * Called when the keyboard mapping changes (for example by using Xmodmap),
  49  * we need to update our key bindings then (re-translate symbols).
  50  *
  51  */
  52 int handle_mapping_notify(void *ignored, xcb_connection_t *conn,
  53                           xcb_mapping_notify_event_t *event);
  54
  55 /**
  56  * Checks if the button press was on a stack window, handles focus setting and
  57  * returns true if so, or false otherwise.
  58  *
  59  */
  60 int handle_button_press(void *ignored, xcb_connection_t *conn,
  61                         xcb_button_press_event_t *event);
  62
  63 /**
  64  * A new window appeared on the screen (=was mapped), so let’s manage it.
  65  *
  66  */
  67 int handle_map_request(void *prophs, xcb_connection_t *conn,
  68                        xcb_map_request_event_t *event);
  69
  70 /**
  71  * Configuration notifies are only handled because we need to set up ignore
  72  * for the following enter notify events
  73  *
  74  */
  75 int handle_configure_event(void *prophs, xcb_connection_t *conn, xcb_configure_notify_event_t *event);
  76
  77 /**
  78  * Configure requests are received when the application wants to resize
  79  * windows on their own.
  80  *
  81  * We generate a synthethic configure notify event to signalize the client its
  82  * "new" position.
  83  *
  84  */
  85 int handle_configure_request(void *prophs, xcb_connection_t *conn,
  86                              xcb_configure_request_event_t *event);
  87
  88 /**
  89  * Our window decorations were unmapped. That means, the window will be killed
  90  * now, so we better clean up before.
  91  *
  92  */
  93 int handle_unmap_notify_event(void *data, xcb_connection_t *conn, xcb_unmap_notify_event_t *event);
  94
  95 /**
  96  * Called when a window changes its title
  97  *
  98  */
  99 int handle_windowname_change(void *data, xcb_connection_t *conn, uint8_t state,
 100                              xcb_window_t window, xcb_atom_t atom,
 101                              xcb_get_property_reply_t *prop);
 102
 103 /**
 104  * We handle legacy window names (titles) which are in COMPOUND_TEXT
 105  * encoding. However, we just pass them along, so when containing non-ASCII
 106  * characters, those will be rendering incorrectly. In order to correctly
 107  * render unicode window titles in i3, an application has to set _NET_WM_NAME,
 108  * which is in UTF-8 encoding.
 109  *
 110  * On every update, a message is put out to the user, so he may improve the
 111  * situation and update applications which display filenames in their title to
 112  * correctly use _NET_WM_NAME and therefore support unicode.
 113  *
 114  */
 115 int handle_windowname_change_legacy(void *data, xcb_connection_t *conn,
 116                                     uint8_t state, xcb_window_t window,
 117                                     xcb_atom_t atom, xcb_get_property_reply_t
 118                                     *prop);
 119
 120 /**
 121  * Store the window classes for jumping to them later.
 122  *
 123  */
 124 int handle_windowclass_change(void *data, xcb_connection_t *conn, uint8_t state,
 125                               xcb_window_t window, xcb_atom_t atom,
 126                               xcb_get_property_reply_t *prop);
 127
 128
 129 /**
 130  * Expose event means we should redraw our windows (= title bar)
 131  *
 132  */
 133 int handle_expose_event(void *data, xcb_connection_t *conn,
 134                         xcb_expose_event_t *event);
 135
 136 /**
 137  * Handle client messages (EWMH)
 138  *
 139  */
 140 int handle_client_message(void *data, xcb_connection_t *conn,
 141                           xcb_client_message_event_t *event);
 142
 143 /**
 144  * Handles _NET_WM_WINDOW_TYPE changes
 145  *
 146  */
 147 int handle_window_type(void *data, xcb_connection_t *conn, uint8_t state,
 148                        xcb_window_t window, xcb_atom_t atom,
 149                        xcb_get_property_reply_t *property);
 150
 151 /**
 152  * Handles the size hints set by a window, but currently only the part
 153  * necessary for displaying clients proportionally inside their frames
 154  * (mplayer for example)
 155  *
 156  * See ICCCM 4.1.2.3 for more details
 157  *
 158  */
 159 int handle_normal_hints(void *data, xcb_connection_t *conn, uint8_t state,
 160                         xcb_window_t window, xcb_atom_t name,
 161                         xcb_get_property_reply_t *reply);
 162
 163 /**
 164  * Handles the transient for hints set by a window, signalizing that this
 165  * window is a popup window for some other window.
 166  *
 167  * See ICCCM 4.1.2.6 for more details
 168  *
 169  */
 170 int handle_transient_for(void *data, xcb_connection_t *conn, uint8_t state,
 171                          xcb_window_t window, xcb_atom_t name,
 172                          xcb_get_property_reply_t *reply);
 173
 174 /**
 175  * Handles changes of the WM_CLIENT_LEADER atom which specifies if this is a
 176  * toolwindow (or similar) and to which window it belongs (logical parent).
 177  *
 178  */
 179 int handle_clientleader_change(void *data, xcb_connection_t *conn,
 180                                uint8_t state, xcb_window_t window,
 181                                xcb_atom_t name, xcb_get_property_reply_t *prop);
 182
 183 #endif