Commit 87132570 authored by Martin Rudalics's avatar Martin Rudalics
Browse files

Fix some window code related doc-string and info entries.

* window.el (window-in-direction): Fix doc-string.
* windows.texi (Windows and Frames): Add some missing &optional
designators.  Adjust description of window-in-direction.
parent c60ed872
2014-03-04 Martin Rudalics <rudalics@gmx.at>
* windows.texi (Windows and Frames): Add some missing &optional
designators. Adjust description of window-in-direction.
2014-03-02 Barry O'Reilly <gundaetiapo@gmail.com> 2014-03-02 Barry O'Reilly <gundaetiapo@gmail.com>
* markers.texi (Moving Marker Positions): Clarify guidance about * markers.texi (Moving Marker Positions): Clarify guidance about
......
...@@ -137,7 +137,7 @@ window). ...@@ -137,7 +137,7 @@ window).
Each window belongs to exactly one frame (@pxref{Frames}). Each window belongs to exactly one frame (@pxref{Frames}).
@defun window-frame window @defun window-frame &optional window
This function returns the frame that the window @var{window} belongs This function returns the frame that the window @var{window} belongs
to. If @var{window} is @code{nil}, it defaults to the selected to. If @var{window} is @code{nil}, it defaults to the selected
window. window.
...@@ -257,14 +257,14 @@ window tree are @var{W2}, @var{W4}, and @var{W5}. ...@@ -257,14 +257,14 @@ window tree are @var{W2}, @var{W4}, and @var{W5}.
The following functions can be used to retrieve a child window of an The following functions can be used to retrieve a child window of an
internal window, and the siblings of a child window. internal window, and the siblings of a child window.
@defun window-top-child window @defun window-top-child &optional window
This function returns the topmost child window of @var{window}, if This function returns the topmost child window of @var{window}, if
@var{window} is an internal window whose children form a vertical @var{window} is an internal window whose children form a vertical
combination. For any other type of window, the return value is combination. For any other type of window, the return value is
@code{nil}. @code{nil}.
@end defun @end defun
@defun window-left-child window @defun window-left-child &optional window
This function returns the leftmost child window of @var{window}, if This function returns the leftmost child window of @var{window}, if
@var{window} is an internal window whose children form a horizontal @var{window} is an internal window whose children form a horizontal
combination. For any other type of window, the return value is combination. For any other type of window, the return value is
...@@ -322,7 +322,7 @@ the assumption that the frame from our canonical example is selected ...@@ -322,7 +322,7 @@ the assumption that the frame from our canonical example is selected
@end defun @end defun
@cindex window in direction @cindex window in direction
@defun window-in-direction direction &optional window ignore @defun window-in-direction direction &optional window ignore sign wrap mini
This function returns the nearest live window in direction This function returns the nearest live window in direction
@var{direction} as seen from the position of @code{window-point} in @var{direction} as seen from the position of @code{window-point} in
window @var{window}. The argument @var{direction} must be one of window @var{window}. The argument @var{direction} must be one of
...@@ -338,6 +338,23 @@ function tries to find another window in the indicated direction whose ...@@ -338,6 +338,23 @@ function tries to find another window in the indicated direction whose
argument @var{ignore} is non-@code{nil}, a window may be returned even argument @var{ignore} is non-@code{nil}, a window may be returned even
if its @code{no-other-window} parameter is non-@code{nil}. if its @code{no-other-window} parameter is non-@code{nil}.
If the optional argument @var{sign} is a negative number, it means to
use the right or bottom edge of @var{window} as reference position
instead of @code{window-point}. If @var{sign} is a positive number, it
means to use the left or top edge of @var{window} as reference position.
If the optional argument @var{wrap} is non-@code{nil}, this means to
wrap @var{direction} around frame borders. For example, if @var{window}
is at the top of the frame and @var{direction} is @code{above}, then
return the minibuffer window provided the frame has one, and a window at
the bottom of the frame otherwise.
If the optional argument @var{mini} is @code{nil}, this means to return
the minibuffer window if and only if it is currently active. If
@var{mini} is non-@code{nil}, it returns the minibuffer window even when
it's not active. However, if @var{wrap} non-@code{nil}, it always acts
as if @var{mini} were @code{nil}.
If it doesn't find a suitable window, this function returns @code{nil}. If it doesn't find a suitable window, this function returns @code{nil}.
@end defun @end defun
......
...@@ -196,6 +196,12 @@ content-type that is found in the new variable `image-format-suffixes'. ...@@ -196,6 +196,12 @@ content-type that is found in the new variable `image-format-suffixes'.
** Frame and window changes ** Frame and window changes
+++
*** The function `window-in-direction' introduced in Emacs 24.1 now
takes additional arguments for specifiying a reference point, wrapping
selection around frame borders, and specifying ways to select the
minibuffer window.
+++ +++
*** New commands `toggle-frame-fullscreen' and `toggle-frame-maximized', *** New commands `toggle-frame-fullscreen' and `toggle-frame-maximized',
bound to <f11> and M-<f10>, respectively. bound to <f11> and M-<f10>, respectively.
......
2014-03-04 Martin Rudalics <rudalics@gmx.at>
* window.el (window-in-direction): Fix doc-string.
2014-03-04 Glenn Morris <rgm@gnu.org> 2014-03-04 Glenn Morris <rgm@gnu.org>
* emacs-lisp/smie.el (smie-config-guess): Doc fix. * emacs-lisp/smie.el (smie-config-guess): Doc fix.
......
...@@ -1817,10 +1817,9 @@ or bottom edge of WINDOW as reference position instead of ...@@ -1817,10 +1817,9 @@ or bottom edge of WINDOW as reference position instead of
top edge of WINDOW as reference position. top edge of WINDOW as reference position.
Optional argument WRAP non-nil means to wrap DIRECTION around Optional argument WRAP non-nil means to wrap DIRECTION around
frame borders. This means to return for a WINDOW a the top of frame borders. This means to return for WINDOW at the top of the
the frame and DIRECTION `above' to return the minibuffer window frame and DIRECTION `above' the minibuffer window if the frame
if the frame has one, and a window at the bottom of the frame has one, and a window at the bottom of the frame otherwise.
otherwise.
Optional argument MINI nil means to return the minibuffer window Optional argument MINI nil means to return the minibuffer window
if and only if it is currently active. MINI non-nil means to if and only if it is currently active. MINI non-nil means to
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment