25.5.4.3 Event Text Position Info

The following functions return information about the text (including the modeline) that a mouse event occurred over or near.

Function: event-over-text-area-p event

Given a mouse-motion, button-press, button-release, or misc-user event, this function returns t if the event is over the text area of a window. Otherwise, nil is returned. The modeline is not considered to be part of the text area.

Function: event-over-modeline-p event

Given a mouse-motion, button-press, button-release, or misc-user event, this function returns t if the event is over the modeline of a window. Otherwise, nil is returned.

Function: event-x event

This function returns the X position of the given mouse-motion, button-press, button-release, or misc-user event in characters. This is relative to the window the event occurred over.

Function: event-y event

This function returns the Y position of the given mouse-motion, button-press, button-release, or misc-user event in characters. This is relative to the window the event occurred over.

Function: event-point event

This function returns the character position of the given mouse-motion, button-press, button-release, or misc-user event. If the event did not occur over a window, or did not occur over text, then this returns nil. Otherwise, it returns an index into the buffer visible in the event’s window.

Function: event-closest-point event

This function returns the character position of the given mouse-motion, button-press, button-release, or misc-user event. If the event did not occur over a window or over text, it returns the closest point to the location of the event. If the Y pixel position overlaps a window and the X pixel position is to the left of that window, the closest point is the beginning of the line containing the Y position. If the Y pixel position overlaps a window and the X pixel position is to the right of that window, the closest point is the end of the line containing the Y position. If the Y pixel position is above a window, 0 is returned. If it is below a window, the value of (window-end) is returned.