diff options
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/lua/api | 29 | ||||
| -rw-r--r-- | modules/lua/tags | 11 |
2 files changed, 31 insertions, 9 deletions
diff --git a/modules/lua/api b/modules/lua/api index 903e3ebf..531b8e66 100644 --- a/modules/lua/api +++ b/modules/lua/api @@ -67,6 +67,7 @@ DWELL_END events.DWELL_END (string)\nEmitted after `DWELL_START` when the user m DWELL_START events.DWELL_START (string)\nEmitted when the mouse is stationary for `buffer.mouse_dwell_time`\nmilliseconds.\nArguments:\n\n* _`position`_: The position closest to *x* and *y*.\n* _`x`_: The x-coordinate of the mouse in the view.\n* _`y`_: The y-coordinate of the mouse in the view. EDGE_BACKGROUND buffer.EDGE_BACKGROUND (number, Read-only)\n EDGE_LINE buffer.EDGE_LINE (number, Read-only)\n +EDGE_MULTILINE buffer.EDGE_MULTILINE (number, Read-only)\n EDGE_NONE buffer.EDGE_NONE (number, Read-only)\n EOL_CR buffer.EOL_CR (number, Read-only)\n EOL_CRLF buffer.EOL_CRLF (number, Read-only)\n @@ -143,6 +144,7 @@ MARGINOPTION_NONE buffer.MARGINOPTION_NONE (number, Read-only)\n MARGINOPTION_SUBLINESELECT buffer.MARGINOPTION_SUBLINESELECT (number, Read-only)\n MARGIN_BACK buffer.MARGIN_BACK (number, Read-only)\n MARGIN_CLICK events.MARGIN_CLICK (string)\nEmitted when clicking the mouse inside a sensitive margin.\nArguments:\n\n* _`margin`_: The margin number clicked.\n* _`position`_: The beginning position of the clicked margin's line.\n* _`modifiers`_: A bit-mask of any modifier keys used: `buffer.MOD_CTRL`,\n `buffer.MOD_SHIFT`, `buffer.MOD_ALT`, and `buffer.MOD_META`.\n Note: If you set `buffer.rectangular_selection_modifier` to\n `buffer.MOD_CTRL`, the "Control" modifier is reported as *both* "Control"\n and "Alt" due to a Scintilla limitation with GTK+. +MARGIN_COLOUR buffer.MARGIN_COLOUR (number, Read-only)\n MARGIN_FORE buffer.MARGIN_FORE (number, Read-only)\n MARGIN_NUMBER buffer.MARGIN_NUMBER (number, Read-only)\n MARGIN_RTEXT buffer.MARGIN_RTEXT (number, Read-only)\n @@ -253,6 +255,8 @@ STYLE_DEFAULT buffer.STYLE_DEFAULT (number, Read-only)\n STYLE_DEFAULT lexer.STYLE_DEFAULT (string)\nThe style all styles are based off of. STYLE_EMBEDDED lexer.STYLE_EMBEDDED (string)\nThe style typically used for embedded code. STYLE_ERROR lexer.STYLE_ERROR (string)\nThe style typically used for erroneous syntax. +STYLE_FOLDDISPLAYTEXT buffer.STYLE_FOLDDISPLAYTEXT (number, Read-only)\n +STYLE_FOLDDISPLAYTEXT lexer.STYLE_FOLDDISPLAYTEXT (string)\nThe style used for fold display text. STYLE_FUNCTION lexer.STYLE_FUNCTION (string)\nThe style typically used for function definitions. STYLE_IDENTIFIER lexer.STYLE_IDENTIFIER (string)\nThe style typically used for identifier words. STYLE_INDENTGUIDE buffer.STYLE_INDENTGUIDE (number, Read-only)\n @@ -331,7 +335,7 @@ _VERSION _G._VERSION (string)\nA global variable (not a function) that holds a s _VIEWS _G._VIEWS (table)\nTable of all views in Textadept.\nNumeric keys have view values and view keys have their associated numeric\nkeys.\n@see _G.view _cancel_current textadept.snippets._cancel_current()\nCancels the active snippet, removing all inserted text. _fold lexer.lexer._fold (table)\nIf this function exists in the lexer, it is called for folding\n the document instead of using `_foldsymbols` or indentation. -_foldsymbols lexer.lexer._foldsymbols (table)\nA table of recognized fold points for the lexer.\n Keys are token names with table values defining fold points. Those table\n values have string keys of keywords or characters that indicate a fold\n point whose values are integers. A value of `1` indicates a beginning fold\n point and a value of `-1` indicates an ending fold point. Values can also\n be functions that return `1`, `-1`, or `0` (indicating no fold point) for\n keys which need additional processing.\n There is also a required `_pattern` key whose value is a table containing\n Lua pattern strings that match all fold points (the string keys contained\n in token name table values). When the lexer encounters text that matches\n one of those patterns, the matched text is looked up in its token's table\n to determine whether or not it is a fold point. +_foldsymbols lexer.lexer._foldsymbols (table)\nA table of recognized fold points for the lexer.\n Keys are token names with table values defining fold points. Those table\n values have string keys of keywords or characters that indicate a fold\n point whose values are integers. A value of `1` indicates a beginning fold\n point and a value of `-1` indicates an ending fold point. Values can also\n be functions that return `1`, `-1`, or `0` (indicating no fold point) for\n keys which need additional processing.\n There is also a required `_patterns` key whose value is a table containing\n Lua pattern strings that match all fold points (the string keys contained\n in token name table values). When the lexer encounters text that matches\n one of those patterns, the matched text is looked up in its token's table\n to determine whether or not it is a fold point.\n There is also an optional `_case_insensitive` option that indicates whether\n or not fold point keys are case-insensitive. If `true`, fold point keys\n should be in lower case. _insert textadept.snippets._insert(text)\nInserts snippet text *text* or the snippet assigned to the trigger word\nbehind the caret.\nOtherwise, if a snippet is active, goes to the active snippet's next\nplaceholder. Returns `false` if no action was taken.\n@param text Optional snippet text to insert. If `nil`, attempts to insert a\n new snippet based on the trigger, the word behind caret, and the current\n lexer.\n@return `false` if no action was taken; `nil` otherwise.\n@see buffer.word_chars _lexer lexer.lexer._lexer (table)\nThe parent lexer object whose rules should be used. This field\n is only necessary to disambiguate a proxy lexer that loaded parent and\n child lexers for embedding and ended up having multiple parents loaded. _paths textadept.snippets._paths (table)\nList of directory paths to look for snippet files in.\nFilenames are of the form *lexer.trigger.ext* or *trigger.ext* (*.ext* is an\noptional, arbitrary file extension). If the global `snippets` table does not\ncontain a snippet for a given trigger, this table is consulted for a matching\nfilename, and the contents of that file is inserted as a snippet.\nNote: If a directory has multiple snippets with the same trigger, the snippet\nchosen for insertion is not defined and may not be constant. @@ -544,9 +548,9 @@ dofile _G.dofile([filename])\nOpens the named file and executes its contents as drop_selection_n buffer.drop_selection_n(buffer, n)\nDrops existing selection number *n*.\n@param buffer A buffer.\n@param n The number of the existing selection. dropdown ui.dialogs.dropdown(options)\nPrompts the user with a drop-down item selection dialog defined by dialog\noptions table *options*, returning the selected button's index along with the\nindex of the selected item.\nIf *options*.`string_output` is `true`, returns the selected button's label\nalong with the selected item's text.\nIf the dialog closed due to *options*.`exit_onchange`, returns `4` along with\neither the selected item's index or its text. If the dialog timed out,\nreturns `0` or `"timeout"`. If the user canceled the dialog, returns `-1` or\n`"delete"`.\n@param options Table of key-value option pairs for the drop-down dialog.\n\n * `title`: The dialog's title text.\n * `text`: The dialog's main message text.\n * `items`: The list of string items to show in the drop-down.\n * `button1`: The right-most button's label. The default value is\n `_L['_OK']`.\n * `button2`: The middle button's label.\n * `button3`: The left-most button's label. This option requires `button2`\n to be set.\n * `exit_onchange`: Close the dialog after selecting a new item. The default\n value is `false`.\n * `select`: The index of the initially selected list item. The default\n value is `1`.\n * `string_output`: Return the selected button's label (instead of its\n index) and the selected item's text (instead of its index). If no item\n was selected, returns the dialog's exit status (instead of its exit\n code). The default value is `false`.\n * `width`: The dialog's pixel width.\n * `height`: The dialog's pixel height.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The integer number of seconds the dialog waits for the user to\n select a button before timing out. Dialogs do not time out by default.\n@usage ui.dialogs.dropdown{title = 'Select Encoding', width = 200,\n items = io.encodings, string_output = true}\n@return selected button or exit code, selected item dump string.dump(function [, strip])\nReturns a string containing a binary representation (a _binary chunk_) of the\ngiven function, so that a later `load` on this string returns a copy of the\nfunction (but with new upvalues). If `strip` is a true value, the binary\nrepresentation is created without debug information about the function (local\nvariable names, lines, etc.).\n\nFunctions with upvalues have only their number of upvalues saved. When\n(re)loaded, those upvalues receive fresh instances containing nil. (You can\nuse the debug library to serialize and reload the upvalues of a function in a\nway adequate to your needs.) -edge_colour buffer.edge_colour (number)\nThe color, in "0xBBGGRR" format, of the edge or background for long lines\naccording to `buffer.edge_mode`. +edge_colour buffer.edge_colour (number)\nThe color, in "0xBBGGRR" format, of the single edge or background for long\nlines according to `buffer.edge_mode`. edge_column buffer.edge_column (number)\nThe column number to mark long lines at. -edge_mode buffer.edge_mode (number)\nThe long line mark mode.\n\n* `buffer.EDGE_NONE`\n Long lines are not marked.\n* `buffer.EDGE_LINE`\n Draw a vertical line whose color is `buffer.edge_colour` at column\n `buffer.edge_column`.\n* `buffer.EDGE_BACKGROUND`\n Change the background color of text after column `buffer.edge_column`\n to `buffer.edge_colour`. +edge_mode buffer.edge_mode (number)\nThe long line mark mode.\n\n* `buffer.EDGE_NONE`\n Long lines are not marked.\n* `buffer.EDGE_LINE`\n Draw a single vertical line whose color is `buffer.edge_colour` at\n column `buffer.edge_column`.\n* `buffer.EDGE_BACKGROUND`\n Change the background color of text after column `buffer.edge_column`\n to `buffer.edge_colour`.\n* `buffer.EDGE_MULTILINE`\n Draw vertical lines whose colors and columns are defined by calls to\n `buffer:multi_edge_add_line()`. 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 keys to command entry modes.\nIt is automatically added to command entry modes unless a metatable was\npreviously set. @@ -608,6 +612,7 @@ focus ui.find.focus()\nDisplays and focuses the Find & Replace Pane. fold lexer.fold(lexer, text, start_pos, start_line, start_level)\nDetermines fold points in a chunk of text *text* with lexer *lexer*.\n*text* starts at position *start_pos* on line number *start_line* with a\nbeginning fold level of *start_level* in the buffer. If *lexer* has a `_fold`\nfunction or a `_foldsymbols` table, that field is used to perform folding.\nOtherwise, if *lexer* has a `_FOLDBYINDENTATION` field set, or if a\n`fold.by.indentation` property is set, folding by indentation is done.\n@param lexer The lexer object to fold with.\n@param text The text in the buffer to fold.\n@param start_pos The position in the buffer *text* starts at, starting at\n zero.\n@param start_line The line number *text* starts on.\n@param start_level The fold level *text* starts on.\n@return table of fold levels. fold_all buffer.fold_all(buffer, action)\nContracts, expands, or toggles all fold points, depending on *action*.\nWhen toggling, the state of the first fold point determines whether to\nexpand or contract.\n@param buffer A buffer.\n@param action The fold action to perform. Valid values are:\n * `buffer.FOLDACTION_CONTRACT`\n * `buffer.FOLDACTION_EXPAND`\n * `buffer.FOLDACTION_TOGGLE` fold_children buffer.fold_children(buffer, line, action)\nContracts, expands, or toggles the fold point on line number *line*, as well\nas all of its children, depending on *action*.\n@param buffer A buffer.\n@param line The line number in *buffer* to set the fold states for.\n@param action The fold action to perform. Valid values are:\n * `buffer.FOLDACTION_CONTRACT`\n * `buffer.FOLDACTION_EXPAND`\n * `buffer.FOLDACTION_TOGGLE` +fold_display_text_style buffer.fold_display_text_style (number)\nThe fold display text mode.\n\n* `buffer.FOLDDISPLAYTEXT_HIDDEN`\n Fold display text is not shown.\n* `buffer.FOLDDISPLAYTEXT_STANDARD`\n Fold display text is shown with no decoration.\n* `buffer.FOLDDISPLAYTEXT_BOXED`\n Fold display text is shown outlined with a box.\n\nThe default value is `buffer.FOLDDISPLAYTEXT_HIDDEN`. fold_expanded buffer.fold_expanded (table)\nTable of flags that indicate whether or not fold points are expanded for\nline numbers starting from zero.\nSetting expanded fold states does not toggle folds; it only updates fold\nmargin markers. Use `buffer.toggle_fold()` instead. fold_flags buffer.fold_flags (number, Read-only)\nBit-mask of folding lines to draw in the buffer.\n\n* `buffer.FOLDFLAG_LINEBEFORE_EXPANDED`\n Draw lines above expanded folds.\n* `buffer.FOLDFLAG_LINEBEFORE_CONTRACTED`\n Draw lines above collapsed folds.\n* `buffer.FOLDFLAG_LINEAFTER_EXPANDED`\n Draw lines below expanded folds.\n* `buffer.FOLDFLAG_LINEAFTER_CONTRACTED`\n Draw lines below collapsed folds.\n* `buffer.FOLDFLAG_LEVELNUMBERS`\n Show hexadecimal fold levels in line margins.\n This option cannot be combined with `FOLDFLAG_LINESTATE`.\n* `buffer.FOLDFLAG_LINESTATE`\n Show line state in line margins.\n This option cannot be combined with `FOLDFLAG_LEVELNUMBERS`.\n\nThe default value is `0`. fold_level buffer.fold_level (table)\nTable of fold level bit-masks for line numbers starting from zero.\nFold level masks comprise of an integer level combined with any of the\nfollowing bit flags:\n\n* `buffer.FOLDLEVELBASE`\n The initial fold level.\n* `buffer.FOLDLEVELWHITEFLAG`\n The line is blank.\n* `buffer.FOLDLEVELHEADERFLAG`\n The line is a header, or fold point. @@ -682,7 +687,7 @@ indic_fore buffer.indic_fore (table)\nTable of foreground colors, in "0xBBGGRR" indic_hover_fore buffer.indic_hover_fore (table)\nTable of hover foreground colors, in "0xBBGGRR" format, for indicator\nnumbers from `0` to `31`.\nThe default values are the respective indicator foreground colors. indic_hover_style buffer.indic_hover_style (table)\nTable of hover styles for indicators numbers from `0` to `31`. An\nindicator's hover style drawn when either the cursor hovers over that\nindicator or the caret is within that indicator.\nThe default values are the respective indicator styles. indic_outline_alpha buffer.indic_outline_alpha (table)\nTable of outline color alpha values, ranging from `0` (transparent) to\n`255` (opaque), for indicator numbers from `0` to `31` whose styles are\neither `INDIC_ROUNDBOX`, `INDIC_STRAIGHTBOX`, or `INDIC_DOTBOX`.\nThe default values are `buffer.ALPHA_NOALPHA`, for no alpha. -indic_style buffer.indic_style (table)\nTable of styles for indicator numbers from `0` to `31`.\n\n* `buffer.INDIC_PLAIN`\n An underline.\n* `buffer.INDIC_SQUIGGLE`\n A squiggly underline 3 pixels in height.\n* `buffer.INDIC_TT`\n An underline of small 'T' shapes.\n* `buffer.INDIC_DIAGONAL`\n An underline of diagonal hatches.\n* `buffer.INDIC_STRIKE`\n Strike out.\n* `buffer.INDIC_HIDDEN`\n Invisible.\n* `buffer.INDIC_BOX`\n A bounding box.\n* `buffer.INDIC_ROUNDBOX`\n A translucent box with rounded corners around the text. Use\n `buffer.indic_alpha` and `buffer.indic_outline_alpha` to set the\n fill and outline transparency, respectively. Their default values are\n `30` and `50`.\n* `buffer.INDIC_STRAIGHTBOX`\n Similar to `INDIC_ROUNDBOX` but with sharp corners.\n* `buffer.INDIC_DASH`\n A dashed underline.\n* `buffer.INDIC_DOTS`\n A dotted underline.\n* `buffer.INDIC_SQUIGGLELOW`\n A squiggly underline 2 pixels in height.\n* `buffer.INDIC_DOTBOX`\n Similar to `INDIC_STRAIGHTBOX` but with a dotted outline.\n Translucency alternates between `buffer.indic_alpha` and\n `buffer.indic_outline_alpha` starting with the top-left pixel.\n* `buffer.INDIC_SQUIGGLEPIXMAP`\n Identical to `INDIC_SQUIGGLE` but draws faster by using a pixmap instead\n of multiple line segments.\n* `buffer.INDIC_COMPOSITIONTHICK`\n A 2-pixel thick underline at the bottom of the line inset by 1 pixel on\n on either side. Similar in appearance to the target in Asian language\n input composition.\n* `buffer.INDIC_COMPOSITIONTHIN`\n A 1-pixel thick underline just before the bottom of the line inset by 1\n pixel on either side. Similar in appearance to the non-target ranges in\n Asian language input composition.\n* `buffer.INDIC_FULLBOX`\n Similar to `INDIC_STRAIGHTBOX` but extends to the top of its line,\n potentially touching any similar indicators on the line above.\n* `buffer.INDIC_TEXTFORE`\n Changes the color of text to an indicator's foreground color.\n\nUse `_SCINTILLA.next_indic_number()` for custom indicators.\nChanging an indicator's style resets that indicator's hover style. +indic_style buffer.indic_style (table)\nTable of styles for indicator numbers from `0` to `31`.\n\n* `buffer.INDIC_PLAIN`\n An underline.\n* `buffer.INDIC_SQUIGGLE`\n A squiggly underline 3 pixels in height.\n* `buffer.INDIC_TT`\n An underline of small 'T' shapes.\n* `buffer.INDIC_DIAGONAL`\n An underline of diagonal hatches.\n* `buffer.INDIC_STRIKE`\n Strike out.\n* `buffer.INDIC_HIDDEN`\n Invisible.\n* `buffer.INDIC_BOX`\n A bounding box.\n* `buffer.INDIC_ROUNDBOX`\n A translucent box with rounded corners around the text. Use\n `buffer.indic_alpha` and `buffer.indic_outline_alpha` to set the\n fill and outline transparency, respectively. Their default values are\n `30` and `50`.\n* `buffer.INDIC_STRAIGHTBOX`\n Similar to `INDIC_ROUNDBOX` but with sharp corners.\n* `buffer.INDIC_DASH`\n A dashed underline.\n* `buffer.INDIC_DOTS`\n A dotted underline.\n* `buffer.INDIC_SQUIGGLELOW`\n A squiggly underline 2 pixels in height.\n* `buffer.INDIC_DOTBOX`\n Similar to `INDIC_STRAIGHTBOX` but with a dotted outline.\n Translucency alternates between `buffer.indic_alpha` and\n `buffer.indic_outline_alpha` starting with the top-left pixel.\n* `buffer.INDIC_SQUIGGLEPIXMAP`\n Identical to `INDIC_SQUIGGLE` but draws faster by using a pixmap instead\n of multiple line segments.\n* `buffer.INDIC_COMPOSITIONTHICK`\n A 2-pixel thick underline at the bottom of the line inset by 1 pixel on\n on either side. Similar in appearance to the target in Asian language\n input composition.\n* `buffer.INDIC_COMPOSITIONTHIN`\n A 1-pixel thick underline just before the bottom of the line inset by 1\n pixel on either side. Similar in appearance to the non-target ranges in\n Asian language input composition.\n* `buffer.INDIC_FULLBOX`\n Similar to `INDIC_STRAIGHTBOX` but extends to the top of its line,\n potentially touching any similar indicators on the line above.\n* `buffer.INDIC_TEXTFORE`\n Changes the color of text to an indicator's foreground color.\n* `buffer.INDIC_POINT`\n A triangle below the start of the indicator range.\n* `buffer.INDIC_POINTCHARACTER`\n A triangle below the centre of the first character of the indicator\n range.\n\nUse `_SCINTILLA.next_indic_number()` for custom indicators.\nChanging an indicator's style resets that indicator's hover style. indic_under buffer.indic_under (table)\nTable of flags that indicate whether or not to draw indicators behind text\ninstead of over the top of it for indicator numbers from `0` to `31`.\nThe default values are `false`. indicator_all_on_for buffer.indicator_all_on_for(buffer, pos)\nReturns a bit-mask that represents which indicators are on at position *pos*.\nBit 0 is set if indicator 0 is on, bit 1 for indicator 1, etc.\n@param buffer A buffer.\n@param pos The position in *buffer* to get indicators at.\n@return number indicator_clear_range buffer.indicator_clear_range(buffer, pos, length)\nClears indicator number `buffer.indicator_current` over the range of text\nfrom position *pos* to *pos* + *length*.\n@param buffer A buffer.\n@param pos The start position of the range of text in *buffer* to clear\n indicators over.\n@param length The number of characters in the range of text to clear\n indicators over. @@ -773,17 +778,19 @@ lua _G.keys.lua (table)\nContainer for Lua-specific key bindings. lua _G.snippets.lua (table)\nContainer for Lua-specific snippets. lua _M.lua (module)\nThe lua module.\nIt provides utilities for editing Lua code. main_selection buffer.main_selection (number)\nThe number of the main, or most recent, selection.\nOnly an existing selection can be made main. -margin_cursor_n buffer.margin_cursor_n (table)\nTable of cursor types shown over margin numbers from zero to four.\n\n* `buffer.CURSORARROW`\n Normal arrow cursor.\n* `buffer.CURSORREVERSEARROW`\n Reversed arrow cursor.\n\nThe default values are `buffer.CURSORREVERSEARROW`. +margin_back_n buffer.margin_back_n (table)\nTable of background colors, in "0xBBGGRR" format, of margin numbers from\n`0` to `buffer.margins - 1` (`4` by default).\nOnly affects margins of type `buffer.MARGIN_COLOUR`. +margin_cursor_n buffer.margin_cursor_n (table)\nTable of cursor types shown over margin numbers from `0` to\n`buffer.margins - 1` (`4` by default).\n\n* `buffer.CURSORARROW`\n Normal arrow cursor.\n* `buffer.CURSORREVERSEARROW`\n Reversed arrow cursor.\n\nThe default values are `buffer.CURSORREVERSEARROW`. margin_left buffer.margin_left (number)\nThe pixel size of the left margin of the buffer text.\nThe default value is `1`. -margin_mask_n buffer.margin_mask_n (table)\nTable of bit-masks of markers whose symbols marker symbol margins can\ndisplay for margin numbers from zero to four.\nBit-masks are 32-bit values whose bits correspond to the 32 available\nmarkers.\nThe default values are `0`, `bit32.bnot(buffer.MASK_FOLDERS)`, `0`, `0`,\nand `0`, for a line margin and logical marker margin. +margin_mask_n buffer.margin_mask_n (table)\nTable of bit-masks of markers whose symbols marker symbol margins can\ndisplay for margin numbers from `0` to `buffer.margins - 1` (`4` by\ndefault).\nBit-masks are 32-bit values whose bits correspond to the 32 available\nmarkers.\nThe default values are `0`, `bit32.bnot(buffer.MASK_FOLDERS)`, `0`, `0`,\nand `0`, for a line margin and logical marker margin. margin_options buffer.margin_options (number)\nA bit-mask of margin option settings.\n\n* `buffer.MARGINOPTION_NONE`\n None.\n* `buffer.MARGINOPTION_SUBLINESELECT`\n Select only a wrapped line's sub-line (rather than the entire line) when\n the line number margin is clicked.\n\nThe default value is `buffer.MARGINOPTION_NONE`. margin_right buffer.margin_right (number)\nThe pixel size of the right margin of the buffer text.\nThe default value is `1`. -margin_sensitive_n buffer.margin_sensitive_n (table)\nTable of flags that indicate whether or not mouse clicks in margins emit\n`MARGIN_CLICK` events for margin numbers from zero to four.\nThe default values are `false`. +margin_sensitive_n buffer.margin_sensitive_n (table)\nTable of flags that indicate whether or not mouse clicks in margins emit\n`MARGIN_CLICK` events for margin numbers from `0` to `buffer.margins - 1`\n(`4` by default).\nThe default values are `false`. margin_style buffer.margin_style (table)\nTable of style numbers for line numbers starting from zero in the text\nmargin.\nOnly some style attributes are active in text margins: font, size, bold,\nitalics, fore, and back. margin_text buffer.margin_text (table)\nTable of text displayed in text margins for line numbers starting from\nzero. margin_text_clear_all buffer.margin_text_clear_all(buffer)\nClears all text in text margins.\n@param buffer A buffer. -margin_type_n buffer.margin_type_n (table)\nTable of margin types for margin numbers from zero to four.\n\n* `buffer.MARGIN_SYMBOL`\n A marker symbol margin.\n* `buffer.MARGIN_NUMBER`\n A line number margin.\n* `buffer.MARGIN_BACK`\n A marker symbol margin whose background color matches the default text\n background color.\n* `buffer.MARGIN_FORE`\n A marker symbol margin whose foreground color matches the default text\n foreground color.\n* `buffer.MARGIN_TEXT`\n A text margin.\n* `buffer.MARGIN_RTEXT`\n A right-justified text margin.\n\nThe default value for the first margin is `buffer.MARGIN_NUMBER`, followed\nby `buffer.MARGIN_SYMBOL` for the rest. -margin_width_n buffer.margin_width_n (table)\nTable of pixel margin widths for margin numbers from zero to four. +margin_type_n buffer.margin_type_n (table)\nTable of margin types for margin numbers from `0` to `buffer.margins - 1`\n(`4` by default).\n\n* `buffer.MARGIN_SYMBOL`\n A marker symbol margin.\n* `buffer.MARGIN_NUMBER`\n A line number margin.\n* `buffer.MARGIN_BACK`\n A marker symbol margin whose background color matches the default text\n background color.\n* `buffer.MARGIN_FORE`\n A marker symbol margin whose background color matches the default text\n foreground color.\n* `buffer.MARGIN_TEXT`\n A text margin.\n* `buffer.MARGIN_RTEXT`\n A right-justified text margin.\n* `buffer.MARGIN_COLOUR`\n A marker symbol margin whose background color is configurable.\n\nThe default value for the first margin is `buffer.MARGIN_NUMBER`, followed\nby `buffer.MARGIN_SYMBOL` for the rest. +margin_width_n buffer.margin_width_n (table)\nTable of pixel margin widths for margin numbers from `0` to\n`buffer.margins - 1` (`4` by default). +margins buffer.margins (number)\nThe number of margins.\nThe default value is `5`. marker_add buffer.marker_add(buffer, line, marker)\nAdds marker number *marker*, in the range of `0` to `31`, to line number\n*line*, returning the added marker's handle which can be used in\n`buffer.marker_delete_handle()` and `buffer.marker_line_from_handle()`, or\n`0` if *line* is invalid.\n@param buffer A buffer.\n@param line The line number to add the marker on.\n@param marker The marker number in the range of `0` to `31` to add.\n@return number marker_add_set buffer.marker_add_set(buffer, line, marker_mask)\nAdds the markers specified in marker bit-mask *marker_mask* to line number\n*line*.\nThe first bit is set to add marker number 0, the second bit for marker number\n1, and so on up to marker number 31.\n@param buffer A buffer.\n@param line The line number to add the markers on.\n@param marker_mask The mask of markers to set. Set bit 0 to set marker 0, bit\n 1 for marker 1 and so on. marker_alpha buffer.marker_alpha (table, Write-only)\nTable of alpha values, ranging from `0` (transparent) to `255` (opaque),\nof markers drawn in the text area (not the margin) for markers numbers from\n`0` to `31`.\nThe default values are `buffer.ALPHA_NOALPHA`, for no alpha. @@ -830,6 +837,8 @@ move_caret_inside_view buffer.move_caret_inside_view(buffer)\nMoves the caret in move_selected_lines_down buffer.move_selected_lines_down(buffer)\nShifts the selected lines down one line.\n@param buffer A buffer. move_selected_lines_up buffer.move_selected_lines_up(buffer)\nShifts the selected lines up one line.\n@param buffer A buffer. msgbox ui.dialogs.msgbox(options)\nPrompts the user with a generic message box dialog defined by dialog options\ntable *options*, returning the selected button's index.\nIf *options*.`string_output` is `true`, returns the selected button's label.\nIf the dialog timed out, returns `0` or `"timeout"`. If the user canceled the\ndialog, returns `-1` or `"delete"`.\n@param options Table of key-value option pairs for the message box.\n\n * `title`: The dialog's title text.\n * `text`: The dialog's main message text.\n * `informative_text`: The dialog's extra informative text.\n * `icon`: The dialog's GTK stock icon name. Examples are\n "gtk-dialog-error", "gtk-dialog-info", "gtk-dialog-question", and\n "gtk-dialog-warning". The dialog does not display an icon by default.\n * `icon_file`: The dialog's icon file path. This option has no effect when\n `icon` is set.\n * `button1`: The right-most button's label. The default value is\n `_L['_OK']`.\n * `button2`: The middle button's label.\n * `button3`: The left-most button's label. This option requires `button2`\n to be set.\n * `string_output`: Return the selected button's label (instead of its\n index) or the dialog's exit status instead of the button's index (instead\n of its exit code). The default value is `false`.\n * `width`: The dialog's pixel width.\n * `height`: The dialog's pixel height.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The integer number of seconds the dialog waits for the user to\n select a button before timing out. Dialogs do not time out by default.\n@usage ui.dialogs.msgbox{title = 'EOL Mode', text = 'Which EOL?',\n icon = 'gtk-dialog-question', button1 = 'CRLF', button2 = 'CR',\n button3 = 'LF'}\n@return selected button or exit code +multi_edge_add_line buffer.multi_edge_add_line(buffer, column, color)\nAdds a new vertical line at column number *column* with color *color*, in\n"0xBBGGRR" format.\n@param buffer A buffer.\n@param column The column number to add a vertical line at.\n@param color The color in "0xBBGGRR" format. +multi_edge_clear_all buffer.multi_edge_clear_all(buffer)\nClears all vertical lines created by `buffer:multi_edge_add_line()`.\n@param buffer A buffer. multi_paste buffer.multi_paste (number)\nThe multiple selection paste mode.\n\n* `buffer.MULTIPASTE_ONCE`\n Paste into only the main selection.\n* `buffer.MULTIPASTE_EACH`\n Paste into all selections.\n\nThe default value is `buffer.MULTIPASTE_ONCE`. multiple_select_add_each buffer.multiple_select_add_each(buffer)\nAdds to the set of selections each occurrence of the main selection within\nthe target range.\nIf there is no selected text, the current word is used.\n@param buffer A buffer. multiple_select_add_next buffer.multiple_select_add_next(buffer)\nAdds to the set of selections the next occurrence of the main selection\nwithin the target range, makes that occurrence the new main selection, and\nscrolls it into view.\nIf there is no selected text, the current word is used.\n@param buffer A buffer. @@ -1095,6 +1104,7 @@ symlinkattributes lfs.symlinkattributes(filepath [, aname])\nIdentical to lfs.at tab buffer.tab(buffer)\nIndents the text on the selected lines or types a Tab character ("\t") at\nthe caret position.\n@param buffer A buffer. tab_context_menu textadept.menu.tab_context_menu (table)\nThe default tabbar context menu.\nSubmenus, and menu items can be retrieved by name in addition to table index\nnumber. tab_context_menu ui.tab_context_menu (userdata)\nThe context menu for the buffer's tab, a `ui.menu()`.\nThis is a low-level field. You probably want to use the higher-level\n`textadept.menu.tab_context_menu`. +tab_draw_mode buffer.tab_draw_mode (number)\nThe draw mode of visible tabs.\n\n* `buffer.TD_LONGARROW`\n An arrow that stretches until the tabstop.\n* `buffer.TD_STRIKEOUT`\n A horizontal line that stretches until the tabstop.\n\nThe default value is `buffer.TD_LONGARROW`. tab_indents buffer.tab_indents (bool)\nIndent text when tabbing within indentation.\nThe default value is `false`. tab_label buffer.tab_label (string)\nThe buffer's tab label in the tab bar. tab_width buffer.tab_width (number)\nThe number of space characters represented by a tab character.\nThe default value is `8`. @@ -1127,6 +1137,7 @@ toggle textadept.bookmarks.toggle(on, line)\nToggles the bookmark on line number toggle_block _M.ruby.toggle_block()\nToggles between `{ ... }` and `do ... end` Ruby blocks.\nIf the caret is inside a `{ ... }` single-line block, that block is converted\nto a multiple-line `do .. end` block. If the caret is on a line that contains\nsingle-line `do ... end` block, that block is converted to a single-line\n`{ ... }` block. If the caret is inside a multiple-line `do ... end` block,\nthat block is converted to a single-line `{ ... }` block with all newlines\nreplaced by a space. Indentation is important. The `do` and `end` keywords\nmust be on lines with the same level of indentation to toggle correctly. toggle_caret_sticky buffer.toggle_caret_sticky(buffer)\nCycles between `buffer.caret_sticky` option settings `buffer.CARETSTICKY_ON`\nand `buffer.CARETSTICKY_OFF`.\n@param buffer A buffer.\n@see caret_sticky toggle_fold buffer.toggle_fold(buffer, line)\nToggles the fold point on line number *line* between expanded (where all of\nits child lines are displayed) and contracted (where all of its child lines\nare hidden).\n@param buffer A buffer.\n@param line The line number in *buffer* to toggle the fold on. +toggle_fold_display_text buffer.toggle_fold_display_text(buffer, line, text)\nToggles a fold point on line number *line* between expanded (where all of\nits child lines are displayed) and contracted (where all of its child lines\nare hidden), and shows string *text* after the line.\n*text* is drawn with style number `buffer.STYLE_FOLDDISPLAYTEXT`.\n@param buffer A buffer.\n@param line The line number in *buffer* to toggle the fold on and display\n *text* after.\n@param text The text to display after the line. tointeger math.tointeger(x)\nIf the value `x` is convertible to an integer, returns that integer.\nOtherwise, returns nil.\n\nNew in Lua 5.3. token lexer.token(name, patt)\nCreates and returns a token pattern with token name *name* and pattern\n*patt*.\nIf *name* is not a predefined token name, its style must be defined in the\nlexer's `_tokenstyles` table.\n@param name The name of token. If this name is not a predefined token name,\n then a style needs to be assiciated with it in the lexer's `_tokenstyles`\n table.\n@param patt The LPeg pattern associated with the token.\n@usage local ws = token(l.WHITESPACE, l.space^1)\n@usage local annotation = token('annotation', '@' * l.word)\n@return pattern tonumber _G.tonumber(e [, base])\nWhen called with no `base`, `tonumber` tries to convert its argument to a\nnumber. If the argument is already a number or a string convertible to a\nnumber, then `tonumber` returns this number; otherwise, it\nreturns nil.\n\nThe conversion of strings can result in integers or floats, according to the\nlexical conventions of Lua (see ยง3.1). (The string may have leading and\ntrailing spaces and a sign.)\n\nWhen called with `base`, then `e` must be a string to be interpreted as an\ninteger numeral in that base. The base may be any integer between 2 and 36,\ninclusive. In bases above 10, the letter '`A`' (in either upper or lower\ncase) represents 10, '`B`' represents 11, and so forth, with '`Z`'\nrepresenting 35. If the string `e` is not a valid numeral in the given base,\nthe function returns nil diff --git a/modules/lua/tags b/modules/lua/tags index 1cea4d2c..1995a7f1 100644 --- a/modules/lua/tags +++ b/modules/lua/tags @@ -67,6 +67,7 @@ DWELL_END _ 0;" F class:events DWELL_START _ 0;" F class:events EDGE_BACKGROUND _ 0;" F class:buffer EDGE_LINE _ 0;" F class:buffer +EDGE_MULTILINE _ 0;" F class:buffer EDGE_NONE _ 0;" F class:buffer EOL_CR _ 0;" F class:buffer EOL_CRLF _ 0;" F class:buffer @@ -143,6 +144,7 @@ MARGINOPTION_NONE _ 0;" F class:buffer MARGINOPTION_SUBLINESELECT _ 0;" F class:buffer MARGIN_BACK _ 0;" F class:buffer MARGIN_CLICK _ 0;" F class:events +MARGIN_COLOUR _ 0;" F class:buffer MARGIN_FORE _ 0;" F class:buffer MARGIN_NUMBER _ 0;" F class:buffer MARGIN_RTEXT _ 0;" F class:buffer @@ -253,6 +255,8 @@ STYLE_DEFAULT _ 0;" F class:buffer STYLE_DEFAULT _ 0;" F class:lexer STYLE_EMBEDDED _ 0;" F class:lexer STYLE_ERROR _ 0;" F class:lexer +STYLE_FOLDDISPLAYTEXT _ 0;" F class:buffer +STYLE_FOLDDISPLAYTEXT _ 0;" F class:lexer STYLE_FUNCTION _ 0;" F class:lexer STYLE_IDENTIFIER _ 0;" F class:lexer STYLE_INDENTGUIDE _ 0;" F class:buffer @@ -616,6 +620,7 @@ focus _ 0;" f class:ui.find fold _ 0;" f class:lexer fold_all _ 0;" f class:buffer fold_children _ 0;" f class:buffer +fold_display_text_style _ 0;" F class:buffer fold_expanded _ 0;" F class:buffer fold_flags _ 0;" F class:buffer fold_level _ 0;" F class:buffer @@ -781,6 +786,7 @@ lua _ 0;" m class:_M lua _ 0;" t class:keys lua _ 0;" t class:snippets main_selection _ 0;" F class:buffer +margin_back_n _ 0;" F class:buffer margin_cursor_n _ 0;" F class:buffer margin_left _ 0;" F class:buffer margin_mask_n _ 0;" F class:buffer @@ -792,6 +798,7 @@ margin_text _ 0;" F class:buffer margin_text_clear_all _ 0;" f class:buffer margin_type_n _ 0;" F class:buffer margin_width_n _ 0;" F class:buffer +margins _ 0;" F class:buffer marker_add _ 0;" f class:buffer marker_add_set _ 0;" f class:buffer marker_alpha _ 0;" F class:buffer @@ -838,6 +845,8 @@ move_caret_inside_view _ 0;" f class:buffer move_selected_lines_down _ 0;" f class:buffer move_selected_lines_up _ 0;" f class:buffer msgbox _ 0;" f class:ui.dialogs +multi_edge_add_line _ 0;" f class:buffer +multi_edge_clear_all _ 0;" f class:buffer multi_paste _ 0;" F class:buffer multiple_select_add_each _ 0;" f class:buffer multiple_select_add_next _ 0;" f class:buffer @@ -1103,6 +1112,7 @@ symlinkattributes _ 0;" f class:lfs tab _ 0;" f class:buffer tab_context_menu _ 0;" F class:ui tab_context_menu _ 0;" t class:textadept.menu +tab_draw_mode _ 0;" F class:buffer tab_indents _ 0;" F class:buffer tab_label _ 0;" F class:buffer tab_width _ 0;" F class:buffer @@ -1143,6 +1153,7 @@ toggle _ 0;" f class:textadept.bookmarks toggle_block _ 0;" f class:_M.ruby toggle_caret_sticky _ 0;" f class:buffer toggle_fold _ 0;" f class:buffer +toggle_fold_display_text _ 0;" f class:buffer tointeger _ 0;" f class:math token _ 0;" f class:lexer tonumber _ 0;" f |