From b35ac83e4679311c23e5827bd931096be3131f49 Mon Sep 17 00:00:00 2001 From: Chong Yidong Date: Fri, 23 Oct 2009 17:52:56 +0000 Subject: [PATCH] * window.c (Fwindow_edges, Fwindow_pixel_edges) (Fwindow_inside_edges, Fwindow_inside_pixel_edges): Doc fix (Bug#4775). --- src/ChangeLog | 6 ++++++ src/window.c | 52 ++++++++++++++++++++++++++++++--------------------- 2 files changed, 37 insertions(+), 21 deletions(-) diff --git a/src/ChangeLog b/src/ChangeLog index b4bf786ca93..24c2553695f 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,9 @@ +2009-10-23 Chong Yidong + + * window.c (Fwindow_edges, Fwindow_pixel_edges) + (Fwindow_inside_edges, Fwindow_inside_pixel_edges): Doc fix + (Bug#4775). + 2009-10-23 Stefan Monnier * fileio.c (syms_of_fileio): Initialize Vdirectory_sep_char. diff --git a/src/window.c b/src/window.c index 4630b6dd90b..2c178a65d2a 100644 --- a/src/window.c +++ b/src/window.c @@ -609,12 +609,15 @@ Afterwards the end-trigger value is reset to nil. */) DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0, doc: /* Return a list of the edge coordinates of WINDOW. -\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame. -RIGHT is one more than the rightmost column occupied by WINDOW, -and BOTTOM is one more than the bottommost row occupied by WINDOW. -The edges include the space used by the window's scroll bar, -display margins, fringes, header line, and mode line, if it has them. -To get the edges of the actual text area, use `window-inside-edges'. */) +The list has the form (LEFT TOP RIGHT BOTTOM). +TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns, +all relative to 0, 0 at top left corner of frame. + +RIGHT is one more than the rightmost column occupied by WINDOW. +BOTTOM is one more than the bottommost row occupied by WINDOW. +The edges include the space used by WINDOW's scroll bar, display +margins, fringes, header line, and/or mode line. For the edges of +just the text area, use `window-inside-edges'. */) (window) Lisp_Object window; { @@ -629,12 +632,14 @@ To get the edges of the actual text area, use `window-inside-edges'. */) DEFUN ("window-pixel-edges", Fwindow_pixel_edges, Swindow_pixel_edges, 0, 1, 0, doc: /* Return a list of the edge pixel coordinates of WINDOW. -\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame. -RIGHT is one more than the rightmost x position occupied by WINDOW, -and BOTTOM is one more than the bottommost y position occupied by WINDOW. -The pixel edges include the space used by the window's scroll bar, -display margins, fringes, header line, and mode line, if it has them. -To get the edges of the actual text area, use `window-inside-pixel-edges'. */) +The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at +the top left corner of the frame. + +RIGHT is one more than the rightmost x position occupied by WINDOW. +BOTTOM is one more than the bottommost y position occupied by WINDOW. +The pixel edges include the space used by WINDOW's scroll bar, display +margins, fringes, header line, and/or mode line. For the pixel edges +of just the text area, use `window-inside-pixel-edges'. */) (window) Lisp_Object window; { @@ -649,11 +654,14 @@ To get the edges of the actual text area, use `window-inside-pixel-edges'. */) DEFUN ("window-inside-edges", Fwindow_inside_edges, Swindow_inside_edges, 0, 1, 0, doc: /* Return a list of the edge coordinates of WINDOW. -\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame. -RIGHT is one more than the rightmost column used by text in WINDOW, -and BOTTOM is one more than the bottommost row used by text in WINDOW. -The inside edges do not include the space used by the window's scroll bar, -display margins, fringes, header line, and/or mode line. */) +The list has the form (LEFT TOP RIGHT BOTTOM). +TOP and BOTTOM count by lines, and LEFT and RIGHT count by columns, +all relative to 0, 0 at top left corner of frame. + +RIGHT is one more than the rightmost column of WINDOW's text area. +BOTTOM is one more than the bottommost row of WINDOW's text area. +The inside edges do not include the space used by the WINDOW's scroll +bar, display margins, fringes, header line, and/or mode line. */) (window) Lisp_Object window; { @@ -673,10 +681,12 @@ display margins, fringes, header line, and/or mode line. */) DEFUN ("window-inside-pixel-edges", Fwindow_inside_pixel_edges, Swindow_inside_pixel_edges, 0, 1, 0, doc: /* Return a list of the edge pixel coordinates of WINDOW. -\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame. -RIGHT is one more than the rightmost x position used by text in WINDOW, -and BOTTOM is one more than the bottommost y position used by text in WINDOW. -The inside edges do not include the space used by the window's scroll bar, +The list has the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at +the top left corner of the frame. + +RIGHT is one more than the rightmost x position of WINDOW's text area. +BOTTOM is one more than the bottommost y position of WINDOW's text area. +The inside edges do not include the space used by WINDOW's scroll bar, display margins, fringes, header line, and/or mode line. */) (window) Lisp_Object window; -- 2.39.5