*
* i3 - an improved dynamic tiling window manager
*
- * (c) 2009 Michael Stapelberg and contributors
+ * © 2009-2010 Michael Stapelberg and contributors
*
* See file LICENSE for license information.
*
#ifndef _HANDLERS_H
#define _HANDLERS_H
-int handle_key_release(void *ignored, xcb_connection_t *conn, xcb_key_release_event_t *event);
-int handle_key_press(void *ignored, xcb_connection_t *conn, xcb_key_press_event_t *event);
-int handle_enter_notify(void *ignored, xcb_connection_t *conn, xcb_enter_notify_event_t *event);
-int handle_button_press(void *ignored, xcb_connection_t *conn, xcb_button_press_event_t *event);
-int handle_map_notify_event(void *prophs, xcb_connection_t *conn, xcb_map_notify_event_t *event);
+#include <xcb/randr.h>
+
+
+void add_ignore_event(const int sequence);
+
+/**
+ * There was a key press. We compare this key code with our bindings table and
+ * pass the bound action to parse_command().
+ *
+ */
+int handle_key_press(void *ignored, xcb_connection_t *conn,
+ xcb_key_press_event_t *event);
+
+/**
+ * When the user moves the mouse pointer onto a window, this callback gets
+ * called.
+ *
+ */
+int handle_enter_notify(void *ignored, xcb_connection_t *conn,
+ xcb_enter_notify_event_t *event);
+
+/**
+ * When the user moves the mouse but does not change the active window
+ * (e.g. when having no windows opened but moving mouse on the root screen
+ * and crossing virtual screen boundaries), this callback gets called.
+ *
+ */
+int handle_motion_notify(void *ignored, xcb_connection_t *conn,
+ xcb_motion_notify_event_t *event);
+
+#if 0
+/**
+ * Called when the keyboard mapping changes (for example by using Xmodmap),
+ * we need to update our key bindings then (re-translate symbols).
+ *
+ */
+int handle_mapping_notify(void *ignored, xcb_connection_t *conn,
+ xcb_mapping_notify_event_t *event);
+
+/**
+ * Checks if the button press was on a stack window, handles focus setting and
+ * returns true if so, or false otherwise.
+ *
+ */
+int handle_button_press(void *ignored, xcb_connection_t *conn,
+ xcb_button_press_event_t *event);
+#endif
+/**
+ * A new window appeared on the screen (=was mapped), so let’s manage it.
+ *
+ */
+int handle_map_request(void *prophs, xcb_connection_t *conn,
+ xcb_map_request_event_t *event);
+#if 0
+/**
+ * Configuration notifies are only handled because we need to set up ignore
+ * for the following enter notify events
+ *
+ */
+int handle_configure_event(void *prophs, xcb_connection_t *conn, xcb_configure_notify_event_t *event);
+#endif
+
+/**
+ * Gets triggered upon a RandR screen change event, that is when the user
+ * changes the screen configuration in any way (mode, position, …)
+ *
+ */
+int handle_screen_change(void *prophs, xcb_connection_t *conn,
+ xcb_generic_event_t *e);
+
+/**
+ * Configure requests are received when the application wants to resize
+ * windows on their own.
+ *
+ * We generate a synthethic configure notify event to signalize the client its
+ * "new" position.
+ *
+ */
+int handle_configure_request(void *prophs, xcb_connection_t *conn,
+ xcb_configure_request_event_t *event);
+
+/**
+ * Our window decorations were unmapped. That means, the window will be killed
+ * now, so we better clean up before.
+ *
+ */
+int handle_unmap_notify_event(void *data, xcb_connection_t *conn, xcb_unmap_notify_event_t *event);
+
+/**
+ * A destroy notify event is sent when the window is not unmapped, but
+ * immediately destroyed (for example when starting a window and immediately
+ * killing the program which started it).
+ *
+ * We just pass on the event to the unmap notify handler (by copying the
+ * important fields in the event data structure).
+ *
+ */
+int handle_destroy_notify_event(void *data, xcb_connection_t *conn,
+ xcb_destroy_notify_event_t *event);
+
+/**
+ * Called when a window changes its title
+ *
+ */
int handle_windowname_change(void *data, xcb_connection_t *conn, uint8_t state,
- xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *prop);
-int handle_expose_event(void *data, xcb_connection_t *conn, xcb_expose_event_t *event);
-int handle_client_message(void *data, xcb_connection_t *conn, xcb_client_message_event_t *event);
-int window_type_handler(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window, xcb_atom_t atom, xcb_get_property_reply_t *property);
+ xcb_window_t window, xcb_atom_t atom,
+ xcb_get_property_reply_t *prop);
+/**
+ * Handles legacy window name updates (WM_NAME), see also src/window.c,
+ * window_update_name_legacy().
+ *
+ */
+int handle_windowname_change_legacy(void *data, xcb_connection_t *conn,
+ uint8_t state, xcb_window_t window,
+ xcb_atom_t atom, xcb_get_property_reply_t
+ *prop);
+
+#if 0
+/**
+ * Store the window classes for jumping to them later.
+ *
+ */
+int handle_windowclass_change(void *data, xcb_connection_t *conn, uint8_t state,
+ xcb_window_t window, xcb_atom_t atom,
+ xcb_get_property_reply_t *prop);
+
+#endif
+/**
+ * Expose event means we should redraw our windows (= title bar)
+ *
+ */
+int handle_expose_event(void *data, xcb_connection_t *conn,
+ xcb_expose_event_t *event);
+/**
+ * Handle client messages (EWMH)
+ *
+ */
+int handle_client_message(void *data, xcb_connection_t *conn,
+ xcb_client_message_event_t *event);
+
+#if 0
+/**
+ * Handles _NET_WM_WINDOW_TYPE changes
+ *
+ */
+int handle_window_type(void *data, xcb_connection_t *conn, uint8_t state,
+ xcb_window_t window, xcb_atom_t atom,
+ xcb_get_property_reply_t *property);
+#endif
+
+/**
+ * Handles the size hints set by a window, but currently only the part
+ * necessary for displaying clients proportionally inside their frames
+ * (mplayer for example)
+ *
+ * See ICCCM 4.1.2.3 for more details
+ *
+ */
+int handle_normal_hints(void *data, xcb_connection_t *conn, uint8_t state,
+ xcb_window_t window, xcb_atom_t name,
+ xcb_get_property_reply_t *reply);
+
+/**
+ * Handles the WM_HINTS property for extracting the urgency state of the window.
+ *
+ */
+int handle_hints(void *data, xcb_connection_t *conn, uint8_t state, xcb_window_t window,
+ xcb_atom_t name, xcb_get_property_reply_t *reply);
+
+/**
+ * Handles the transient for hints set by a window, signalizing that this
+ * window is a popup window for some other window.
+ *
+ * See ICCCM 4.1.2.6 for more details
+ *
+ */
+int handle_transient_for(void *data, xcb_connection_t *conn, uint8_t state,
+ xcb_window_t window, xcb_atom_t name,
+ xcb_get_property_reply_t *reply);
+
+/**
+ * Handles changes of the WM_CLIENT_LEADER atom which specifies if this is a
+ * toolwindow (or similar) and to which window it belongs (logical parent).
+ *
+ */
+int handle_clientleader_change(void *data, xcb_connection_t *conn,
+ uint8_t state, xcb_window_t window,
+ xcb_atom_t name, xcb_get_property_reply_t *prop);
#endif