aboutsummaryrefslogtreecommitdiffstats
path: root/src/window.c
diff options
context:
space:
mode:
authorEli Zaretskii2007-02-10 11:57:10 +0000
committerEli Zaretskii2007-02-10 11:57:10 +0000
commitc85322d040341ba9593e16e71d72afd9179bf9b5 (patch)
treee718fba6450ef763b01d22a3242c9e206c1d0e92 /src/window.c
parentd9f114a3de88526b4776e3bc2ac9dc04f641afae (diff)
downloademacs-c85322d040341ba9593e16e71d72afd9179bf9b5.tar.gz
emacs-c85322d040341ba9593e16e71d72afd9179bf9b5.zip
(Fwindow_height, Fwindow_hscroll)
(Fwindow_redisplay_end_trigger, Fwindow_point, Fwindow_start) (Fwindow_end, Fwindow_display_table, Fwindow_text_height): Document the effect of WINDOW arg being nil.
Diffstat (limited to 'src/window.c')
-rw-r--r--src/window.c15
1 files changed, 12 insertions, 3 deletions
diff --git a/src/window.c b/src/window.c
index 0fa22675fdc..d54b55d87b9 100644
--- a/src/window.c
+++ b/src/window.c
@@ -537,7 +537,8 @@ WINDOW defaults to the selected window. */)
537} 537}
538 538
539DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0, 539DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
540 doc: /* Return the number of lines in WINDOW (including its mode line). */) 540 doc: /* Return the number of lines in WINDOW (including its mode line).
541WINDOW defaults to the selected window. */)
541 (window) 542 (window)
542 Lisp_Object window; 543 Lisp_Object window;
543{ 544{
@@ -556,7 +557,8 @@ use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
556} 557}
557 558
558DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0, 559DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
559 doc: /* Return the number of columns by which WINDOW is scrolled from left margin. */) 560 doc: /* Return the number of columns by which WINDOW is scrolled from left margin.
561WINDOW defaults to the selected window. */)
560 (window) 562 (window)
561 Lisp_Object window; 563 Lisp_Object window;
562{ 564{
@@ -589,6 +591,7 @@ window so that the location of point moves off-window. */)
589DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger, 591DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
590 Swindow_redisplay_end_trigger, 0, 1, 0, 592 Swindow_redisplay_end_trigger, 0, 1, 0,
591 doc: /* Return WINDOW's redisplay end trigger value. 593 doc: /* Return WINDOW's redisplay end trigger value.
594WINDOW defaults to the selected window.
592See `set-window-redisplay-end-trigger' for more information. */) 595See `set-window-redisplay-end-trigger' for more information. */)
593 (window) 596 (window)
594 Lisp_Object window; 597 Lisp_Object window;
@@ -1111,6 +1114,8 @@ column 0. */)
1111 1114
1112DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0, 1115DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
1113 doc: /* Return current value of point in WINDOW. 1116 doc: /* Return current value of point in WINDOW.
1117WINDOW defaults to the selected window.
1118
1114For a nonselected window, this is the value point would have 1119For a nonselected window, this is the value point would have
1115if that window were selected. 1120if that window were selected.
1116 1121
@@ -1132,6 +1137,7 @@ But that is hard to define. */)
1132 1137
1133DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0, 1138DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
1134 doc: /* Return position at which display currently starts in WINDOW. 1139 doc: /* Return position at which display currently starts in WINDOW.
1140WINDOW defaults to the selected window.
1135This is updated by redisplay or by calling `set-window-start'. */) 1141This is updated by redisplay or by calling `set-window-start'. */)
1136 (window) 1142 (window)
1137 Lisp_Object window; 1143 Lisp_Object window;
@@ -1152,6 +1158,7 @@ have been if redisplay had finished, do this:
1152 1158
1153DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0, 1159DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
1154 doc: /* Return position at which display currently ends in WINDOW. 1160 doc: /* Return position at which display currently ends in WINDOW.
1161WINDOW defaults to the selected window.
1155This is updated by redisplay, when it runs to completion. 1162This is updated by redisplay, when it runs to completion.
1156Simply changing the buffer text or setting `window-start' 1163Simply changing the buffer text or setting `window-start'
1157does not update this value. 1164does not update this value.
@@ -1302,7 +1309,8 @@ non-nil means yes. */)
1302 1309
1303DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table, 1310DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1304 0, 1, 0, 1311 0, 1, 0,
1305 doc: /* Return the display-table that WINDOW is using. */) 1312 doc: /* Return the display-table that WINDOW is using.
1313WINDOW defaults to the selected window. */)
1306 (window) 1314 (window)
1307 Lisp_Object window; 1315 Lisp_Object window;
1308{ 1316{
@@ -5896,6 +5904,7 @@ and redisplay normally--don't erase and redraw the frame. */)
5896DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height, 5904DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
5897 0, 1, 0, 5905 0, 1, 0,
5898 doc: /* Return the height in lines of the text display area of WINDOW. 5906 doc: /* Return the height in lines of the text display area of WINDOW.
5907WINDOW defaults to the selected window.
5899This doesn't include the mode-line (or header-line if any) or any 5908This doesn't include the mode-line (or header-line if any) or any
5900partial-height lines in the text display area. */) 5909partial-height lines in the text display area. */)
5901 (window) 5910 (window)