aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorNoam Postavsky2019-06-25 22:04:13 -0400
committerNoam Postavsky2019-06-25 22:04:13 -0400
commit9552ee4df7d2ceebb8728a61d00598aa981b580c (patch)
tree5bd393a52f3f1b0510ff77fb2bd38e4a2c00ad8c /doc/lispref
parentc7a59d87b5726725cffa51a1f432f0961548dbe3 (diff)
parente62ad04963982ea9cc7622b32484778845bc2ec1 (diff)
downloademacs-9552ee4df7d2ceebb8728a61d00598aa981b580c.tar.gz
emacs-9552ee4df7d2ceebb8728a61d00598aa981b580c.zip
Merge from emacs-26
e62ad04963 Fix sgml-mode handling of quotes within parens (Bug#36347) 06b35b2f92 ; * lisp/frame.el: Enhance add-variable-watcher commentary. 572e34bb6f Rename 'make-symbolic-link' argument NEWNAME to LINKNAME 04477adedc Check that length of data returned by sysctl is non-zero 81535eeadb * test/lisp/progmodes/python-tests.el (python-virt-bin): D... 9d48979ca8 Fix Python tests depending on system-type fcf6cc3177 Fix problem with wdired test when symlinks cannot be created. 4701e0663e Improve wording of documentation of click events # Conflicts: # lisp/textmodes/sgml-mode.el # test/lisp/textmodes/sgml-mode-tests.el
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/commands.texi70
-rw-r--r--doc/lispref/files.texi8
2 files changed, 41 insertions, 37 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 5ea0be2667b..c0df944f9ce 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -1392,9 +1392,9 @@ The time at which the event occurred, as an integer number of
1392milliseconds since a system-dependent initial time. 1392milliseconds since a system-dependent initial time.
1393 1393
1394@item @var{object} 1394@item @var{object}
1395Either @code{nil} if there is no string-type text property at the 1395Either @code{nil}, which means the click occurred on buffer text, or a
1396click position, or a cons cell of the form (@var{string} 1396cons cell of the form @w{(@var{string} . @var{string-pos})} if there
1397. @var{string-pos}) if there is one: 1397is a string from a text property or an overlay at the click position.
1398 1398
1399@table @asis 1399@table @asis
1400@item @var{string} 1400@item @var{string}
@@ -1425,15 +1425,15 @@ clicks on margins, @var{col} is measured from the left edge of the
1425margin area and @var{row} is measured from the top of the margin area. 1425margin area and @var{row} is measured from the top of the margin area.
1426 1426
1427@item @var{image} 1427@item @var{image}
1428This is the image object on which the click occurred. It is either 1428If there is an image at the click location, this is the image object
1429@code{nil} if there is no image at the position clicked on, or it is 1429as returned by @code{find-image} (@pxref{Defining Images}); otherwise
1430an image object as returned by @code{find-image} if click was in an image. 1430this is @code{nil}.
1431 1431
1432@item @var{dx}, @var{dy} 1432@item @var{dx}, @var{dy}
1433These are the pixel coordinates of the click, relative to 1433These are the pixel coordinates of the click, relative to the top left
1434the top left corner of @var{object}, which is @code{(0 . 0)}. If 1434corner of @var{object}, which is @code{(0 . 0)}. If @var{object} is
1435@var{object} is @code{nil}, the coordinates are relative to the top 1435@code{nil}, which stands for a buffer, the coordinates are relative to
1436left corner of the character glyph clicked on. 1436the top left corner of the character glyph clicked on.
1437 1437
1438@item @var{width}, @var{height} 1438@item @var{width}, @var{height}
1439These are the pixel width and height of @var{object} or, if this is 1439These are the pixel width and height of @var{object} or, if this is
@@ -2035,8 +2035,8 @@ position such events have.
2035 2035
2036@defun posnp object 2036@defun posnp object
2037This function returns non-@code{nil} if @var{object} is a mouse 2037This function returns non-@code{nil} if @var{object} is a mouse
2038position list, in either of the formats documented in @ref{Click 2038position list, in the format documented in @ref{Click Events}); and
2039Events}); and @code{nil} otherwise. 2039@code{nil} otherwise.
2040@end defun 2040@end defun
2041 2041
2042@cindex mouse position list, accessing 2042@cindex mouse position list, accessing
@@ -2064,8 +2064,8 @@ is undefined.
2064 2064
2065@defun posn-x-y position 2065@defun posn-x-y position
2066Return the pixel-based x and y coordinates in @var{position}, as a 2066Return the pixel-based x and y coordinates in @var{position}, as a
2067cons cell @code{(@var{x} . @var{y})}. These coordinates are relative 2067cons cell @w{@code{(@var{x} . @var{y})}}. These coordinates are
2068to the window given by @code{posn-window}. 2068relative to the window given by @code{posn-window}.
2069 2069
2070This example shows how to convert the window-relative coordinates in 2070This example shows how to convert the window-relative coordinates in
2071the text area of a window into frame-relative coordinates: 2071the text area of a window into frame-relative coordinates:
@@ -2083,11 +2083,11 @@ POSITION is assumed to lie in a window text area."
2083@end defun 2083@end defun
2084 2084
2085@defun posn-col-row position 2085@defun posn-col-row position
2086This function returns a cons cell @code{(@var{col} . @var{row})}, 2086This function returns a cons cell @w{@code{(@var{col} . @var{row})}},
2087containing the estimated column and row corresponding to buffer 2087containing the estimated column and row corresponding to buffer
2088position in @var{position}. The return value is given in units of the 2088position described by @var{position}. The return value is given in
2089frame's default character width and default line height (including 2089units of the frame's default character width and default line height
2090spacing), as computed from the @var{x} and @var{y} values 2090(including spacing), as computed from the @var{x} and @var{y} values
2091corresponding to @var{position}. (So, if the actual characters have 2091corresponding to @var{position}. (So, if the actual characters have
2092non-default sizes, the actual row and column may differ from these 2092non-default sizes, the actual row and column may differ from these
2093computed values.) 2093computed values.)
@@ -2099,7 +2099,7 @@ Lines}), it is @emph{not} included in the @var{row} count.
2099 2099
2100@defun posn-actual-col-row position 2100@defun posn-actual-col-row position
2101Return the actual row and column in @var{position}, as a cons cell 2101Return the actual row and column in @var{position}, as a cons cell
2102@code{(@var{col} . @var{row})}. The values are the actual row and 2102@w{@code{(@var{col} . @var{row})}}. The values are the actual row and
2103column numbers in the window given by @var{position}. @xref{Click 2103column numbers in the window given by @var{position}. @xref{Click
2104Events}, for details. The function returns @code{nil} if 2104Events}, for details. The function returns @code{nil} if
2105@var{position} does not include actual position values; in that case 2105@var{position} does not include actual position values; in that case
@@ -2112,33 +2112,37 @@ character units, use @code{posn-col-row} instead.
2112@end defun 2112@end defun
2113 2113
2114@defun posn-string position 2114@defun posn-string position
2115Return the string object in @var{position}, either @code{nil}, or a 2115Return the string object described by @var{position}, either
2116cons cell @code{(@var{string} . @var{string-pos})}. 2116@code{nil} (which means @var{position} describes buffer text), or a
2117cons cell @w{@code{(@var{string} . @var{string-pos})}}.
2117@end defun 2118@end defun
2118 2119
2119@defun posn-image position 2120@defun posn-image position
2120Return the image object in @var{position}, either @code{nil}, or an 2121Return the image object in @var{position}, either @code{nil} (if
2121image @code{(image ...)}. 2122there's no image at @var{position}), or an image spec @w{@code{(image
2123@dots{})}}.
2122@end defun 2124@end defun
2123 2125
2124@defun posn-object position 2126@defun posn-object position
2125Return the image or string object in @var{position}, either 2127Return the image or string object described by @var{position}, either
2126@code{nil}, an image @code{(image ...)}, or a cons cell 2128@code{nil} (which means @var{position} describes buffer text), an
2127@code{(@var{string} . @var{string-pos})}. 2129image @w{@code{(image @dots{})}}, or a cons cell
2130@w{@code{(@var{string} . @var{string-pos})}}.
2128@end defun 2131@end defun
2129 2132
2130@defun posn-object-x-y position 2133@defun posn-object-x-y position
2131Return the pixel-based x and y coordinates relative to the upper left 2134Return the pixel-based x and y coordinates relative to the upper left
2132corner of the object in @var{position} as a cons cell @code{(@var{dx} 2135corner of the object described by @var{position}, as a cons cell
2133. @var{dy})}. If the @var{position} is on buffer text, return the 2136@w{@code{(@var{dx} . @var{dy})}}. If the @var{position} describes
2134relative position of the buffer-text character closest to that 2137buffer text, return the relative coordinates of the buffer-text character
2135position. 2138closest to that position.
2136@end defun 2139@end defun
2137 2140
2138@defun posn-object-width-height position 2141@defun posn-object-width-height position
2139Return the pixel width and height of the object in @var{position} as a 2142Return the pixel width and height of the object described by
2140cons cell @code{(@var{width} . @var{height})}. If the @var{position} 2143@var{position}, as a cons cell @code{(@var{width} . @var{height})}.
2141is a buffer position, return the size of the character at that position. 2144If the @var{position} describes a buffer position, return the size of
2145the character at that position.
2142@end defun 2146@end defun
2143 2147
2144@cindex timestamp of a mouse event 2148@cindex timestamp of a mouse event
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index af16b1cf4bc..66678d33915 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -1752,12 +1752,12 @@ default file permissions (see @code{set-default-file-modes} below), if
1752SELinux context are not copied over in either case. 1752SELinux context are not copied over in either case.
1753@end deffn 1753@end deffn
1754 1754
1755@deffn Command make-symbolic-link target newname &optional ok-if-already-exists 1755@deffn Command make-symbolic-link target linkname &optional ok-if-already-exists
1756@pindex ln 1756@pindex ln
1757@kindex file-already-exists 1757@kindex file-already-exists
1758This command makes a symbolic link to @var{target}, named 1758This command makes a symbolic link to @var{target}, named
1759@var{newname}. This is like the shell command @samp{ln -s 1759@var{linkname}. This is like the shell command @samp{ln -s
1760@var{target} @var{newname}}. The @var{target} argument 1760@var{target} @var{linkname}}. The @var{target} argument
1761is treated only as a string; it need not name an existing file. 1761is treated only as a string; it need not name an existing file.
1762If @var{ok-if-already-exists} is an integer, indicating interactive 1762If @var{ok-if-already-exists} is an integer, indicating interactive
1763use, then leading @samp{~} is expanded and leading @samp{/:} is 1763use, then leading @samp{~} is expanded and leading @samp{/:} is
@@ -1767,7 +1767,7 @@ If @var{target} is a relative file name, the resulting symbolic link
1767is interpreted relative to the directory containing the symbolic link. 1767is interpreted relative to the directory containing the symbolic link.
1768@xref{Relative File Names}. 1768@xref{Relative File Names}.
1769 1769
1770If both @var{target} and @var{newname} have remote file name syntax, 1770If both @var{target} and @var{linkname} have remote file name syntax,
1771and if both remote identifications are equal, the symbolic link points 1771and if both remote identifications are equal, the symbolic link points
1772to the local file name part of @var{target}. 1772to the local file name part of @var{target}.
1773 1773