When the user presses a mouse button and releases it at the same location, that generates a click event. Depending on how your window-system reports mouse-wheel events, turning the mouse wheel can generate either a mouse click or a mouse-wheel event. All mouse event share the same format:
(event-type position click-count)
This is a symbol that indicates which mouse button was used. It is
one of the symbols mouse-1
, …, where the
buttons are numbered left to right. For mouse-wheel event, it can be
You can also use prefixes ‘A-’, ‘C-’, ‘H-’, ‘M-’, ‘S-’ and ‘s-’ for modifiers alt, control, hyper, meta, shift and super, just as you would with function keys.
This symbol also serves as the event type of the event. Key bindings
describe events by their types; thus, if there is a key binding for
, that binding would apply to all events whose
event-type is mouse-1
This is a mouse position list specifying where the mouse event occurred; see below for details.
This is the number of rapid repeated presses so far of the same mouse button or the number of repeated turns of the wheel. See Repeat Events.
To access the contents of a mouse position list in the position slot of a mouse event, you should typically use the functions documented in Accessing Mouse Events.
The explicit format of the list depends on where the event occurred. For clicks in the text area, mode line, header line, tab line, or in the fringe or marginal areas, the mouse position list has the form
(window pos-or-area (x . y) timestamp object text-pos (col . row) image (dx . dy) (width . height))
The meanings of these list elements are as follows:
The window in which the mouse event occurred.
The buffer position of the character clicked on in the text area; or,
if the event was outside the text area, the window area where it
occurred. It is one of the symbols mode-line
In one special case, pos-or-area is a list containing a symbol (one of the symbols listed above) instead of just the symbol. This happens after the imaginary prefix keys for the event are registered by Emacs. See Key Sequence Input.
The relative pixel coordinates of the event. For events in the text
area of a window, the coordinate origin (0 . 0)
is taken to be
the top left corner of the text area. See Window Sizes. For
events in a mode line, header line or tab line, the coordinate origin
is the top left corner of the window itself. For fringes, margins,
and the vertical border, x does not have meaningful data.
For fringes and margins, y is relative to the bottom edge of the
header line. In all cases, the x and y coordinates
increase rightward and downward respectively.
The time at which the event occurred, as an integer number of milliseconds since a system-dependent initial time.
, which means the event occurred on buffer text, or a
cons cell of the form (string . string-pos) if there
is a string from a text property or an overlay at the event position.
The string which was clicked on, including any properties.
The position in the string where the click occurred.
For clicks on a marginal area or on a fringe, this is the buffer
position of the first visible character in the corresponding line in
the window. For clicks on the mode line, the header line or the tab
line, this is nil
. For other events, it is the buffer position
closest to the click.
These are the actual column and row coordinate numbers of the glyph under the x, y position. If x lies beyond the last column of actual text on its line, col is reported by adding fictional extra columns that have the default character width. Row 0 is taken to be the header line if the window has one, or Row 1 if the window also has the tab line, or the topmost row of the text area otherwise. Column 0 is taken to be the leftmost column of the text area for clicks on a window text area, or the leftmost mode line or header line column for clicks there. For clicks on fringes or vertical borders, these have no meaningful data. For clicks on margins, col is measured from the left edge of the margin area and row is measured from the top of the margin area.
If there is an image at the click location, this is the image object
as returned by find-image
(see Defining Images); otherwise
this is nil
These are the pixel offsets of the click relative to the top left
corner of the object’s glyph that is the nearest one to the
click. The relevant objects can be either a buffer, or a string,
or an image, see above. If object is nil
or a string,
the coordinates are relative to the top left corner of the character
glyph clicked on. Note that the offsets are always zero on text-mode
frames, when object is nil
, since each glyph there is
considered to have exactly 1x1 pixel dimensions.
If the click is on a character, either from buffer text or from overlay or display string, these are the pixel width and height of that character’s glyph; otherwise they are dimensions of object clicked on.
For clicks on a scroll bar, position has this form:
(window area (portion . whole) timestamp part)
The window whose scroll bar was clicked on.
This is the symbol vertical-scroll-bar
The number of pixels from the top of the scroll bar to the click
position. On some toolkits, including GTK+, Emacs cannot extract this
data, so the value is always 0
The total length, in pixels, of the scroll bar. On some toolkits,
including GTK+, Emacs cannot extract this data, so the value is always
The time at which the event occurred, in milliseconds. On some
toolkits, including GTK+, Emacs cannot extract this data, so the value
is always 0
The part of the scroll bar on which the click occurred. It is one of
the symbols handle
(the scroll bar handle), above-handle
(the area above the handle), below-handle
(the area below the
(the up arrow at one end of the scroll bar), or
(the down arrow at one end of the scroll bar).
(frame part (X . Y) timestamp)
The frame whose internal border or tool bar or tab bar was clicked on.
The part of the frame which was clicked on. This can be one of the following:
The frame has a tool bar, and the event was in the tool-bar area.
The frame has a tab bar, and the event was in the tab-bar area.
The click was on the corresponding border at an offset of at least one canonical character from the border’s nearest corner.
The click was on the corresponding corner of the internal border.
The frame does not have an internal border, and the event was not on
the tab bar or the tool bar. This usually happens on text-mode
frames. This can also happen on GUI frames with internal border if
the frame doesn’t have its drag-internal-border
(see Mouse Dragging Parameters) set to a non-nil