diff options
| author | Martin Rudalics | 2008-11-21 10:20:14 +0000 |
|---|---|---|
| committer | Martin Rudalics | 2008-11-21 10:20:14 +0000 |
| commit | 6a4cfb0c8f7899643a4adc2c5b4a2c2ba802f950 (patch) | |
| tree | e781c2ed1e6562a54bf9ed7c85b80eb86c868cb4 | |
| parent | 4b65254d80f365d56f09efcdd7e601863b65bd56 (diff) | |
| download | emacs-6a4cfb0c8f7899643a4adc2c5b4a2c2ba802f950.tar.gz emacs-6a4cfb0c8f7899643a4adc2c5b4a2c2ba802f950.zip | |
(Frames): Fix typo, add cross references, reword.
(Initial Parameters): Reword special-display-frame-alist text.
(Frames and Windows): Reword. Describe argument norecord for
set-frame-selected-window.
(Input Focus): Describe argument norecord for select-frame.
Remove comment on MS-Windows behavior for focus-follows-mouse.
(Raising and Lowering): Mention windows-frames dichotomy in
metaphor.
| -rw-r--r-- | doc/lispref/ChangeLog | 9 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 84 | ||||
| -rw-r--r-- | etc/NEWS | 1 |
3 files changed, 56 insertions, 38 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 2f1f7cf52e3..666aa865df8 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,5 +1,14 @@ | |||
| 1 | 2008-11-21 Martin Rudalics <rudalics@gmx.at> | 1 | 2008-11-21 Martin Rudalics <rudalics@gmx.at> |
| 2 | 2 | ||
| 3 | * frames.texi (Frames): Fix typo, add cross references, reword. | ||
| 4 | (Initial Parameters): Reword special-display-frame-alist text. | ||
| 5 | (Frames and Windows): Reword. Describe argument norecord for | ||
| 6 | set-frame-selected-window. | ||
| 7 | (Input Focus): Describe argument norecord for select-frame. | ||
| 8 | Remove comment on MS-Windows behavior for focus-follows-mouse. | ||
| 9 | (Raising and Lowering): Mention windows-frames dichotomy in | ||
| 10 | metaphor. | ||
| 11 | |||
| 3 | * windows.texi (Displaying Buffers, Vertical Scrolling) | 12 | * windows.texi (Displaying Buffers, Vertical Scrolling) |
| 4 | (Horizontal Scrolling): Fix indenting and rewording issues | 13 | (Horizontal Scrolling): Fix indenting and rewording issues |
| 5 | introduced with 2008-11-07 change. | 14 | introduced with 2008-11-07 change. |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 192003b885e..463e4dd8b97 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -8,16 +8,16 @@ | |||
| 8 | @chapter Frames | 8 | @chapter Frames |
| 9 | @cindex frame | 9 | @cindex frame |
| 10 | 10 | ||
| 11 | In Emacs editing, A @dfn{frame} is a screen object that contains one | 11 | In Emacs editing, a @dfn{frame} is a screen object that contains one |
| 12 | or more Emacs windows. It's the kind of object that is called a | 12 | or more Emacs windows, see @ref{Windows}. It's the kind of object that |
| 13 | ``window'' in the terminology of graphical environments; but we can't | 13 | is called a ``window'' in the terminology of graphical environments; but |
| 14 | call it a ``window'' here, because Emacs uses that word in a different | 14 | we can't call it a ``window'' here, because Emacs uses that word in a |
| 15 | way. | 15 | different way. In Emacs Lisp, a @dfn{frame object} is a Lisp object |
| 16 | that represents a frame on the screen. | ||
| 16 | 17 | ||
| 17 | A frame initially contains a single main window and/or a minibuffer | 18 | A frame initially contains a single main window and/or a minibuffer |
| 18 | window; you can subdivide the main window vertically or horizontally | 19 | window; you can subdivide the main window vertically or horizontally |
| 19 | into smaller windows. In Emacs Lisp, a @dfn{frame object} is a Lisp | 20 | into smaller windows. @xref{Splitting Windows}. |
| 20 | object that represents a frame on the screen. | ||
| 21 | 21 | ||
| 22 | @cindex terminal frame | 22 | @cindex terminal frame |
| 23 | When Emacs runs on a text-only terminal, it starts with one | 23 | When Emacs runs on a text-only terminal, it starts with one |
| @@ -343,8 +343,9 @@ in many cases. | |||
| 343 | Setting this variable does not affect existing frames. | 343 | Setting this variable does not affect existing frames. |
| 344 | @end defvar | 344 | @end defvar |
| 345 | 345 | ||
| 346 | See also @code{special-display-frame-alist}. @xref{Definition of | 346 | Functions that display a buffer in a separate frame can override the |
| 347 | special-display-frame-alist}. | 347 | default parameters by supplying their own parameters. @xref{Definition |
| 348 | of special-display-frame-alist}. | ||
| 348 | 349 | ||
| 349 | If you use options that specify window appearance when you invoke Emacs, | 350 | If you use options that specify window appearance when you invoke Emacs, |
| 350 | they take effect by adding elements to @code{default-frame-alist}. One | 351 | they take effect by adding elements to @code{default-frame-alist}. One |
| @@ -1006,7 +1007,7 @@ the selected frame. | |||
| 1006 | 1007 | ||
| 1007 | A frame cannot be deleted if its minibuffer is used by other frames. | 1008 | A frame cannot be deleted if its minibuffer is used by other frames. |
| 1008 | Normally, you cannot delete a frame if all other frames are invisible, | 1009 | Normally, you cannot delete a frame if all other frames are invisible, |
| 1009 | but if the @var{force} is non-@code{nil}, then you are allowed to do so. | 1010 | but if @var{force} is non-@code{nil}, then you are allowed to do so. |
| 1010 | @end deffn | 1011 | @end deffn |
| 1011 | 1012 | ||
| 1012 | @defun frame-live-p frame | 1013 | @defun frame-live-p frame |
| @@ -1074,7 +1075,7 @@ Window Ordering}. | |||
| 1074 | @node Frames and Windows | 1075 | @node Frames and Windows |
| 1075 | @section Frames and Windows | 1076 | @section Frames and Windows |
| 1076 | 1077 | ||
| 1077 | Each window is part of one and only one frame; you can get the frame | 1078 | Each window is part of one and only one frame; you can get that frame |
| 1078 | with @code{window-frame}. | 1079 | with @code{window-frame}. |
| 1079 | 1080 | ||
| 1080 | @defun window-frame window | 1081 | @defun window-frame window |
| @@ -1094,8 +1095,9 @@ If omitted or @code{nil}, @var{frame} defaults to the selected frame. | |||
| 1094 | 1095 | ||
| 1095 | At any time, exactly one window on any frame is @dfn{selected within the | 1096 | At any time, exactly one window on any frame is @dfn{selected within the |
| 1096 | frame}. The significance of this designation is that selecting the | 1097 | frame}. The significance of this designation is that selecting the |
| 1097 | frame also selects this window. You can get the frame's current | 1098 | frame also selects this window. Conversely, selecting a window for |
| 1098 | selected window with @code{frame-selected-window}. | 1099 | Emacs with @code{select-window} also makes that window selected within |
| 1100 | its frame. @xref{Selecting Windows}. | ||
| 1099 | 1101 | ||
| 1100 | @defun frame-selected-window &optional frame | 1102 | @defun frame-selected-window &optional frame |
| 1101 | This function returns the window on @var{frame} that is selected | 1103 | This function returns the window on @var{frame} that is selected |
| @@ -1103,15 +1105,16 @@ within @var{frame}. If omitted or @code{nil}, @var{frame} defaults to | |||
| 1103 | the selected frame. | 1105 | the selected frame. |
| 1104 | @end defun | 1106 | @end defun |
| 1105 | 1107 | ||
| 1106 | @defun set-frame-selected-window frame window | 1108 | @defun set-frame-selected-window frame window &optional norecord |
| 1107 | This sets the selected window of frame @var{frame} to @var{window}. | 1109 | This sets the selected window of frame @var{frame} to @var{window}. |
| 1108 | If @var{frame} is @code{nil}, it operates on the selected frame. If | 1110 | If @var{frame} is @code{nil}, it operates on the selected frame. If |
| 1109 | @var{frame} is the selected frame, this makes @var{window} the | 1111 | @var{frame} is the selected frame, this makes @var{window} the |
| 1110 | selected window. This function returns @var{window}. | 1112 | selected window. This function returns @var{window}. |
| 1111 | @end defun | ||
| 1112 | 1113 | ||
| 1113 | Conversely, selecting a window for Emacs with @code{select-window} also | 1114 | Optional argument @var{norecord} non-@code{nil} means to neither change |
| 1114 | makes that window selected within its frame. @xref{Selecting Windows}. | 1115 | the order of recently selected windows nor the buffer list (@pxref{The |
| 1116 | Buffer List}). | ||
| 1117 | @end defun | ||
| 1115 | 1118 | ||
| 1116 | Another function that (usually) returns one of the windows in a given | 1119 | Another function that (usually) returns one of the windows in a given |
| 1117 | frame is @code{minibuffer-window}. @xref{Definition of minibuffer-window}. | 1120 | frame is @code{minibuffer-window}. @xref{Definition of minibuffer-window}. |
| @@ -1158,7 +1161,7 @@ runs a command that came from a certain terminal, the selected frame is | |||
| 1158 | the one of that terminal. Since Emacs runs only a single command at any | 1161 | the one of that terminal. Since Emacs runs only a single command at any |
| 1159 | given time, it needs to consider only one selected frame at a time; this | 1162 | given time, it needs to consider only one selected frame at a time; this |
| 1160 | frame is what we call @dfn{the selected frame} in this manual. The | 1163 | frame is what we call @dfn{the selected frame} in this manual. The |
| 1161 | display on which the selected frame is displayed is the @dfn{selected | 1164 | display on which the selected frame is shown is the @dfn{selected |
| 1162 | frame's display}. | 1165 | frame's display}. |
| 1163 | 1166 | ||
| 1164 | @defun selected-frame | 1167 | @defun selected-frame |
| @@ -1169,7 +1172,7 @@ Some window systems and window managers direct keyboard input to the | |||
| 1169 | window object that the mouse is in; others require explicit clicks or | 1172 | window object that the mouse is in; others require explicit clicks or |
| 1170 | commands to @dfn{shift the focus} to various window objects. Either | 1173 | commands to @dfn{shift the focus} to various window objects. Either |
| 1171 | way, Emacs automatically keeps track of which frame has the focus. To | 1174 | way, Emacs automatically keeps track of which frame has the focus. To |
| 1172 | switch to a different frame from a Lisp function, call | 1175 | explicitly switch to a different frame from a Lisp function, call |
| 1173 | @code{select-frame-set-input-focus}. | 1176 | @code{select-frame-set-input-focus}. |
| 1174 | 1177 | ||
| 1175 | Lisp programs can also switch frames ``temporarily'' by calling the | 1178 | Lisp programs can also switch frames ``temporarily'' by calling the |
| @@ -1180,31 +1183,37 @@ until that control is somehow reasserted. | |||
| 1180 | When using a text-only terminal, only one frame can be displayed at a | 1183 | When using a text-only terminal, only one frame can be displayed at a |
| 1181 | time on the terminal, so after a call to @code{select-frame}, the next | 1184 | time on the terminal, so after a call to @code{select-frame}, the next |
| 1182 | redisplay actually displays the newly selected frame. This frame | 1185 | redisplay actually displays the newly selected frame. This frame |
| 1183 | remains selected until a subsequent call to @code{select-frame} or | 1186 | remains selected until a subsequent call to @code{select-frame}. Each |
| 1184 | @code{select-frame-set-input-focus}. Each terminal frame has a number | 1187 | terminal frame has a number which appears in the mode line before the |
| 1185 | which appears in the mode line before the buffer name (@pxref{Mode | 1188 | buffer name (@pxref{Mode Line Variables}). |
| 1186 | Line Variables}). | ||
| 1187 | 1189 | ||
| 1188 | @defun select-frame-set-input-focus frame | 1190 | @defun select-frame-set-input-focus frame |
| 1189 | This function makes @var{frame} the selected frame, raises it (should | 1191 | This function selects @var{frame}, raises it (should it happen to be |
| 1190 | it happen to be obscured by other frames) and tries to give it the X | 1192 | obscured by other frames) and tries to give it the X server's focus. On |
| 1191 | server's focus. On a text-only terminal, the next redisplay displays | 1193 | a text-only terminal, the next redisplay displays the new frame on the |
| 1192 | the new frame on the entire terminal screen. The return value of this | 1194 | entire terminal screen. The return value of this function is not |
| 1193 | function is not significant. | 1195 | significant. |
| 1194 | @end defun | 1196 | @end defun |
| 1195 | 1197 | ||
| 1196 | @c ??? This is not yet implemented properly. | 1198 | @c ??? This is not yet implemented properly. |
| 1197 | @defun select-frame frame | 1199 | @defun select-frame frame &optional norecord |
| 1198 | This function selects frame @var{frame}, temporarily disregarding the | 1200 | This function selects frame @var{frame}, temporarily disregarding the |
| 1199 | focus of the X server if any. The selection of @var{frame} lasts until | 1201 | focus of the X server if any. The selection of @var{frame} lasts until |
| 1200 | the next time the user does something to select a different frame, or | 1202 | the next time the user does something to select a different frame, or |
| 1201 | until the next time this function is called. (If you are using a | 1203 | until the next time this function is called. (If you are using a |
| 1202 | window system, the previously selected frame may be restored as the | 1204 | window system, the previously selected frame may be restored as the |
| 1203 | selected frame after return to the command loop, because it still may | 1205 | selected frame after return to the command loop, because it still may |
| 1204 | have the window system's input focus.) The specified @var{frame} | 1206 | have the window system's input focus.) |
| 1205 | becomes the selected frame, as explained above, and the terminal that | 1207 | |
| 1206 | @var{frame} is on becomes the selected terminal. This function | 1208 | The specified @var{frame} becomes the selected frame, as explained |
| 1207 | returns @var{frame}, or @code{nil} if @var{frame} has been deleted. | 1209 | above, and the terminal that @var{frame} is on becomes the selected |
| 1210 | terminal. The window selected within @var{frame} becomes the selected | ||
| 1211 | window. This function returns @var{frame}, or @code{nil} if @var{frame} | ||
| 1212 | has been deleted. | ||
| 1213 | |||
| 1214 | Optional argument @var{norecord} non-@code{nil} means to neither change | ||
| 1215 | the order of recently selected windows nor the buffer list. @xref{The | ||
| 1216 | Buffer List}. | ||
| 1208 | 1217 | ||
| 1209 | In general, you should never use @code{select-frame} in a way that could | 1218 | In general, you should never use @code{select-frame} in a way that could |
| 1210 | switch to a different terminal without switching back when you're done. | 1219 | switch to a different terminal without switching back when you're done. |
| @@ -1258,9 +1267,7 @@ change it. | |||
| 1258 | This option is how you inform Emacs whether the window manager transfers | 1267 | This option is how you inform Emacs whether the window manager transfers |
| 1259 | focus when the user moves the mouse. Non-@code{nil} says that it does. | 1268 | focus when the user moves the mouse. Non-@code{nil} says that it does. |
| 1260 | When this is so, the command @code{other-frame} moves the mouse to a | 1269 | When this is so, the command @code{other-frame} moves the mouse to a |
| 1261 | position consistent with the new selected frame. (This option has no | 1270 | position consistent with the new selected frame. |
| 1262 | effect on MS-Windows, where the mouse pointer is always automatically | ||
| 1263 | moved by the OS to the selected frame.) | ||
| 1264 | @end defopt | 1271 | @end defopt |
| 1265 | 1272 | ||
| 1266 | @node Visibility of Frames | 1273 | @node Visibility of Frames |
| @@ -1337,7 +1344,8 @@ moving it to the bottom of the stack. This motion is in the notional | |||
| 1337 | third dimension only, and does not change the position of the window | 1344 | third dimension only, and does not change the position of the window |
| 1338 | on the screen. | 1345 | on the screen. |
| 1339 | 1346 | ||
| 1340 | You can raise and lower Emacs frame Windows with these functions: | 1347 | With Emacs, frames constitute the windows in the metaphor sketched |
| 1348 | above. You can raise and lower frames using these functions: | ||
| 1341 | 1349 | ||
| 1342 | @deffn Command raise-frame &optional frame | 1350 | @deffn Command raise-frame &optional frame |
| 1343 | This function raises frame @var{frame} (default, the selected frame). | 1351 | This function raises frame @var{frame} (default, the selected frame). |
| @@ -1399,7 +1407,7 @@ button. | |||
| 1399 | 1407 | ||
| 1400 | @defspec track-mouse body@dots{} | 1408 | @defspec track-mouse body@dots{} |
| 1401 | This special form executes @var{body}, with generation of mouse motion | 1409 | This special form executes @var{body}, with generation of mouse motion |
| 1402 | events enabled. Typically @var{body} would use @code{read-event} to | 1410 | events enabled. Typically, @var{body} would use @code{read-event} to |
| 1403 | read the motion events and modify the display accordingly. @xref{Motion | 1411 | read the motion events and modify the display accordingly. @xref{Motion |
| 1404 | Events}, for the format of mouse motion events. | 1412 | Events}, for the format of mouse motion events. |
| 1405 | 1413 | ||
| @@ -1260,6 +1260,7 @@ to override the default splitting mechanism of display-buffer. | |||
| 1260 | *** If pop-up-frames has the value `graphic-only', display-buffer only | 1260 | *** If pop-up-frames has the value `graphic-only', display-buffer only |
| 1261 | makes a separate frame on graphic displays. | 1261 | makes a separate frame on graphic displays. |
| 1262 | 1262 | ||
| 1263 | +++ | ||
| 1263 | *** select-frame and set-frame-selected-window have new optional | 1264 | *** select-frame and set-frame-selected-window have new optional |
| 1264 | argument NORECORD. If non-nil, this will avoid messing with the order | 1265 | argument NORECORD. If non-nil, this will avoid messing with the order |
| 1265 | of recently selected windows and the buffer list. | 1266 | of recently selected windows and the buffer list. |