github/zyedidia.micro
2
0
Fork 0
mirror of https://github.com/zyedidia/micro.git synced 2026-02-05 06:30:28 +09:00
Code Issues Packages Projects Releases Wiki Activity

help: Document passing *tcell.EventMouse to mouse action callbacks

Browse Source
This commit is contained in:
Dmytro Maluka
2025-07-05 17:16:15 +02:00
parent c267c7c9aa
commit 0694cd2c1b
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
runtime/help/plugins.md
View File

@@ -76,10 +76,19 @@ that micro defines:
chained with other actions (see `> help keybindings`) to determine whether
the next actions in the chain should be executed or not.
If the action is a mouse action, e.g. `MousePress`, the mouse event info
is passed to the callback as an extra argument of type `*tcell.EventMouse`.
See https://pkg.go.dev/github.com/micro-editor/tcell/v2#EventMouse for the
description of this type and its methods.
* `preAction(bufpane)`: runs immediately before `Action` is triggered
by the user. Returns a boolean which defines whether the action should
be canceled.
Similarly to `onAction`, if the action is a mouse action, the mouse event
info is passed to the callback as an extra argument of type
`*tcell.EventMouse`.
* `onRune(bufpane, rune)`: runs when the composed rune has been inserted
* `preRune(bufpane, rune)`: runs before the composed rune will be inserted