diff options
| author | Eli Zaretskii | 2015-12-11 10:46:18 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2015-12-11 10:46:18 +0200 |
| commit | 1db9d8bd0fb41bda3cc8027ec0cf27aade71b400 (patch) | |
| tree | fee1506360acc80212fa24fd2add5e93b94c480b | |
| parent | b3277c7d3913ccedfac36c27ab657901e4f131b4 (diff) | |
| download | emacs-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.texi | 18 | ||||
| -rw-r--r-- | src/frame.c | 11 |
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 |
| 1004 | This function alters the parameters of frame @var{frame} based on the | 1004 | This function alters the frame @var{frame} based on the elements of |
| 1005 | elements 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 |
| 1007 | parameter. If you don't mention a parameter in @var{alist}, its value | 1007 | a parameter. If you don't mention a parameter in @var{alist}, its |
| 1008 | doesn't change. If @var{frame} is @code{nil}, it defaults to the selected | 1008 | value doesn't change. If @var{frame} is @code{nil}, it defaults to |
| 1009 | frame. | 1009 | the selected frame. |
| 1010 | |||
| 1011 | Some parameters are only meaningful for frames on certain kinds of | ||
| 1012 | display (@pxref{Frames}). If @var{alist} includes parameters that are | ||
| 1013 | not meaningful for the @var{frame}'s display, this function will | ||
| 1014 | change its value in the frame's parameter list, but will otherwise | ||
| 1015 | ignore 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 | ||
| 2642 | DEFUN ("modify-frame-parameters", Fmodify_frame_parameters, | 2642 | DEFUN ("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. |
| 2645 | If FRAME is nil, it defaults to the selected frame. | 2645 | If FRAME is nil, it defaults to the selected frame. |
| 2646 | ALIST is an alist of parameters to change and their new values. | 2646 | ALIST is an alist of parameters to change and their new values. |
| 2647 | Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol. | 2647 | Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol. |
| 2648 | The meaningful PARMs depend on the kind of frame. | 2648 | Which PARMs are meaningful depends on the kind of frame. |
| 2649 | Undefined PARMs are ignored, but stored in the frame's parameter list | 2649 | The meaningful parameters are acted upon, i.e. the frame is changed |
| 2650 | so that `frame-parameters' will return them. | 2650 | according to their new values, and are also stored in the frame's |
| 2651 | parameter list so that `frame-parameters' will return them. | ||
| 2652 | PARMs that are not meaningful are still stored in the frame's parameter | ||
| 2653 | list, but are otherwise ignored. | ||
| 2651 | 2654 | ||
| 2652 | The value of frame parameter FOO can also be accessed | 2655 | The value of frame parameter FOO can also be accessed |
| 2653 | as a frame-local binding for the variable FOO, if you have | 2656 | as a frame-local binding for the variable FOO, if you have |