aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJared Finder2020-10-04 00:01:23 -0700
committerEli Zaretskii2020-10-31 10:02:53 +0200
commit487aae38d4348ff98cfef170f3d08505399d3af0 (patch)
tree6f89b8fb143b530ea155387a74a20b7468a29308
parent1fc9de4b81ceacabef6aafe48ecaabaf76f34bb2 (diff)
downloademacs-487aae38d4348ff98cfef170f3d08505399d3af0.tar.gz
emacs-487aae38d4348ff98cfef170f3d08505399d3af0.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. (cherry picked from commit a105db13e11fd15cc72804bf33672122d1c3f2e1)
-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 aabaec256b4..d70c4d58ba6 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -2517,8 +2517,14 @@ with any other events.
2517@cindex @code{vertical-scroll-bar} prefix key 2517@cindex @code{vertical-scroll-bar} prefix key
2518@cindex @code{menu-bar} prefix key 2518@cindex @code{menu-bar} prefix key
2519@cindex @code{tab-bar} prefix key 2519@cindex @code{tab-bar} prefix key
2520@cindex mouse events, in special parts of frame 2520@cindex @code{left-margin} prefix key
2521When mouse events occur in special parts of a window, such as a mode 2521@cindex @code{right-margin} prefix key
2522@cindex @code{left-fringe} prefix key
2523@cindex @code{right-fringe} prefix key
2524@cindex @code{right-divider} prefix key
2525@cindex @code{bottom-divider} prefix key
2526@cindex mouse events, in special parts of window or frame
2527When mouse events occur in special parts of a window or frame, such as a mode
2522line or a scroll bar, the event type shows nothing special---it is the 2528line or a scroll bar, the event type shows nothing special---it is the
2523same symbol that would normally represent that combination of mouse 2529same symbol that would normally represent that combination of mouse
2524button and modifier keys. The information about the window part is kept 2530button and modifier keys. The information about the window part is kept
@@ -2526,9 +2532,11 @@ elsewhere in the event---in the coordinates. But
2526@code{read-key-sequence} translates this information into imaginary 2532@code{read-key-sequence} translates this information into imaginary
2527prefix keys, all of which are symbols: @code{tab-line}, @code{header-line}, 2533prefix keys, all of which are symbols: @code{tab-line}, @code{header-line},
2528@code{horizontal-scroll-bar}, @code{menu-bar}, @code{tab-bar}, @code{mode-line}, 2534@code{horizontal-scroll-bar}, @code{menu-bar}, @code{tab-bar}, @code{mode-line},
2529@code{vertical-line}, and @code{vertical-scroll-bar}. You can define 2535@code{vertical-line}, @code{vertical-scroll-bar}, @code{left-margin},
2530meanings for mouse clicks in special window parts by defining key 2536@code{right-margin}, @code{left-fringe}, @code{right-fringe},
2531sequences using these imaginary prefix keys. 2537@code{right-divider}, and @code{bottom-divider}. You can define meanings for
2538mouse clicks in special window parts by defining key sequences using these
2539imaginary prefix keys.
2532 2540
2533For example, if you call @code{read-key-sequence} and then click the 2541For example, if you call @code{read-key-sequence} and then click the
2534mouse on the window's mode line, you get two events, like this: 2542mouse on the window's mode line, you get two events, like this: