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
  • 14 hours ago
  • 6 years ago

Installs

  • Total 1K
  • Win 608
  • OS X 269
  • Linux 225
Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9
Windows 0 2 4 3 2 2 0 0 0 3 3 2 0 0 1 0 5 1 4 1 1 3 6 5 5 0 0 2 0 0 2 0 1 1 0 3 0 1 0 0 1 0 1 0 0 1
OS X 0 1 1 0 0 0 0 0 0 1 1 0 0 0 1 2 1 4 2 1 2 1 1 1 1 0 0 0 0 0 0 1 0 0 1 0 0 0 1 0 0 0 1 0 1 0
Linux 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 2 1 1 1 1 5 1 2 1 0 0 0 0 0 1 0 0 0 0 1 0 0 0 1 0 1 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.