summaryrefslogtreecommitdiff
path: root/devdocs/elisp/minibuffer-misc.html
blob: f73f6c85fb7c0e4e204b677247c00ed472722df3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 <h3 class="section">Minibuffer Miscellany</h3> <dl> <dt id="minibufferp">Function: <strong>minibufferp</strong> <em>&amp;optional buffer-or-name live</em>
</dt> <dd><p>This function returns non-<code>nil</code> if <var>buffer-or-name</var> is a minibuffer. If <var>buffer-or-name</var> is omitted or <code>nil</code>, it tests the current buffer. When <var>live</var> is non-<code>nil</code>, the function returns non-<code>nil</code> only when <var>buffer-or-name</var> is an active minibuffer. </p></dd>
</dl> <dl> <dt id="minibuffer-setup-hook">Variable: <strong>minibuffer-setup-hook</strong>
</dt> <dd><p>This is a normal hook that is run whenever a minibuffer is entered. See <a href="hooks">Hooks</a>. </p></dd>
</dl> <dl> <dt id="minibuffer-with-setup-hook">Macro: <strong>minibuffer-with-setup-hook</strong> <em>function &amp;rest body</em>
</dt> <dd>
<p>This macro executes <var>body</var> after arranging for the specified <var>function</var> to be called via <code>minibuffer-setup-hook</code>. By default, <var>function</var> is called before the other functions in the <code>minibuffer-setup-hook</code> list, but if <var>function</var> is of the form <code>(:append <var>func</var>)</code>, <var>func</var> will be called <em>after</em> the other hook functions. </p> <p>The <var>body</var> forms should not use the minibuffer more than once. If the minibuffer is re-entered recursively, <var>function</var> will only be called once, for the outermost use of the minibuffer. </p>
</dd>
</dl> <dl> <dt id="minibuffer-exit-hook">Variable: <strong>minibuffer-exit-hook</strong>
</dt> <dd><p>This is a normal hook that is run whenever a minibuffer is exited. See <a href="hooks">Hooks</a>. </p></dd>
</dl> <dl> <dt id="minibuffer-help-form">Variable: <strong>minibuffer-help-form</strong>
</dt> <dd>
<p>The current value of this variable is used to rebind <code>help-form</code> locally inside the minibuffer (see <a href="help-functions">Help Functions</a>). </p>
</dd>
</dl> <dl> <dt id="minibuffer-scroll-window">Variable: <strong>minibuffer-scroll-window</strong>
</dt> <dd>
<p>If the value of this variable is non-<code>nil</code>, it should be a window object. When the function <code>scroll-other-window</code> is called in the minibuffer, it scrolls this window (see <a href="textual-scrolling">Textual Scrolling</a>). </p>
</dd>
</dl> <dl> <dt id="minibuffer-selected-window">Function: <strong>minibuffer-selected-window</strong>
</dt> <dd><p>This function returns the window that was selected just before the minibuffer window was selected. If the selected window is not a minibuffer window, it returns <code>nil</code>. </p></dd>
</dl>  <dl> <dt id="minibuffer-message">Function: <strong>minibuffer-message</strong> <em>string &amp;rest args</em>
</dt> <dd><p>This function displays <var>string</var> temporarily at the end of the minibuffer text, for a few seconds, or until the next input event arrives, whichever comes first. The variable <code>minibuffer-message-timeout</code> specifies the number of seconds to wait in the absence of input. It defaults to 2. If <var>args</var> is non-<code>nil</code>, the actual message is obtained by passing <var>string</var> and <var>args</var> through <code>format-message</code>. See <a href="formatting-strings">Formatting Strings</a>. </p></dd>
</dl> <dl> <dt id="minibuffer-inactive-mode">Command: <strong>minibuffer-inactive-mode</strong>
</dt> <dd><p>This is the major mode used in inactive minibuffers. It uses keymap <code>minibuffer-inactive-mode-map</code>. This can be useful if the minibuffer is in a separate frame. See <a href="minibuffers-and-frames">Minibuffers and Frames</a>. </p></dd>
</dl><div class="_attribution">
  <p class="_attribution-p">
    Copyright &copy; 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/Minibuffer-Misc.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Minibuffer-Misc.html</a>
  </p>
</div>