aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2021-05-30 00:20:02 -0400
committerGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2021-05-30 00:20:02 -0400
commit6611ae9268b509d56ff76759eb6ad16367140afc (patch)
tree5688a21fc472a3ba0758b8708d7e9dc9aad49d14
parent31c1f746622bf0c6415d640c5b060f0dd6ae481a (diff)
Updated LuaDoc.
-rw-r--r--core/events.lua5
-rw-r--r--docs/api.md7
-rw-r--r--modules/lua/ta_api6
3 files changed, 15 insertions, 3 deletions
diff --git a/core/events.lua b/core/events.lua
index d9b263d4..52b1dc37 100644
--- a/core/events.lua
+++ b/core/events.lua
@@ -159,6 +159,11 @@ local M = {}
-- Arguments:
--
-- * _`position`_: The clicked text's position.
+-- * _`modifiers`_: A bit-mask of any modifier keys held down: `view.MOD_CTRL`,
+-- `view.MOD_SHIFT`, `view.MOD_ALT`, and `view.MOD_META`. On macOS, the Command modifier
+-- key is reported as `view.MOD_CTRL` and Ctrl is `view.MOD_META`. Note: If you set
+-- `view.rectangular_selection_modifier` to `view.MOD_CTRL`, the "Control" modifier is
+-- reported as *both* "Control" and "Alt" due to a Scintilla limitation with GTK.
-- @field INITIALIZED (string)
-- Emitted after Textadept finishes initializing.
-- @field KEYPRESS (string)
diff --git a/docs/api.md b/docs/api.md
index 2975e1f1..2806ab74 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -3870,6 +3870,11 @@ Emitted when releasing the mouse after clicking on text that has an indicator pr
Arguments:
* _`position`_: The clicked text's position.
+ * _`modifiers`_: A bit-mask of any modifier keys held down: `view.MOD_CTRL`,
+ `view.MOD_SHIFT`, `view.MOD_ALT`, and `view.MOD_META`. On macOS, the Command modifier
+ key is reported as `view.MOD_CTRL` and Ctrl is `view.MOD_META`. Note: If you set
+ `view.rectangular_selection_modifier` to `view.MOD_CTRL`, the "Control" modifier is
+ reported as *both* "Control" and "Alt" due to a Scintilla limitation with GTK.
<a id="events.INITIALIZED"></a>
#### `events.INITIALIZED` (string)
@@ -9701,6 +9706,7 @@ The long line mark mode.
Table of flags for UI element identifiers that indicate whether or not an element supports
translucent colors.
+ See [`view.element_color`](#view.element_color) for element identifiers.
<a id="view.element_base_color"></a>
#### `view.element_base_color` (table, read-only)
@@ -9749,6 +9755,7 @@ Table of colors in "0xAABBGGRR" format for UI element identifiers.
Table of flags for UI element identifiers that indicate whether or not a color has been
manually set.
+ See [`view.element_color`](#view.element_color) for element identifiers.
<a id="view.end_at_last_line"></a>
#### `view.end_at_last_line` (bool)
diff --git a/modules/lua/ta_api b/modules/lua/ta_api
index b313f73b..aff4acbc 100644
--- a/modules/lua/ta_api
+++ b/modules/lua/ta_api
@@ -100,7 +100,7 @@ FUNCTION lexer.FUNCTION (string)\nThe token name for function tokens.
IDENTIFIER lexer.IDENTIFIER (string)\nThe token name for identifier tokens.
INDICATOR_CLICK events.INDICATOR_CLICK (string)\nEmitted when clicking the mouse on text that has an indicator present.\nArguments:\n\n* _`position`_: The clicked text's position.\n* _`modifiers`_: A bit-mask of any modifier keys held down: `view.MOD_CTRL`,\n `view.MOD_SHIFT`, `view.MOD_ALT`, and `view.MOD_META`. On macOS, the Command modifier\n key is reported as `view.MOD_CTRL` and Ctrl is `view.MOD_META`. Note: If you set\n `view.rectangular_selection_modifier` to `view.MOD_CTRL`, the "Control" modifier is\n reported as *both* "Control" and "Alt" due to a Scintilla limitation with GTK.
INDICATOR_MAX buffer.INDICATOR_MAX (number, Read-only)\n
-INDICATOR_RELEASE events.INDICATOR_RELEASE (string)\nEmitted when releasing the mouse after clicking on text that has an indicator present.\nArguments:\n\n* _`position`_: The clicked text's position.
+INDICATOR_RELEASE events.INDICATOR_RELEASE (string)\nEmitted when releasing the mouse after clicking on text that has an indicator present.\nArguments:\n\n* _`position`_: The clicked text's position.\n* _`modifiers`_: A bit-mask of any modifier keys held down: `view.MOD_CTRL`,\n `view.MOD_SHIFT`, `view.MOD_ALT`, and `view.MOD_META`. On macOS, the Command modifier\n key is reported as `view.MOD_CTRL` and Ctrl is `view.MOD_META`. Note: If you set\n `view.rectangular_selection_modifier` to `view.MOD_CTRL`, the "Control" modifier is\n reported as *both* "Control" and "Alt" due to a Scintilla limitation with GTK.
INDIC_BOX view.INDIC_BOX (number, Read-only)\n
INDIC_BRACEMATCH textadept.editing.INDIC_BRACEMATCH (number)\nThe matching brace highlight indicator number.
INDIC_COMPOSITIONTHICK view.INDIC_COMPOSITIONTHICK (number, Read-only)\n
@@ -477,10 +477,10 @@ edge_mode view.edge_mode (number)\nThe long line mark mode.\n\n* `view.EDGE_NONE
edit_toggle_overtype buffer.edit_toggle_overtype(buffer)\nToggles `buffer.overtype`.\n@param buffer A buffer.
editing textadept.editing (module)\nEditing features for Textadept.
editing_keys ui.command_entry.editing_keys (table)\nA metatable with typical platform-specific key bindings for text entries.\nThis metatable may be used to add basic editing and movement keys to command entry modes. It\nis automatically added to command entry modes unless a metatable was previously set.
-element_allows_translucent view.element_allows_translucent (table)\nTable of flags for UI element identifiers that indicate whether or not an element supports\ntranslucent colors.
+element_allows_translucent view.element_allows_translucent (table)\nTable of flags for UI element identifiers that indicate whether or not an element supports\ntranslucent colors.\nSee `view.element_color` for element identifiers.
element_base_color view.element_base_color (table, read-only)\nTable of default colors on "0xAABBGGRR" format for UI element identifiers.\nIf the alpha byte is omitted, it is assumed to be `0xFF` (opaque).\nSee `view.element_color` for element identifiers.
element_color view.element_color (table)\nTable of colors in "0xAABBGGRR" format for UI element identifiers.\nIf the alpha byte is omitted, it is assumed to be `0xFF` (opaque).\n\n* `view.ELEMENT_SELECTION_TEXT`\n The main selection's text color.\n* `view.ELEMENT_SELECTION_BACK`\n The main selection's background color.\n* `view.ELEMENT_SELECTION_ADDITIONAL_TEXT`\n The text color of additional selections.\n* `view.ELEMENT_SELECTION_ADDITIONAL_BACK`\n The background color of additional selections.\n* `view.ELEMENT_SELECTION_SECONDARY_TEXT`\n The text color of selections when another window contains the primary selection.\n This is only available on Linux.\n* `view.ELEMENT_SELECTION_SECONDARY_BACK`\n The background color of selections when another window contains the primary selection.\n This is only available on Linux.\n* `view.ELEMENT_SELECTION_INACTIVE_TEXT`\n The text color of selections when another window has focus.\n* `view.ELEMENT_SELECTION_INACTIVE_BACK`\n The background color of selections when another window has focus.\n* `view.ELEMENT_CARET`\n The main selection's caret color.\n* `view.ELEMENT_CARET_ADDITIONAL`\n The caret color of additional selections.\n* `view.ELEMENT_CARET_LINE_BACK`\n The background color of the line that contains the caret.\n* `view.ELEMENT_WHITE_SPACE`\n The color of visible whitespace.\n* `view.ELEMENT_WHITE_SPACE_BACK`\n The background color of visible whitespace.
-element_is_set view.element_is_set (table)\nTable of flags for UI element identifiers that indicate whether or not a color has been\nmanually set.
+element_is_set view.element_is_set (table)\nTable of flags for UI element identifiers that indicate whether or not a color has been\nmanually set.\nSee `view.element_color` for element identifiers.
embed lexer.embed(lexer, child, start_rule, end_rule)\nEmbeds child lexer *child* in parent lexer *lexer* using patterns *start_rule* and *end_rule*,\nwhich signal the beginning and end of the embedded lexer, respectively.\n@param lexer The parent lexer.\n@param child The child lexer.\n@param start_rule The pattern that signals the beginning of the embedded lexer.\n@param end_rule The pattern that signals the end of the embedded lexer.\n@usage html:embed(css, css_start_rule, css_end_rule)\n@usage html:embed(lex, php_start_rule, php_end_rule) -- from php lexer
emit events.emit(event, ...)\nSequentially calls all handler functions for event *event* with the given arguments.\n*event* may be any arbitrary string and does not need to have been previously defined. If\nany handler explicitly returns a value that is not `nil`, `emit()` returns that value and\nceases to call subsequent handlers. This is useful for stopping the propagation of an event\nlike a keypress after it has been handled, or for passing back values from handlers.\n@param event The string event name.\n@param ... Arguments passed to the handler.\n@usage events.emit('my_event', 'my message')\n@return `nil` unless any any handler explicitly returned a non-`nil` value; otherwise returns\n that value
empty_undo_buffer buffer.empty_undo_buffer(buffer)\nDeletes the undo and redo history.\n@param buffer A buffer.