diff options
Diffstat (limited to 'devdocs/elisp/fringe-indicators.html')
| -rw-r--r-- | devdocs/elisp/fringe-indicators.html | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/devdocs/elisp/fringe-indicators.html b/devdocs/elisp/fringe-indicators.html new file mode 100644 index 00000000..2eb2b31d --- /dev/null +++ b/devdocs/elisp/fringe-indicators.html @@ -0,0 +1,26 @@ + <h4 class="subsection">Fringe Indicators</h4> <p><em>Fringe indicators</em> are tiny icons displayed in the window fringe to indicate truncated or continued lines, buffer boundaries, etc. </p> <dl> <dt id="indicate-empty-lines">User Option: <strong>indicate-empty-lines</strong> +</dt> <dd> + <p>When this is non-<code>nil</code>, Emacs displays a special glyph in the fringe of each empty line at the end of the buffer, on graphical displays. See <a href="fringes">Fringes</a>. This variable is automatically buffer-local in every buffer. </p> +</dd> +</dl> <dl> <dt id="indicate-buffer-boundaries">User Option: <strong>indicate-buffer-boundaries</strong> +</dt> <dd> + <p>This buffer-local variable controls how the buffer boundaries and window scrolling are indicated in the window fringes. </p> <p>Emacs can indicate the buffer boundaries—that is, the first and last line in the buffer—with angle icons when they appear on the screen. In addition, Emacs can display an up-arrow in the fringe to show that there is text above the screen, and a down-arrow to show there is text below the screen. </p> <p>There are three kinds of basic values: </p> <dl compact> <dt><code>nil</code></dt> <dd><p>Don’t display any of these fringe icons. </p></dd> <dt><code>left</code></dt> <dd><p>Display the angle icons and arrows in the left fringe. </p></dd> <dt><code>right</code></dt> <dd><p>Display the angle icons and arrows in the right fringe. </p></dd> <dt>any non-alist</dt> <dd><p>Display the angle icons in the left fringe and don’t display the arrows. </p></dd> </dl> <p>Otherwise the value should be an alist that specifies which fringe indicators to display and where. Each element of the alist should have the form <code>(<var>indicator</var> . <var>position</var>)</code>. Here, <var>indicator</var> is one of <code>top</code>, <code>bottom</code>, <code>up</code>, <code>down</code>, and <code>t</code> (which covers all the icons not yet specified), while <var>position</var> is one of <code>left</code>, <code>right</code> and <code>nil</code>. </p> <p>For example, <code>((top . left) (t . right))</code> places the top angle bitmap in left fringe, and the bottom angle bitmap as well as both arrow bitmaps in right fringe. To show the angle bitmaps in the left fringe, and no arrow bitmaps, use <code>((top . left) (bottom . left))</code>. </p> +</dd> +</dl> <dl> <dt id="fringe-indicator-alist">Variable: <strong>fringe-indicator-alist</strong> +</dt> <dd> +<p>This buffer-local variable specifies the mapping from logical fringe indicators to the actual bitmaps displayed in the window fringes. The value is an alist of elements <code>(<var>indicator</var> +. <var>bitmaps</var>)</code>, where <var>indicator</var> specifies a logical indicator type and <var>bitmaps</var> specifies the fringe bitmaps to use for that indicator. </p> <p>Each <var>indicator</var> should be one of the following symbols: </p> <dl compact> <dt> +<code>truncation</code>, <code>continuation</code>.</dt> <dd> +<p>Used for truncation and continuation lines. </p> </dd> <dt> +<code>up</code>, <code>down</code>, <code>top</code>, <code>bottom</code>, <code>top-bottom</code> +</dt> <dd> +<p>Used when <code>indicate-buffer-boundaries</code> is non-<code>nil</code>: <code>up</code> and <code>down</code> indicate a buffer boundary lying above or below the window edge; <code>top</code> and <code>bottom</code> indicate the topmost and bottommost buffer text line; and <code>top-bottom</code> indicates where there is just one line of text in the buffer. </p> </dd> <dt><code>empty-line</code></dt> <dd> +<p>Used to indicate empty lines after the buffer end when <code>indicate-empty-lines</code> is non-<code>nil</code>. </p> </dd> <dt><code>overlay-arrow</code></dt> <dd><p>Used for overlay arrows (see <a href="overlay-arrow">Overlay Arrow</a>). </p></dd> </dl> <p>Each <var>bitmaps</var> value may be a list of symbols <code>(<var>left</var> +<var>right</var> [<var>left1</var> <var>right1</var>])</code>. The <var>left</var> and <var>right</var> symbols specify the bitmaps shown in the left and/or right fringe, for the specific indicator. <var>left1</var> and <var>right1</var> are specific to the <code>bottom</code> and <code>top-bottom</code> indicators, and are used to indicate that the last text line has no final newline. Alternatively, <var>bitmaps</var> may be a single symbol which is used in both left and right fringes. </p> <p>See <a href="fringe-bitmaps">Fringe Bitmaps</a>, for a list of standard bitmap symbols and how to define your own. In addition, <code>nil</code> represents the empty bitmap (i.e., an indicator that is not shown). </p> <p>When <code>fringe-indicator-alist</code> has a buffer-local value, and there is no bitmap defined for a logical indicator, or the bitmap is <code>t</code>, the corresponding value from the default value of <code>fringe-indicator-alist</code> is used. </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/Fringe-Indicators.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Fringe-Indicators.html</a> + </p> +</div> |