File: reveal.el.html
Reveal mode is a minor mode that makes sure that text around point
is always visible. When point enters a region of hidden text,
reveal-mode(var)/reveal-mode(fun) temporarily makes it visible.
Overlays can also use the display property. For them to be
revealed, the reveal-toggle-invisible property also has to be
present, and should be a function to toggle between having a
display property and not.
This is normally used in conjunction with outline-minor-mode(var)/outline-minor-mode(fun),
hs-minor-mode(var)/hs-minor-mode(fun), hide-ifdef-mode(var)/hide-ifdef-mode(fun), ...
It only works with packages that hide text using overlays.
Packages can provide special support for it by placing
a function in the reveal-toggle-invisible property on the symbol
used as the value of the invisible overlay property.
The function is called right after revealing (or re-hiding) the
text with two arguments: the overlay and a boolean that's non-nil
if we have just revealed the text. When revealing, that function
may re-hide some of the text.
Defined variables (7)
global-reveal-mode | Non-nil if Global Reveal mode is enabled. |
global-reveal-mode-hook | Hook run after entering or leaving ‘global-reveal-mode’. |
reveal-around-mark | Reveal text around the mark, if active. |
reveal-auto-hide | Automatically hide revealed text when leaving it. |
reveal-mode | Non-nil if Reveal mode is enabled. |
reveal-mode-hook | Hook run after entering or leaving ‘reveal-mode’. |
reveal-open-spots | List of spots in the buffer which are open. |
Defined functions (5)
global-reveal-mode | (&optional ARG) |
reveal-close-old-overlays | (OLD-OLS) |
reveal-hide-revealed | () |
reveal-mode | (&optional ARG) |
reveal-open-new-overlays | (OLD-OLS) |