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