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