aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJared Finder2020-10-04 00:01:23 -0700
committerEli Zaretskii2020-10-31 09:59:16 +0200
commita105db13e11fd15cc72804bf33672122d1c3f2e1 (patch)
treeb484c7d9383f02e7755cda3797cd82f21ca8da09
parent2a6337a6c4dd00fbe00298bcec48a53a6faf87eb (diff)
downloademacs-a105db13e11fd15cc72804bf33672122d1c3f2e1.tar.gz
emacs-a105db13e11fd15cc72804bf33672122d1c3f2e1.zip
Updating docs with all special window prefix keys.
* doc/lispref/commands.texi (Key Sequence Input): Add documentation for missing special window areas. Explicitly call out window or frame.
-rw-r--r--doc/lispref/commands.texi18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 8959175def8..85bd2c1ed9b 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -2516,8 +2516,14 @@ with any other events.
2516@cindex @code{vertical-scroll-bar} prefix key 2516@cindex @code{vertical-scroll-bar} prefix key
2517@cindex @code{menu-bar} prefix key 2517@cindex @code{menu-bar} prefix key
2518@cindex @code{tab-bar} prefix key 2518@cindex @code{tab-bar} prefix key
2519@cindex mouse events, in special parts of frame 2519@cindex @code{left-margin} prefix key
2520When mouse events occur in special parts of a window, such as a mode 2520@cindex @code{right-margin} prefix key
2521@cindex @code{left-fringe} prefix key
2522@cindex @code{right-fringe} prefix key
2523@cindex @code{right-divider} prefix key
2524@cindex @code{bottom-divider} prefix key
2525@cindex mouse events, in special parts of window or frame
2526When mouse events occur in special parts of a window or frame, such as a mode
2521line or a scroll bar, the event type shows nothing special---it is the 2527line or a scroll bar, the event type shows nothing special---it is the
2522same symbol that would normally represent that combination of mouse 2528same symbol that would normally represent that combination of mouse
2523button and modifier keys. The information about the window part is kept 2529button and modifier keys. The information about the window part is kept
@@ -2525,9 +2531,11 @@ elsewhere in the event---in the coordinates. But
2525@code{read-key-sequence} translates this information into imaginary 2531@code{read-key-sequence} translates this information into imaginary
2526prefix keys, all of which are symbols: @code{tab-line}, @code{header-line}, 2532prefix keys, all of which are symbols: @code{tab-line}, @code{header-line},
2527@code{horizontal-scroll-bar}, @code{menu-bar}, @code{tab-bar}, @code{mode-line}, 2533@code{horizontal-scroll-bar}, @code{menu-bar}, @code{tab-bar}, @code{mode-line},
2528@code{vertical-line}, and @code{vertical-scroll-bar}. You can define 2534@code{vertical-line}, @code{vertical-scroll-bar}, @code{left-margin},
2529meanings for mouse clicks in special window parts by defining key 2535@code{right-margin}, @code{left-fringe}, @code{right-fringe},
2530sequences using these imaginary prefix keys. 2536@code{right-divider}, and @code{bottom-divider}. You can define meanings for
2537mouse clicks in special window parts by defining key sequences using these
2538imaginary prefix keys.
2531 2539
2532For example, if you call @code{read-key-sequence} and then click the 2540For example, if you call @code{read-key-sequence} and then click the
2533mouse on the window's mode line, you get two events, like this: 2541mouse on the window's mode line, you get two events, like this: