File: pulse.el.html
Manage temporary pulsing of faces and overlays.
This is a temporal decoration technique where something is to be highlighted briefly. This adds a gentle pulsing style to the text decorated this way.
The following are useful entry points:
pulse-tick - Cause pulse-highlight-face to shift toward background color.
Assumes you are using a version of Emacs that supports pulsing.
pulse-momentary-highlight-one-line - Pulse a single line at POINT.
pulse-momentary-highlight-region - Pulse a region.
pulse-momentary-highlight-overlay - Pulse an overlay.
These three functions will just blink the specified area if
the version of Emacs you are using doesn't support pulsing.
pulse-line-hook-function - A simple function that can be used in a
hook that will pulse whatever line the cursor is on.
Defined variables (7)
pulse-delay | Delay between face lightening iterations. |
pulse-face-duration | Time (in seconds) used for ‘pulse-faces’ duration. |
pulse-flag | Whether to use pulsing for momentary highlighting. |
pulse-iterations | Number of iterations in a pulse operation. |
pulse-momentary-iteration | The current pulsing iteration. |
pulse-momentary-overlay | The current pulsing overlay. |
pulse-momentary-timer | The current pulsing timer. |
Defined functions (9)
pulse-available-p | () |
pulse-faces | (FACES &optional WITH-FACE) |
pulse-line-hook-function | () |
pulse-momentary-highlight-one-line | (&optional POINT FACE) |
pulse-momentary-highlight-overlay | (O &optional FACE) |
pulse-momentary-highlight-region | (START END &optional FACE) |
pulse-momentary-unhighlight | () |
pulse-reset-face | (&optional FACE) |
pulse-tick | (COLORS STOP-TIME) |
Defined faces (2)
pulse-highlight-face | Face used during a pulse for display. *DO NOT CUSTOMIZE* Face used for temporary highlighting of tags for effect. |
pulse-highlight-start-face | Face used at beginning of a highlight. |