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

Mouse​Event​Listener

by SublimeText ST2/ST3

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

Details

  • 2016.04.27.02.28.57
  • github.​com
  • github.​com
  • 2 years ago
  • 9 minutes ago
  • 6 years ago

Installs

  • Total 1K
  • Win 818
  • OS X 345
  • Linux 316
Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1
Windows 0 2 0 1 0 1 2 5 3 0 0 1 2 2 1 2 3 0 0 0 1 2 1 2 0 2 1 2 2 3 0 1 0 1 3 0 0 0 0 1 2 6 0 3 1 0
OS X 1 0 1 0 0 0 0 1 0 0 1 0 1 0 2 0 2 2 0 1 1 2 0 0 0 1 0 0 2 0 1 0 0 0 1 1 0 1 1 0 0 1 0 1 1 1
Linux 0 1 0 0 1 1 2 0 0 2 0 0 1 1 1 0 1 0 0 0 1 0 2 0 1 0 0 1 1 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

MouseEventListener

MouseEventListener adds two new callbacks to Sublime Text 2'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://wbond.net/sublime_packages/package_control

As far as I know, Package Control does not handle dependencies, so if you depend on this package you may have to mention installing it in your install instructions.