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  * Checks if the button press was on a stack window, handles focus setting and
  49  * returns true if so, or false otherwise.
  50  *
  51  */
  52 int handle_button_press(void *ignored, xcb_connection_t *conn,
  53                         xcb_button_press_event_t *event);
  54
  55 /**
  56  * A new window appeared on the screen (=was mapped), so let’s manage it.
  57  *
  58  */
  59 int handle_map_request(void *prophs, xcb_connection_t *conn,
  60                        xcb_map_request_event_t *event);
  61
  62 /**
  63  * Configuration notifies are only handled because we need to set up ignore
  64  * for the following enter notify events
  65  *
  66  */
  67 int handle_configure_event(void *prophs, xcb_connection_t *conn, xcb_configure_notify_event_t *event);
  68
  69 /**
  70  * Configure requests are received when the application wants to resize
  71  * windows on their own.
  72  *
  73  * We generate a synthethic configure notify event to signalize the client its
  74  * "new" position.
  75  *
  76  */
  77 int handle_configure_request(void *prophs, xcb_connection_t *conn,
  78                              xcb_configure_request_event_t *event);
  79
  80 /**
  81  * Our window decorations were unmapped. That means, the window will be killed
  82  * now, so we better clean up before.
  83  *
  84  */
  85 int handle_unmap_notify_event(void *data, xcb_connection_t *conn, xcb_unmap_notify_event_t *event);
  86
  87 /**
  88  * Called when a window changes its title
  89  *
  90  */
  91 int handle_windowname_change(void *data, xcb_connection_t *conn, uint8_t state,
  92                              xcb_window_t window, xcb_atom_t atom,
  93                              xcb_get_property_reply_t *prop);
  94
  95 /**
  96  * We handle legacy window names (titles) which are in COMPOUND_TEXT
  97  * encoding. However, we just pass them along, so when containing non-ASCII
  98  * characters, those will be rendering incorrectly. In order to correctly
  99  * render unicode window titles in i3, an application has to set _NET_WM_NAME,
 100  * which is in UTF-8 encoding.
 101  *
 102  * On every update, a message is put out to the user, so he may improve the
 103  * situation and update applications which display filenames in their title to
 104  * correctly use _NET_WM_NAME and therefore support unicode.
 105  *
 106  */
 107 int handle_windowname_change_legacy(void *data, xcb_connection_t *conn,
 108                                     uint8_t state, xcb_window_t window,
 109                                     xcb_atom_t atom, xcb_get_property_reply_t
 110                                     *prop);
 111
 112 /**
 113  * Store the window classes for jumping to them later.
 114  *
 115  */
 116 int handle_windowclass_change(void *data, xcb_connection_t *conn, uint8_t state,
 117                               xcb_window_t window, xcb_atom_t atom,
 118                               xcb_get_property_reply_t *prop);
 119
 120
 121 /**
 122  * Expose event means we should redraw our windows (= title bar)
 123  *
 124  */
 125 int handle_expose_event(void *data, xcb_connection_t *conn,
 126                         xcb_expose_event_t *event);
 127
 128 /**
 129  * Handle client messages (EWMH)
 130  *
 131  */
 132 int handle_client_message(void *data, xcb_connection_t *conn,
 133                           xcb_client_message_event_t *event);
 134
 135 /**
 136  * Handles _NET_WM_WINDOW_TYPE changes
 137  *
 138  */
 139 int handle_window_type(void *data, xcb_connection_t *conn, uint8_t state,
 140                        xcb_window_t window, xcb_atom_t atom,
 141                        xcb_get_property_reply_t *property);
 142
 143 /**
 144  * Handles the size hints set by a window, but currently only the part
 145  * necessary for displaying clients proportionally inside their frames
 146  * (mplayer for example)
 147  *
 148  * See ICCCM 4.1.2.3 for more details
 149  *
 150  */
 151 int handle_normal_hints(void *data, xcb_connection_t *conn, uint8_t state,
 152                         xcb_window_t window, xcb_atom_t name,
 153                         xcb_get_property_reply_t *reply);
 154
 155 /**
 156  * Handles the transient for hints set by a window, signalizing that this
 157  * window is a popup window for some other window.
 158  *
 159  * See ICCCM 4.1.2.6 for more details
 160  *
 161  */
 162 int handle_transient_for(void *data, xcb_connection_t *conn, uint8_t state,
 163                          xcb_window_t window, xcb_atom_t name,
 164                          xcb_get_property_reply_t *reply);
 165
 166 /**
 167  * Handles changes of the WM_CLIENT_LEADER atom which specifies if this is a
 168  * toolwindow (or similar) and to which window it belongs (logical parent).
 169  *
 170  */
 171 int handle_clientleader_change(void *data, xcb_connection_t *conn,
 172                                uint8_t state, xcb_window_t window,
 173                                xcb_atom_t name, xcb_get_property_reply_t *prop);
 174
 175 #endif