aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2015-12-11 10:46:18 +0200
committerEli Zaretskii2015-12-11 10:46:18 +0200
commit1db9d8bd0fb41bda3cc8027ec0cf27aade71b400 (patch)
treefee1506360acc80212fa24fd2add5e93b94c480b
parentb3277c7d3913ccedfac36c27ab657901e4f131b4 (diff)
downloademacs-1db9d8bd0fb41bda3cc8027ec0cf27aade71b400.tar.gz
emacs-1db9d8bd0fb41bda3cc8027ec0cf27aade71b400.zip
Clarify documentation of 'modify-frame-parameters'
* doc/lispref/frames.texi (Parameter Access): Clarify what "ignored PARMs" mean for 'modify-frame-parameters'. * src/frame.c (Fmodify_frame_parameters): Clarify what "ignored PARMs" mean for this function. (Bug#22104)
-rw-r--r--doc/lispref/frames.texi18
-rw-r--r--src/frame.c11
2 files changed, 19 insertions, 10 deletions
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 3c1a87a314f..b6f07200bfb 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -1001,12 +1001,18 @@ parameters of @var{frame} and their values. If @var{frame} is
1001@end defun 1001@end defun
1002 1002
1003@defun modify-frame-parameters frame alist 1003@defun modify-frame-parameters frame alist
1004This function alters the parameters of frame @var{frame} based on the 1004This function alters the frame @var{frame} based on the elements of
1005elements of @var{alist}. Each element of @var{alist} has the form 1005@var{alist}. Each element of @var{alist} has the form
1006@code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a 1006@code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming
1007parameter. If you don't mention a parameter in @var{alist}, its value 1007a parameter. If you don't mention a parameter in @var{alist}, its
1008doesn't change. If @var{frame} is @code{nil}, it defaults to the selected 1008value doesn't change. If @var{frame} is @code{nil}, it defaults to
1009frame. 1009the selected frame.
1010
1011Some parameters are only meaningful for frames on certain kinds of
1012display (@pxref{Frames}). If @var{alist} includes parameters that are
1013not meaningful for the @var{frame}'s display, this function will
1014change its value in the frame's parameter list, but will otherwise
1015ignore it.
1010@end defun 1016@end defun
1011 1017
1012@defun set-frame-parameter frame parm value 1018@defun set-frame-parameter frame parm value
diff --git a/src/frame.c b/src/frame.c
index c388986e351..4897052e1f9 100644
--- a/src/frame.c
+++ b/src/frame.c
@@ -2641,13 +2641,16 @@ If FRAME is nil, describe the currently selected frame. */)
2641 2641
2642DEFUN ("modify-frame-parameters", Fmodify_frame_parameters, 2642DEFUN ("modify-frame-parameters", Fmodify_frame_parameters,
2643 Smodify_frame_parameters, 2, 2, 0, 2643 Smodify_frame_parameters, 2, 2, 0,
2644 doc: /* Modify the parameters of frame FRAME according to ALIST. 2644 doc: /* Modify FRAME according to new values of its parameters in ALIST.
2645If FRAME is nil, it defaults to the selected frame. 2645If FRAME is nil, it defaults to the selected frame.
2646ALIST is an alist of parameters to change and their new values. 2646ALIST is an alist of parameters to change and their new values.
2647Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol. 2647Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.
2648The meaningful PARMs depend on the kind of frame. 2648Which PARMs are meaningful depends on the kind of frame.
2649Undefined PARMs are ignored, but stored in the frame's parameter list 2649The meaningful parameters are acted upon, i.e. the frame is changed
2650so that `frame-parameters' will return them. 2650according to their new values, and are also stored in the frame's
2651parameter list so that `frame-parameters' will return them.
2652PARMs that are not meaningful are still stored in the frame's parameter
2653list, but are otherwise ignored.
2651 2654
2652The value of frame parameter FOO can also be accessed 2655The value of frame parameter FOO can also be accessed
2653as a frame-local binding for the variable FOO, if you have 2656as a frame-local binding for the variable FOO, if you have