procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Fix documentation of mouse-click events

Browse source 
* doc/lispref/commands.texi (Click Events): Add menu-bar events to
the description.  Add missing details about tab-bar click events.

(cherry picked from commit 6e28c2019e)
This commit is contained in:
Eli Zaretskii 2025-03-15 10:04:01 +02:00
parent defc55bb6f
commit 66ec9ae719
1 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/lispref/commands.texi
View file

@ -1792,17 +1792,18 @@ handle), @code{up} (the up arrow at one end of the scroll bar), or
@c The 'top', 'bottom', and 'end-scroll' codes don't seem to be used.
@end table
For clicks on the frame's internal border (@pxref{Frame Layout}),
the frame's tool bar (@pxref{Tool Bar}) or tab bar, @var{position}
has this form:
For clicks on the frame's internal border (@pxref{Frame Layout}), the
frame's tool bar (@pxref{Tool Bar}) or tab bar or menu bar,
@var{position} has this form:
@example
(@var{frame} @var{part} (@var{X} . @var{Y}) @var{timestamp})
(@var{frame} @var{part} (@var{X} . @var{Y}) @var{timestamp} @var{object})
@end example
@table @asis
@item @var{frame}
The frame whose internal border or tool bar or tab bar was clicked on.
The frame whose internal border or tool bar or tab bar or menu bar was
clicked on.
@item @var{part}
The part of the frame which was clicked on. This can be one
@ -1817,6 +1818,13 @@ The frame has a tool bar, and the event was in the tool-bar area.
@item tab-bar
The frame has a tab bar, and the event was in the tab-bar area.
@cindex menu-bar mouse events
@item menu-bar
The event was on the frame's menu bar area. This kind of click event
can happen only on text-only frames or on X frames in a non-toolkit
build of Emacs. (In toolkit builds of Emacs, menu-bar clicks are
handled by the toolkit, and are not visible to Emacs as click events.)
@item left-edge
@itemx top-edge
@itemx right-edge
@ -1838,6 +1846,9 @@ the frame doesn't have its @code{drag-internal-border} parameter
(@pxref{Mouse Dragging Parameters}) set to a non-@code{nil} value.
@end table
@item @var{object}
This member is present only for clicks on the tab bar, and it is the
propertized string with information about the clicked button.
@end table