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