diff options
Diffstat (limited to 'devdocs/elisp/parameter-access.html')
| -rw-r--r-- | devdocs/elisp/parameter-access.html | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/devdocs/elisp/parameter-access.html b/devdocs/elisp/parameter-access.html new file mode 100644 index 00000000..207ac31a --- /dev/null +++ b/devdocs/elisp/parameter-access.html @@ -0,0 +1,18 @@ + <h4 class="subsection">Access to Frame Parameters</h4> <p>These functions let you read and change the parameter values of a frame. </p> <dl> <dt id="frame-parameter">Function: <strong>frame-parameter</strong> <em>frame parameter</em> +</dt> <dd><p>This function returns the value of the parameter <var>parameter</var> (a symbol) of <var>frame</var>. If <var>frame</var> is <code>nil</code>, it returns the selected frame’s parameter. If <var>frame</var> has no setting for <var>parameter</var>, this function returns <code>nil</code>. </p></dd> +</dl> <dl> <dt id="frame-parameters">Function: <strong>frame-parameters</strong> <em>&optional frame</em> +</dt> <dd><p>The function <code>frame-parameters</code> returns an alist listing all the parameters of <var>frame</var> and their values. If <var>frame</var> is <code>nil</code> or omitted, this returns the selected frame’s parameters </p></dd> +</dl> <dl> <dt id="modify-frame-parameters">Function: <strong>modify-frame-parameters</strong> <em>frame alist</em> +</dt> <dd> +<p>This function alters the frame <var>frame</var> based on the elements of <var>alist</var>. Each element of <var>alist</var> has the form <code>(<var>parm</var> . <var>value</var>)</code>, where <var>parm</var> is a symbol naming a parameter. If you don’t mention a parameter in <var>alist</var>, its value doesn’t change. If <var>frame</var> is <code>nil</code>, it defaults to the selected frame. </p> <p>Some parameters are only meaningful for frames on certain kinds of display (see <a href="frames">Frames</a>). If <var>alist</var> includes parameters that are not meaningful for the <var>frame</var>’s display, this function will change its value in the frame’s parameter list, but will otherwise ignore it. </p> <p>When <var>alist</var> specifies more than one parameter whose value can affect the new size of <var>frame</var>, the final size of the frame may differ according to the toolkit used. For example, specifying that a frame should from now on have a menu and/or tool bar instead of none and simultaneously specifying the new height of the frame will inevitably lead to a recalculation of the frame’s height. Conceptually, in such case, this function will try to have the explicit height specification prevail. It cannot be excluded, however, that the addition (or removal) of the menu or tool bar, when eventually performed by the toolkit, will defeat this intention. </p> <p>Sometimes, binding <code>frame-inhibit-implied-resize</code> (see <a href="implied-frame-resizing">Implied Frame Resizing</a>) to a non-<code>nil</code> value around calls to this function may fix the problem sketched here. Sometimes, however, exactly such binding may be hit by the problem. </p> +</dd> +</dl> <dl> <dt id="set-frame-parameter">Function: <strong>set-frame-parameter</strong> <em>frame parm value</em> +</dt> <dd><p>This function sets the frame parameter <var>parm</var> to the specified <var>value</var>. If <var>frame</var> is <code>nil</code>, it defaults to the selected frame. </p></dd> +</dl> <dl> <dt id="modify-all-frames-parameters">Function: <strong>modify-all-frames-parameters</strong> <em>alist</em> +</dt> <dd><p>This function alters the frame parameters of all existing frames according to <var>alist</var>, then modifies <code>default-frame-alist</code> (and, if necessary, <code>initial-frame-alist</code>) to apply the same parameter values to frames that will be created henceforth. </p></dd> +</dl><div class="_attribution"> + <p class="_attribution-p"> + Copyright © 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br> + <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Parameter-Access.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Parameter-Access.html</a> + </p> +</div> |