51.2 Annotation Primitives

Function: make-annotation glyph &optional position layout buffer with-event d-glyph rightp

This function creates a marginal annotation at position position in buffer. The annotation is displayed using glyph, which should be a glyph object or a string, and is positioned using layout policy layout. If position is nil, point is used. If layout is nil, whitespace is used. If buffer is nil, the current buffer is used.

If with-event is non-nil, then when an annotation is activated, the triggering event is passed as the second arg to the annotation function. If d-glyph is non-nil then it is used as the glyph that will be displayed when button1 is down. If rightp is non-nil then the glyph will be displayed on the right side of the buffer instead of the left.

The newly created annotation is returned.

Function: delete-annotation annotation

This function removes annotation from its buffer. This does not modify the buffer text.

Function: annotationp annotation

This function returns t if annotation is an annotation, nil otherwise.