From 415e4a502960db344f4169a87783adea6745f967 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 15 Mar 2025 10:04:01 +0200 Subject: [PATCH] ; Fix documentation of mouse-click events * 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 6e28c2019e772aa19040cf17e314fcee23bb33d4) --- doc/lispref/commands.texi | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 4f015467f74..7ea7c789a4a 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -1789,17 +1789,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 @@ -1814,6 +1815,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 @@ -1835,6 +1843,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 -- 2.39.5