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  * Called when a window changes its title
  99  *
 100  */
 101 int handle_windowname_change(void *data, xcb_connection_t *conn, uint8_t state,
 102                              xcb_window_t window, xcb_atom_t atom,
 103                              xcb_get_property_reply_t *prop);
 104
 105 /**
 106  * We handle legacy window names (titles) which are in COMPOUND_TEXT
 107  * encoding. However, we just pass them along, so when containing non-ASCII
 108  * characters, those will be rendering incorrectly. In order to correctly
 109  * render unicode window titles in i3, an application has to set _NET_WM_NAME,
 110  * which is in UTF-8 encoding.
 111  *
 112  * On every update, a message is put out to the user, so he may improve the
 113  * situation and update applications which display filenames in their title to
 114  * correctly use _NET_WM_NAME and therefore support unicode.
 115  *
 116  */
 117 int handle_windowname_change_legacy(void *data, xcb_connection_t *conn,
 118                                     uint8_t state, xcb_window_t window,
 119                                     xcb_atom_t atom, xcb_get_property_reply_t
 120                                     *prop);
 121
 122 /**
 123  * Store the window classes for jumping to them later.
 124  *
 125  */
 126 int handle_windowclass_change(void *data, xcb_connection_t *conn, uint8_t state,
 127                               xcb_window_t window, xcb_atom_t atom,
 128                               xcb_get_property_reply_t *prop);
 129
 130
 131 /**
 132  * Expose event means we should redraw our windows (= title bar)
 133  *
 134  */
 135 int handle_expose_event(void *data, xcb_connection_t *conn,
 136                         xcb_expose_event_t *event);
 137
 138 /**
 139  * Handle client messages (EWMH)
 140  *
 141  */
 142 int handle_client_message(void *data, xcb_connection_t *conn,
 143                           xcb_client_message_event_t *event);
 144
 145 /**
 146  * Handles _NET_WM_WINDOW_TYPE changes
 147  *
 148  */
 149 int handle_window_type(void *data, xcb_connection_t *conn, uint8_t state,
 150                        xcb_window_t window, xcb_atom_t atom,
 151                        xcb_get_property_reply_t *property);
 152
 153 /**
 154  * Handles the size hints set by a window, but currently only the part
 155  * necessary for displaying clients proportionally inside their frames
 156  * (mplayer for example)
 157  *
 158  * See ICCCM 4.1.2.3 for more details
 159  *
 160  */
 161 int handle_normal_hints(void *data, xcb_connection_t *conn, uint8_t state,
 162                         xcb_window_t window, xcb_atom_t name,
 163                         xcb_get_property_reply_t *reply);
 164
 165 /**
 166  * Handles the WM_HINTS property for extracting the urgency state of the window.
 167  *
 168  */
 169 int handle_hints(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
 170                   xcb_atom_t name, xcb_get_property_reply_t *reply);
 171
 172 /**
 173  * Handles the transient for hints set by a window, signalizing that this
 174  * window is a popup window for some other window.
 175  *
 176  * See ICCCM 4.1.2.6 for more details
 177  *
 178  */
 179 int handle_transient_for(void *data, xcb_connection_t *conn, uint8_t state,
 180                          xcb_window_t window, xcb_atom_t name,
 181                          xcb_get_property_reply_t *reply);
 182
 183 /**
 184  * Handles changes of the WM_CLIENT_LEADER atom which specifies if this is a
 185  * toolwindow (or similar) and to which window it belongs (logical parent).
 186  *
 187  */
 188 int handle_clientleader_change(void *data, xcb_connection_t *conn,
 189                                uint8_t state, xcb_window_t window,
 190                                xcb_atom_t name, xcb_get_property_reply_t *prop);
 191
 192 #endif