Variable: show-paren-context-when-offscreen

show-paren-context-when-offscreen is a customizable variable defined in paren.el.gz.

Value

nil

Documentation

If non-nil, show context around the opening paren if it is offscreen.

The context is usually the line that contains the openparen, except if the openparen is on its own line, in which case the context includes the previous nonblank line.

By default, the context is shown in the echo area.

If set to the symbol overlay, the context is shown in an overlay at the top-left of the window.

If set to the symbol child-frame, the context is shown in a child frame at the top-left of the window. You might want to customize the child-frame-border face (especially the background color) to give the child frame a distinguished border. On non-graphical frames, the context is shown in the echo area.

This variable was added, or its default value changed, in Emacs 29.1.

View in manual

Probably introduced at or before Emacs version 29.1.

Source Code

;; Defined in /usr/src/emacs/lisp/paren.el.gz
(defcustom show-paren-context-when-offscreen nil
  "If non-nil, show context around the opening paren if it is offscreen.
The context is usually the line that contains the openparen,
except if the openparen is on its own line, in which case the
context includes the previous nonblank line.

By default, the context is shown in the echo area.

If set to the symbol `overlay', the context is shown in an
overlay at the top-left of the window.

If set to the symbol `child-frame', the context is shown in a
child frame at the top-left of the window.  You might want to
customize the `child-frame-border' face (especially the
background color) to give the child frame a distinguished border.
On non-graphical frames, the context is shown in the echo area."
  :type '(choice (const :tag "Off" nil)
                 (const :tag "In echo area" t)
                 (const :tag "In overlay" overlay)
                 (const :tag "In child-frame" child-frame))
  :version "29.1")