]> git.sur5r.net Git - i3/i3/blobdiff - include/floating.h
Merge branch 'release-4.16.1'
[i3/i3] / include / floating.h
index a312daee37a666ace59cebb4f5d3d7ea4b4e70e2..4382437bbbb8f01ef262ca99b4db0fb76ddc2dce 100644 (file)
@@ -1,31 +1,31 @@
 /*
- * vim:ts=8:expandtab
+ * vim:ts=4:sw=4:expandtab
  *
  * i3 - an improved dynamic tiling window manager
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
- * © 2009-2010 Michael Stapelberg and contributors
- *
- * See file LICENSE for license information.
+ * floating.c: Floating windows.
  *
  */
-#ifndef _FLOATING_H
-#define _FLOATING_H
+#pragma once
+
+#include <config.h>
 
 #include "tree.h"
 
 /** Callback for dragging */
-typedef void(*callback_t)(Con*, Rect*, uint32_t, uint32_t, void*);
+typedef void (*callback_t)(Con *, Rect *, uint32_t, uint32_t, const void *);
 
 /** Macro to create a callback function for dragging */
-#define DRAGGING_CB(name) \
-        static void name(Con *con, Rect *old_rect, uint32_t new_x, \
-                         uint32_t new_y, void *extra)
+#define DRAGGING_CB(name)                                      \
+    static void name(Con *con, Rect *old_rect, uint32_t new_x, \
+                     uint32_t new_y, const void *extra)
 
 /** On which border was the dragging initiated? */
-typedef enum { BORDER_LEFT   = (1 << 0),
-               BORDER_RIGHT  = (1 << 1),
-               BORDER_TOP    = (1 << 2),
-               BORDER_BOTTOM = (1 << 3)} border_t;
+typedef enum { BORDER_LEFT = (1 << 0),
+               BORDER_RIGHT = (1 << 1),
+               BORDER_TOP = (1 << 2),
+               BORDER_BOTTOM = (1 << 3) } border_t;
 
 /**
  * Enables floating mode for the given container by detaching it from its
@@ -53,31 +53,37 @@ void floating_disable(Con *con, bool automatic);
  */
 void toggle_floating_mode(Con *con, bool automatic);
 
-#if 0
 /**
- * Removes the floating client from its workspace and attaches it to the new
- * workspace. This is centralized here because it may happen if you move it
- * via keyboard and if you move it using your mouse.
+ * Raises the given container in the list of floating containers
+ *
+ */
+void floating_raise_con(Con *con);
+
+/**
+ * Checks if con’s coordinates are within its workspace and re-assigns it to
+ * the actual workspace if not.
+ *
+ */
+bool floating_maybe_reassign_ws(Con *con);
+
+/**
+ * Centers a floating con above the specified rect.
  *
  */
-void floating_assign_to_workspace(Client *client, Workspace *new_workspace);
+void floating_center(Con *con, Rect rect);
 
 /**
- * Called whenever the user clicks on a border (not the titlebar!) of a
- * floating window. Determines on which border the user clicked and launches
- * the drag_pointer function with the resize_callback.
+ * Moves the given floating con to the current pointer position.
  *
  */
-int floating_border_click(xcb_connection_t *conn, Client *client,
-                          xcb_button_press_event_t *event);
+void floating_move_to_pointer(Con *con);
 
-#endif
 /**
  * Called when the user clicked on the titlebar of a floating window.
  * Calls the drag_pointer function with the drag_window callback
  *
  */
-void floating_drag_window(Con *con, xcb_button_press_event_t *event);
+void floating_drag_window(Con *con, const xcb_button_press_event_t *event);
 
 /**
  * Called when the user clicked on a floating window while holding the
@@ -85,44 +91,72 @@ void floating_drag_window(Con *con, xcb_button_press_event_t *event);
  * Calls the drag_pointer function with the resize_window callback
  *
  */
-void floating_resize_window(Con *con, bool proportional, xcb_button_press_event_t *event);
+void floating_resize_window(Con *con, const bool proportional, const xcb_button_press_event_t *event);
 
-#if 0
 /**
- * Changes focus in the given direction for floating clients.
+ * Called when a floating window is created or resized.
+ * This function resizes the window if its size is higher or lower than the
+ * configured maximum/minimum size, respectively.
  *
- * Changing to the left/right means going to the previous/next floating client,
- * changing to top/bottom means cycling through the Z-index.
+ */
+void floating_check_size(Con *floating_con);
+
+/**
+ * This is the return value of a drag operation like drag_pointer.
+ *
+ * DRAGGING will indicate the drag action is still in progress and can be
+ * continued or resolved.
+ *
+ * DRAG_SUCCESS will indicate the intention of the drag action should be
+ * carried out.
+ *
+ * DRAG_REVERT will indicate an attempt should be made to restore the state of
+ * the involved windows to their condition before the drag.
+ *
+ * DRAG_ABORT will indicate that the intention of the drag action cannot be
+ * carried out (e.g. because the window has been unmapped).
  *
  */
-void floating_focus_direction(xcb_connection_t *conn, Client *currently_focused,
-                              direction_t direction);
+typedef enum {
+    DRAGGING = 0,
+    DRAG_SUCCESS,
+    DRAG_REVERT,
+    DRAG_ABORT
+} drag_result_t;
 
 /**
- * Moves the client 10px to the specified direction.
+ * This function grabs your pointer and keyboard and lets you drag stuff around
+ * (borders). Every time you move your mouse, an XCB_MOTION_NOTIFY event will
+ * be received and the given callback will be called with the parameters
+ * specified (client, border on which the click originally was), the original
+ * rect of the client, the event and the new coordinates (x, y).
  *
  */
-void floating_move(xcb_connection_t *conn, Client *currently_focused,
-                   direction_t direction);
+drag_result_t drag_pointer(Con *con, const xcb_button_press_event_t *event,
+                           xcb_window_t confine_to, border_t border, int cursor,
+                           callback_t callback, const void *extra);
 
 /**
- * Hides all floating clients (or show them if they are currently hidden) on
- * the specified workspace.
+ * Repositions the CT_FLOATING_CON to have the coordinates specified by
+ * newrect, but only if the coordinates are not out-of-bounds. Also reassigns
+ * the floating con to a different workspace if this move was across different
+ * outputs.
  *
  */
-void floating_toggle_hide(xcb_connection_t *conn, Workspace *workspace);
+bool floating_reposition(Con *con, Rect newrect);
 
-#endif
 /**
- * This function grabs your pointer and lets you drag stuff around (borders).
- * Every time you move your mouse, an XCB_MOTION_NOTIFY event will be received
- * and the given callback will be called with the parameters specified (client,
- * border on which the click originally was), the original rect of the client,
- * the event and the new coordinates (x, y).
+ * Sets size of the CT_FLOATING_CON to specified dimensions. Might limit the
+ * actual size with regard to size constraints taken from user settings.
+ * Additionally, the dimensions may be upscaled until they're divisible by the
+ * window's size hints.
  *
  */
-void drag_pointer(Con *con, xcb_button_press_event_t *event,
-                  xcb_window_t confine_to, border_t border, callback_t callback,
-                  void *extra);
+void floating_resize(Con *floating_con, int x, int y);
 
-#endif
+/**
+ * Fixes the coordinates of the floating window whenever the window gets
+ * reassigned to a different output (or when the output’s rect changes).
+ *
+ */
+void floating_fix_coordinates(Con *con, Rect *old_rect, Rect *new_rect);