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/cursor-parameters.html | |
new repository
Diffstat (limited to 'devdocs/elisp/cursor-parameters.html')
| -rw-r--r-- | devdocs/elisp/cursor-parameters.html | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/devdocs/elisp/cursor-parameters.html b/devdocs/elisp/cursor-parameters.html new file mode 100644 index 00000000..9b3a182f --- /dev/null +++ b/devdocs/elisp/cursor-parameters.html @@ -0,0 +1,19 @@ + <h4 class="subsubsection">Cursor Parameters</h4> <p>This frame parameter controls the way the cursor looks. </p> <dl compact> <dt><code>cursor-type</code></dt> <dd> +<p>How to display the cursor. Legitimate values are: </p> <dl compact> <dt><code>box</code></dt> <dd><p>Display a filled box. (This is the default.) </p></dd> <dt><code>(box . <var>size</var>)</code></dt> <dd><p>Display a filled box. However, display it as a hollow box if point is under masked image larger than <var>size</var> pixels in either dimension. </p></dd> <dt><code>hollow</code></dt> <dd><p>Display a hollow box. </p></dd> <dt><code>nil</code></dt> <dd><p>Don’t display a cursor. </p></dd> <dt><code>bar</code></dt> <dd><p>Display a vertical bar between characters. </p></dd> <dt><code>(bar . <var>width</var>)</code></dt> <dd><p>Display a vertical bar <var>width</var> pixels wide between characters. </p></dd> <dt><code>hbar</code></dt> <dd><p>Display a horizontal bar. </p></dd> <dt><code>(hbar . <var>height</var>)</code></dt> <dd><p>Display a horizontal bar <var>height</var> pixels high. </p></dd> </dl> </dd> </dl> <p>The <code>cursor-type</code> frame parameter may be overridden by the variables <code>cursor-type</code> and <code>cursor-in-non-selected-windows</code>: </p> <dl> <dt id="cursor-type">User Option: <strong>cursor-type</strong> +</dt> <dd><p>This buffer-local variable controls how the cursor looks in a selected window showing the buffer. If its value is <code>t</code>, that means to use the cursor specified by the <code>cursor-type</code> frame parameter. Otherwise, the value should be one of the cursor types listed above, and it overrides the <code>cursor-type</code> frame parameter. </p></dd> +</dl> <dl> <dt id="cursor-in-non-selected-windows">User Option: <strong>cursor-in-non-selected-windows</strong> +</dt> <dd><p>This buffer-local variable controls how the cursor looks in a window that is not selected. It supports the same values as the <code>cursor-type</code> frame parameter; also, <code>nil</code> means don’t display a cursor in nonselected windows, and <code>t</code> (the default) means use a standard modification of the usual cursor type (solid box becomes hollow box, and bar becomes a narrower bar). </p></dd> +</dl> <dl> <dt id="x-stretch-cursor">User Option: <strong>x-stretch-cursor</strong> +</dt> <dd> +<p>This variable controls the width of the block cursor displayed on extra-wide glyphs such as a tab or a stretch of white space. By default, the block cursor is only as wide as the font’s default character, and will not cover all of the width of the glyph under it if that glyph is extra-wide. A non-<code>nil</code> value of this variable means draw the block cursor as wide as the glyph under it. The default value is <code>nil</code>. </p> <p>This variable has no effect on text-mode frames, since the text-mode cursor is drawn by the terminal out of Emacs’s control. </p> +</dd> +</dl> <dl> <dt id="blink-cursor-alist">User Option: <strong>blink-cursor-alist</strong> +</dt> <dd> +<p>This variable specifies how to blink the cursor. Each element has the form <code>(<var>on-state</var> . <var>off-state</var>)</code>. Whenever the cursor type equals <var>on-state</var> (comparing using <code>equal</code>), the corresponding <var>off-state</var> specifies what the cursor looks like when it blinks off. Both <var>on-state</var> and <var>off-state</var> should be suitable values for the <code>cursor-type</code> frame parameter. </p> <p>There are various defaults for how to blink each type of cursor, if the type is not mentioned as an <var>on-state</var> here. Changes in this variable do not take effect immediately, only when you specify the <code>cursor-type</code> frame parameter. </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/Cursor-Parameters.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Cursor-Parameters.html</a> + </p> +</div> |
