diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/elisp/visibility-of-frames.html | |
new repository
Diffstat (limited to 'devdocs/elisp/visibility-of-frames.html')
| -rw-r--r-- | devdocs/elisp/visibility-of-frames.html | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/devdocs/elisp/visibility-of-frames.html b/devdocs/elisp/visibility-of-frames.html new file mode 100644 index 00000000..3ecf2f65 --- /dev/null +++ b/devdocs/elisp/visibility-of-frames.html @@ -0,0 +1,22 @@ + <h3 class="section">Visibility of Frames</h3> <p>A frame on a graphical display may be <em>visible</em>, <em>invisible</em>, or <em>iconified</em>. If it is visible, its contents are displayed in the usual manner. If it is iconified, its contents are not displayed, but there is a little icon somewhere to bring the frame back into view (some window managers refer to this state as <em>minimized</em> rather than <em>iconified</em>, but from Emacs’ point of view they are the same thing). If a frame is invisible, it is not displayed at all. </p> <p>The concept of visibility is strongly related to that of (un-)mapped frames. A frame (or, more precisely, its window-system window) is and becomes <em>mapped</em> when it is displayed for the first time and whenever it changes its state of visibility from <code>iconified</code> or <code>invisible</code> to <code>visible</code>. Conversely, a frame is and becomes <em>unmapped</em> whenever it changes its status from <code>visible</code> to <code>iconified</code> or <code>invisible</code>. </p> <p>Visibility is meaningless on text terminals, since only the selected frame is actually displayed in any case. </p> <dl> <dt id="frame-visible-p">Function: <strong>frame-visible-p</strong> <em>frame</em> +</dt> <dd> +<p>This function returns the visibility status of frame <var>frame</var>. The value is <code>t</code> if <var>frame</var> is visible, <code>nil</code> if it is invisible, and <code>icon</code> if it is iconified. </p> <p>On a text terminal, all frames are considered visible for the purposes of this function, even though only one frame is displayed. See <a href="raising-and-lowering">Raising and Lowering</a>. </p> +</dd> +</dl> <dl> <dt id="iconify-frame">Command: <strong>iconify-frame</strong> <em>&optional frame</em> +</dt> <dd><p>This function iconifies frame <var>frame</var>. If you omit <var>frame</var>, it iconifies the selected frame. This usually makes all child frames of <var>frame</var> (and their descendants) invisible (see <a href="child-frames">Child Frames</a>). </p></dd> +</dl> <dl> <dt id="make-frame-visible">Command: <strong>make-frame-visible</strong> <em>&optional frame</em> +</dt> <dd> +<p>This function makes frame <var>frame</var> visible. If you omit <var>frame</var>, it makes the selected frame visible. This does not raise the frame, but you can do that with <code>raise-frame</code> if you wish (see <a href="raising-and-lowering">Raising and Lowering</a>). </p> <p>Making a frame visible usually makes all its child frames (and their descendants) visible as well (see <a href="child-frames">Child Frames</a>). </p> +</dd> +</dl> <dl> <dt id="make-frame-invisible">Command: <strong>make-frame-invisible</strong> <em>&optional frame force</em> +</dt> <dd> +<p>This function makes frame <var>frame</var> invisible. If you omit <var>frame</var>, it makes the selected frame invisible. Usually, this makes all child frames of <var>frame</var> (and their descendants) invisible too (see <a href="child-frames">Child Frames</a>). </p> <p>Unless <var>force</var> is non-<code>nil</code>, this function refuses to make <var>frame</var> invisible if all other frames are invisible. </p> +</dd> +</dl> <p>The visibility status of a frame is also available as a frame parameter. You can read or change it as such. See <a href="management-parameters">Management Parameters</a>. The user can also iconify and deiconify frames with the window manager. This happens below the level at which Emacs can exert any control, but Emacs does provide events that you can use to keep track of such changes. See <a href="misc-events">Misc Events</a>. </p> <dl> <dt id="x-double-buffered-p">Function: <strong>x-double-buffered-p</strong> <em>&optional frame</em> +</dt> <dd><p>This function returns non-<code>nil</code> if <var>frame</var> is currently being rendered with double buffering. <var>frame</var> defaults to the selected frame. </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/Visibility-of-Frames.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Visibility-of-Frames.html</a> + </p> +</div> |
