aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2025-03-15 10:04:01 +0200
committerEli Zaretskii2025-03-15 10:04:01 +0200
commit6e28c2019e772aa19040cf17e314fcee23bb33d4 (patch)
tree57a26bbe3b94ec29e69b1863622986ddb5af84d9
parente09cb3aee9a7dfb851d0470f30bd71426c3434bf (diff)
downloademacs-6e28c2019e772aa19040cf17e314fcee23bb33d4.tar.gz
emacs-6e28c2019e772aa19040cf17e314fcee23bb33d4.zip
; 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.
-rw-r--r--doc/lispref/commands.texi21
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 0a4a41818c3..13af0e93ade 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -1791,17 +1791,18 @@ handle), @code{up} (the up arrow at one end of the scroll bar), or
1791@c The 'top', 'bottom', and 'end-scroll' codes don't seem to be used. 1791@c The 'top', 'bottom', and 'end-scroll' codes don't seem to be used.
1792@end table 1792@end table
1793 1793
1794For clicks on the frame's internal border (@pxref{Frame Layout}), 1794For clicks on the frame's internal border (@pxref{Frame Layout}), the
1795the frame's tool bar (@pxref{Tool Bar}) or tab bar, @var{position} 1795frame's tool bar (@pxref{Tool Bar}) or tab bar or menu bar,
1796has this form: 1796@var{position} has this form:
1797 1797
1798@example 1798@example
1799 (@var{frame} @var{part} (@var{X} . @var{Y}) @var{timestamp}) 1799 (@var{frame} @var{part} (@var{X} . @var{Y}) @var{timestamp} @var{object})
1800@end example 1800@end example
1801 1801
1802@table @asis 1802@table @asis
1803@item @var{frame} 1803@item @var{frame}
1804The frame whose internal border or tool bar or tab bar was clicked on. 1804The frame whose internal border or tool bar or tab bar or menu bar was
1805clicked on.
1805 1806
1806@item @var{part} 1807@item @var{part}
1807The part of the frame which was clicked on. This can be one 1808The part of the frame which was clicked on. This can be one
@@ -1816,6 +1817,13 @@ The frame has a tool bar, and the event was in the tool-bar area.
1816@item tab-bar 1817@item tab-bar
1817The frame has a tab bar, and the event was in the tab-bar area. 1818The frame has a tab bar, and the event was in the tab-bar area.
1818 1819
1820@cindex menu-bar mouse events
1821@item menu-bar
1822The event was on the frame's menu bar area. This kind of click event
1823can happen only on text-only frames or on X frames in a non-toolkit
1824build of Emacs. (In toolkit builds of Emacs, menu-bar clicks are
1825handled by the toolkit, and are not visible to Emacs as click events.)
1826
1819@item left-edge 1827@item left-edge
1820@itemx top-edge 1828@itemx top-edge
1821@itemx right-edge 1829@itemx right-edge
@@ -1837,6 +1845,9 @@ the frame doesn't have its @code{drag-internal-border} parameter
1837(@pxref{Mouse Dragging Parameters}) set to a non-@code{nil} value. 1845(@pxref{Mouse Dragging Parameters}) set to a non-@code{nil} value.
1838@end table 1846@end table
1839 1847
1848@item @var{object}
1849This member is present only for clicks on the tab bar, and it is the
1850propertized string with information about the clicked button.
1840@end table 1851@end table
1841 1852
1842 1853