51.3 Annotation Properties

Function: annotation-glyph annotation

This function returns the glyph object used to display annotation.

Function: set-annotation-glyph annotation glyph &optional layout side

This function sets the glyph of annotation to glyph, which should be a glyph object. If layout is non-nil, set the layout policy of annotation to layout. If side is left or right, change the side of the buffer at which the annotation is displayed to the given side. The new value of annotation-glyph is returned.

Function: annotation-down-glyph annotation

This function returns the glyph used to display annotation when the left mouse button is depressed on the annotation.

Function: set-annotation-down-glyph annotation glyph

This function returns the glyph used to display annotation when the left mouse button is depressed on the annotation to glyph, which should be a glyph object.

Function: annotation-face annotation

This function returns the face associated with annotation.

Function: set-annotation-face annotation face

This function sets the face associated with annotation to face.

Function: annotation-layout annotation

This function returns the layout policy of annotation.

Function: set-annotation-layout annotation layout

This function sets the layout policy of annotation to layout.

Function: annotation-side annotation

This function returns the side of the buffer that annotation is displayed on. Return value is a symbol, either left or right.

Function: annotation-data annotation

This function returns the data associated with annotation.

Function: set-annotation-data annotation data

This function sets the data field of annotation to data. data is returned.

Function: annotation-action annotation

This function returns the action associated with annotation.

Function: set-annotation-action annotation action

This function sets the action field of annotation to action. action is returned..

Function: annotation-menu annotation

This function returns the menu associated with annotation.

Function: set-annotation-menu annotation menu

This function sets the menu associated with annotation to menu. This menu will be displayed when the right mouse button is pressed over the annotation.

Function: annotation-visible annotation

This function returns t if there is enough available space to display annotation, nil otherwise.

Function: annotation-width annotation

This function returns the width of annotation in pixels.

Function: hide-annotation annotation

This function removes annotation’s glyph, making it invisible.

Function: reveal-annotation annotation

This function restores annotation’s glyph, making it visible.