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