Skip to content

Commit

Permalink
Updated API documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
orbitalquark committed Sep 5, 2022
1 parent a1249c9 commit 2c813d7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
4 changes: 1 addition & 3 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,16 +131,14 @@ Return:
* `sptr_t`

<a id="scintilla_send_mouse"></a>
#### `scintilla_send_mouse`(*sci, event, time, button, y, x, shift, ctrl, alt*)
#### `scintilla_send_mouse`(*sci, event, button, y, x, shift, ctrl, alt*)

Sends the specified mouse event to the given Scintilla window for processing.

Parameters:

* *`sci`*: The Scintilla window returned by `scintilla_new()`.
* *`event`*: (`int`) The mouse event (`SCM_CLICK`, `SCM_DRAG`, or `SCM_RELEASE`).
* *`time`*: (`unsigned int`) The time in milliseconds of the mouse event. This is only
needed if double and triple clicks need to be detected.
* *`button`*: (`int`) The button number pressed, or `0` if none.
* *`y`*: (`int`) The absolute y coordinate of the mouse event.
* *`x`*: (`int`) The absolute x coordinate of the mouse event.
Expand Down
4 changes: 1 addition & 3 deletions docs/scinterm.luadoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,14 @@ function scintilla_send_key(sci, key, shift, ctrl, alt) end
-- Sends the specified mouse event to the given Scintilla window for processing.
-- @param sci The Scintilla window returned by `scintilla_new()`.
-- @param event (`int`) The mouse event (`SCM_CLICK`, `SCM_DRAG`, or `SCM_RELEASE`).
-- @param time (`unsigned int`) The time in milliseconds of the mouse event. This is only
-- needed if double and triple clicks need to be detected.
-- @param button (`int`) The button number pressed, or `0` if none.
-- @param y (`int`) The absolute y coordinate of the mouse event.
-- @param x (`int`) The absolute x coordinate of the mouse event.
-- @param shift (`bool`) Flag indicating whether or not the shift modifier key is pressed.
-- @param ctrl (`bool`) Flag indicating whether or not the control modifier key is pressed.
-- @param alt (`bool`) Flag indicating whether or not the alt modifier key is pressed.
-- @return `bool` whether or not Scintilla handled the mouse event.
function scintilla_send_mouse(sci, event, time, button, y, x, shift, ctrl, alt) end
function scintilla_send_mouse(sci, event, button, y, x, shift, ctrl, alt) end

---
-- Returns a null-terminated copy of the text on Scintilla's internal clipboard (not the primary
Expand Down

0 comments on commit 2c813d7

Please sign in to comment.