ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Mouse​Event​Listener

by SublimeText ALL

Adds on_pre_click and on_post_click callbacks to Sublime Text's plugin API.

Details

  • 2024.11.24.20.57.04
  • github.​com
  • github.​com
  • 5 months ago
  • 29 minutes ago
  • 13 years ago

Installs

  • Total 3K
  • Win 2K
  • Mac 760
  • Linux 750
Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7
Windows 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 0 0 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 1 1 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 1 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

MouseEventListener

[!NOTE] Sublime Text build 4149 (stable: 4151, 2 August 2023) added support for the context key in mouse bindings.

If you used or want to use this package for the purpose of emulating such a context query, you should use the native functionality instead.

MouseEventListener adds two new callbacks to Sublime Text's plugin API:

  • on_pre_click({'event': {'x': screen_x, 'y': screen_y, 'button': button}})
  • on_post_click(text_point)

An important thing to note is that the selection is modified not once but twice in between on_pre_mouse_down and on_post_mouse_down—this is done to determine the text_point of the click, as Sublime Text 2 has no API to translate a screen x and y into a text_point other than by calling drag_select and seeing where the selection ends up.

A second important thing to note is that mouse-up currently cannot be captured using Sublime Text 2's API. Hopefully this will be added in the future. However, this means that drags cannot be detected! other than perhaps by carefully monitoring the selection as it changes and just guessing. Additionally, on_selection_modified fires on mouse up in most cases.

Install

This plugin is available through Package Control, which is available here:

http://packagecontol.io/sublime_packages/package_control

Package Control does not support support dependency chains among packages, so if you depend on this package, you have to mention installing it in your installation instructions.