; More accurate doc strings for 'window-at' and 'window-at-x-y'.

* lisp/window.el (window-at-x-y):
* src/window.c (Fwindow_at): Doc fix.  (Bug#61948)
This commit is contained in:
Eli Zaretskii 2023-03-04 10:43:25 +02:00
parent bd5115e134
commit e0bf2da3db
2 changed files with 9 additions and 2 deletions

View file

@ -4134,6 +4134,10 @@ X and Y are FRAME-relative pixel coordinates. A coordinate on an
edge shared by two windows is attributed to the window on the edge shared by two windows is attributed to the window on the
right (or below). Return nil if no such window can be found. right (or below). Return nil if no such window can be found.
Tool-bar and tab-bar pseudo-windows are ignored by this function:
if the specified coordinates are in any of these two windows, this
function returns nil.
Optional argument FRAME must specify a live frame and defaults to Optional argument FRAME must specify a live frame and defaults to
the selected one. Optional argument NO-OTHER non-nil means to the selected one. Optional argument NO-OTHER non-nil means to
return nil if the window located at the specified coordinates has return nil if the window located at the specified coordinates has

View file

@ -1729,8 +1729,11 @@ window_from_coordinates (struct frame *f, int x, int y,
DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0, DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
doc: /* Return window containing coordinates X and Y on FRAME. doc: /* Return window containing coordinates X and Y on FRAME.
FRAME must be a live frame and defaults to the selected one. FRAME must be a live frame and defaults to the selected one.
The top left corner of the frame is considered to be row 0, X and Y are measured in units of canonical columns and rows.
column 0. */) The top left corner of the frame is considered to be column 0, row 0.
Tool-bar and tab-bar pseudo-windows are ignored by this function: if
the specified coordinates are in any of these two windows, this
function returns nil. */)
(Lisp_Object x, Lisp_Object y, Lisp_Object frame) (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
{ {
struct frame *f = decode_live_frame (frame); struct frame *f = decode_live_frame (frame);