summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2024-02-24 21:31:48 +0100
committerSébastien Helleu <flashcode@flashtux.org>2024-03-06 20:33:17 +0100
commit5c88ee9c45411ae22b16d66d92c48323546aa761 (patch)
treec2ea0182c4c759c387aa8ebdffc9c4cca299e759 /doc/en
parenta8a005321181df14f78f1213c3d8e20e9b59090d (diff)
downloadweechat-5c88ee9c45411ae22b16d66d92c48323546aa761.zip
core: add support of SGR mouse events, remove option weechat.look.mouse_timer_delay (closes #2082)
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat_dev.en.adoc2
-rw-r--r--doc/en/weechat_user.en.adoc28
2 files changed, 21 insertions, 9 deletions
diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc
index 6df5daccd..67372c50e 100644
--- a/doc/en/weechat_dev.en.adoc
+++ b/doc/en/weechat_dev.en.adoc
@@ -443,6 +443,8 @@ WeeChat "core" is located in following directories:
|          test-gui-key.cpp | Tests: keys.
|          test-gui-line.cpp | Tests: lines.
|          test-gui-nick.cpp | Tests: nicks.
+|          curses/ | Root of unit tests for Curses interface.
+|             test-gui-curses-mouse.cpp | Tests: mouse (Curses interface).
|       plugins/ | Root of unit tests for plugins.
|          irc/ | Root of unit tests for IRC plugin.
|             test-irc-batch.cpp | Tests: IRC batched events.
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index 4d896c30b..41e402d9c 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -2679,27 +2679,37 @@ You can change or add bindings with the command `/key` using context "mouse"
Event name consists of a modifier (optional), a button/wheel name and a gesture
(optional). Different elements are separated by `+-+`.
-List of modifiers:
+List of modifiers (by order in the event name):
[width="100%",cols="1m,4",options="header"]
|===
| Modifier | Description
| alt | Key kbd:[Alt]
| ctrl | Key kbd:[Ctrl]
-| alt-ctrl | Keys kbd:[Alt] + kbd:[Ctrl]
+| shift | Key kbd:[Shift] ^(1)^
|===
+[NOTE]
+^(1)^ The `shift` modifier can rarely be used in WeeChat because many terminals
+use this modifier to catch directly mouse events.
+
+Several modifiers can be combined, for example:
+
+* `alt-ctrl`
+* `ctrl-shift`
+* `alt-ctrl-shift`
+
List of buttons/wheel:
[width="100%",cols="1m,4",options="header"]
|===
-| Button/wheel | Description
-| button1 | Click on left button
-| button2 | Click on right button
-| button3 | Click on middle button (often click on wheel)
-| button4 ... button9 | Click on extra buttons
-| wheelup | Wheel (up)
-| wheeldown | Wheel (down)
+| Button/wheel | Description
+| button1 | Click on left button
+| button2 | Click on right button
+| button3 | Click on middle button (often click on wheel)
+| button4 ... button11 | Click on extra buttons
+| wheelup | Wheel (up)
+| wheeldown | Wheel (down)
|===
List of gestures (only for buttons, not wheel):