aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChong Yidong2012-01-28 12:26:33 +0800
committerChong Yidong2012-01-28 12:26:33 +0800
commit9583ec5948d36c34ec382e9e276c02e72b53eb37 (patch)
treeafff255914426b4f667de0fd2fb9340ecf7ef972
parent691db2504df5e19784170ac81ee975a99e6d4dc1 (diff)
downloademacs-9583ec5948d36c34ec382e9e276c02e72b53eb37.tar.gz
emacs-9583ec5948d36c34ec382e9e276c02e72b53eb37.zip
* doc/emacs/frames.texi (Input Focus): Fix doc for select-frame-set-input-focus.
Clarify role of NORECORD arg to select-frame.
-rw-r--r--doc/lispref/ChangeLog3
-rw-r--r--doc/lispref/frames.texi34
2 files changed, 21 insertions, 16 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 39553c22b3b..33c41b0b03d 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,5 +1,8 @@
12012-01-28 Chong Yidong <cyd@gnu.org> 12012-01-28 Chong Yidong <cyd@gnu.org>
2 2
3 * frames.texi (Input Focus): Add NORECORD arg to
4 select-frame-set-input-focus. Clarify its role in select-frame.
5
3 * text.texi (Transposition): We don't use transpose-region as an 6 * text.texi (Transposition): We don't use transpose-region as an
4 internal subroutine (Bug#3249). 7 internal subroutine (Bug#3249).
5 8
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 4835a5b3da2..27303637e42 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -1377,15 +1377,15 @@ remains selected until a subsequent call to @code{select-frame}. Each
1377terminal frame has a number which appears in the mode line before the 1377terminal frame has a number which appears in the mode line before the
1378buffer name (@pxref{Mode Line Variables}). 1378buffer name (@pxref{Mode Line Variables}).
1379 1379
1380@defun select-frame-set-input-focus frame 1380@defun select-frame-set-input-focus frame &optional norecord
1381This function selects @var{frame}, raises it (should it happen to be 1381This function selects @var{frame}, raises it (should it happen to be
1382obscured by other frames) and tries to give it the X server's focus. On 1382obscured by other frames) and tries to give it the X server's focus.
1383a text-only terminal, the next redisplay displays the new frame on the 1383On a text-only terminal, the next redisplay displays the new frame on
1384entire terminal screen. The return value of this function is not 1384the entire terminal screen. The optional argument @var{norecord} has
1385significant. 1385the same meaning as for @code{select-frame} (see below). The return
1386value of this function is not significant.
1386@end defun 1387@end defun
1387 1388
1388@c ??? This is not yet implemented properly.
1389@defun select-frame frame &optional norecord 1389@defun select-frame frame &optional norecord
1390This function selects frame @var{frame}, temporarily disregarding the 1390This function selects frame @var{frame}, temporarily disregarding the
1391focus of the X server if any. The selection of @var{frame} lasts until 1391focus of the X server if any. The selection of @var{frame} lasts until
@@ -1395,18 +1395,20 @@ window system, the previously selected frame may be restored as the
1395selected frame after return to the command loop, because it still may 1395selected frame after return to the command loop, because it still may
1396have the window system's input focus.) 1396have the window system's input focus.)
1397 1397
1398The specified @var{frame} becomes the selected frame, as explained 1398The specified @var{frame} becomes the selected frame, and its terminal
1399above, and the terminal that @var{frame} is on becomes the selected 1399becomes the selected terminal. This function then calls
1400terminal. The window selected within @var{frame} becomes the selected 1400@code{select-window} as a subroutine, passing the window selected
1401window. This function returns @var{frame}, or @code{nil} if @var{frame} 1401within @var{frame} as its first argument and @var{norecord} as its
1402has been deleted. 1402second argument (hence, if @var{norecord} is non-@code{nil}, this
1403avoids changing the order of recently selected windows nor the buffer
1404list). @xref{Selecting Windows}.
1403 1405
1404Optional argument @var{norecord} non-@code{nil} means to neither change 1406This function returns @var{frame}, or @code{nil} if @var{frame} has
1405the order of recently selected windows nor the buffer list. @xref{The 1407been deleted.
1406Buffer List}.
1407 1408
1408In general, you should never use @code{select-frame} in a way that could 1409In general, you should never use @code{select-frame} in a way that
1409switch to a different terminal without switching back when you're done. 1410could switch to a different terminal without switching back when
1411you're done.
1410@end defun 1412@end defun
1411 1413
1412Emacs cooperates with the window system by arranging to select frames as 1414Emacs cooperates with the window system by arranging to select frames as