diff options
| author | Chong Yidong | 2012-01-28 12:26:33 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-01-28 12:26:33 +0800 |
| commit | 9583ec5948d36c34ec382e9e276c02e72b53eb37 (patch) | |
| tree | afff255914426b4f667de0fd2fb9340ecf7ef972 /doc | |
| parent | 691db2504df5e19784170ac81ee975a99e6d4dc1 (diff) | |
| download | emacs-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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 3 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 34 |
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 @@ | |||
| 1 | 2012-01-28 Chong Yidong <cyd@gnu.org> | 1 | 2012-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 | |||
| 1377 | terminal frame has a number which appears in the mode line before the | 1377 | terminal frame has a number which appears in the mode line before the |
| 1378 | buffer name (@pxref{Mode Line Variables}). | 1378 | buffer 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 |
| 1381 | This function selects @var{frame}, raises it (should it happen to be | 1381 | This function selects @var{frame}, raises it (should it happen to be |
| 1382 | obscured by other frames) and tries to give it the X server's focus. On | 1382 | obscured by other frames) and tries to give it the X server's focus. |
| 1383 | a text-only terminal, the next redisplay displays the new frame on the | 1383 | On a text-only terminal, the next redisplay displays the new frame on |
| 1384 | entire terminal screen. The return value of this function is not | 1384 | the entire terminal screen. The optional argument @var{norecord} has |
| 1385 | significant. | 1385 | the same meaning as for @code{select-frame} (see below). The return |
| 1386 | value 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 |
| 1390 | This function selects frame @var{frame}, temporarily disregarding the | 1390 | This function selects frame @var{frame}, temporarily disregarding the |
| 1391 | focus of the X server if any. The selection of @var{frame} lasts until | 1391 | focus 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 | |||
| 1395 | selected frame after return to the command loop, because it still may | 1395 | selected frame after return to the command loop, because it still may |
| 1396 | have the window system's input focus.) | 1396 | have the window system's input focus.) |
| 1397 | 1397 | ||
| 1398 | The specified @var{frame} becomes the selected frame, as explained | 1398 | The specified @var{frame} becomes the selected frame, and its terminal |
| 1399 | above, and the terminal that @var{frame} is on becomes the selected | 1399 | becomes the selected terminal. This function then calls |
| 1400 | terminal. The window selected within @var{frame} becomes the selected | 1400 | @code{select-window} as a subroutine, passing the window selected |
| 1401 | window. This function returns @var{frame}, or @code{nil} if @var{frame} | 1401 | within @var{frame} as its first argument and @var{norecord} as its |
| 1402 | has been deleted. | 1402 | second argument (hence, if @var{norecord} is non-@code{nil}, this |
| 1403 | avoids changing the order of recently selected windows nor the buffer | ||
| 1404 | list). @xref{Selecting Windows}. | ||
| 1403 | 1405 | ||
| 1404 | Optional argument @var{norecord} non-@code{nil} means to neither change | 1406 | This function returns @var{frame}, or @code{nil} if @var{frame} has |
| 1405 | the order of recently selected windows nor the buffer list. @xref{The | 1407 | been deleted. |
| 1406 | Buffer List}. | ||
| 1407 | 1408 | ||
| 1408 | In general, you should never use @code{select-frame} in a way that could | 1409 | In general, you should never use @code{select-frame} in a way that |
| 1409 | switch to a different terminal without switching back when you're done. | 1410 | could switch to a different terminal without switching back when |
| 1411 | you're done. | ||
| 1410 | @end defun | 1412 | @end defun |
| 1411 | 1413 | ||
| 1412 | Emacs cooperates with the window system by arranging to select frames as | 1414 | Emacs cooperates with the window system by arranging to select frames as |