elisp: Customizing Bitmaps
37.13.5 Customizing Fringe Bitmaps
----------------------------------
-- Function: define-fringe-bitmap bitmap bits &optional height width
align
This function defines the symbol BITMAP as a new fringe bitmap, or
replaces an existing bitmap with that name.
The argument BITS specifies the image to use. It should be either
a string or a vector of integers, where each element (an integer)
corresponds to one row of the bitmap. Each bit of an integer
corresponds to one pixel of the bitmap, where the low bit
corresponds to the rightmost pixel of the bitmap.
The height is normally the length of BITS. However, you can
specify a different height with non-‘nil’ HEIGHT. The width is
normally 8, but you can specify a different width with non-‘nil’
WIDTH. The width must be an integer between 1 and 16.
The argument ALIGN specifies the positioning of the bitmap relative
to the range of rows where it is used; the default is to center the
bitmap. The allowed values are ‘top’, ‘center’, or ‘bottom’.
The ALIGN argument may also be a list ‘(ALIGN PERIODIC)’ where
ALIGN is interpreted as described above. If PERIODIC is non-‘nil’,
it specifies that the rows in ‘bits’ should be repeated enough
times to reach the specified height.
-- Function: destroy-fringe-bitmap bitmap
This function destroy the fringe bitmap identified by BITMAP. If
BITMAP identifies a standard fringe bitmap, it actually restores
the standard definition of that bitmap, instead of eliminating it
entirely.
-- Function: set-fringe-bitmap-face bitmap &optional face
This sets the face for the fringe bitmap BITMAP to FACE. If FACE
is ‘nil’, it selects the ‘fringe’ face. The bitmap’s face controls
the color to draw it in.
FACE is merged with the ‘fringe’ face, so normally FACE should
specify only the foreground color.
Info Catalog
elisp: Fringe Bitmaps
elisp: Fringes
elisp: Overlay Arrow