diff options
Diffstat (limited to 'modules/lua/api')
| -rw-r--r-- | modules/lua/api | 62 |
1 files changed, 37 insertions, 25 deletions
diff --git a/modules/lua/api b/modules/lua/api index da29cbd6..8c466d74 100644 --- a/modules/lua/api +++ b/modules/lua/api @@ -145,7 +145,7 @@ LEXER_LOADED events.LEXER_LOADED (string)\nEmitted after loading a language lexe MARGINOPTION_NONE _SCINTILLA.constants.MARGINOPTION_NONE\n0 MARGINOPTION_SUBLINESELECT _SCINTILLA.constants.MARGINOPTION_SUBLINESELECT\n1 MARGIN_BACK _SCINTILLA.constants.MARGIN_BACK\n2 -MARGIN_CLICK events.MARGIN_CLICK (string)\nEmitted when clicking the mouse inside a margin.\nArguments:\n\n* _`margin`_: The margin number clicked.\n* _`position`_: The position of the start of the line whose margin was\n clicked.\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_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 position of the start of the line whose margin was\n clicked.\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_FORE _SCINTILLA.constants.MARGIN_FORE\n3 MARGIN_NUMBER _SCINTILLA.constants.MARGIN_NUMBER\n1 MARGIN_RTEXT _SCINTILLA.constants.MARGIN_RTEXT\n5 @@ -193,6 +193,7 @@ MARK_TCORNER _SCINTILLA.constants.MARK_TCORNER\n11 MARK_TCORNERCURVE _SCINTILLA.constants.MARK_TCORNERCURVE\n17 MARK_UNDERLINE _SCINTILLA.constants.MARK_UNDERLINE\n29 MARK_VLINE _SCINTILLA.constants.MARK_VLINE\n9 +MARK_WARNING textadept.run.MARK_WARNING (number)\nThe run or compile warning marker number. MASK_FOLDERS _SCINTILLA.constants.MASK_FOLDERS\n-33554432 MAX_MARGIN _SCINTILLA.constants.MAX_MARGIN\n4 MAX_RECENT_FILES textadept.session.MAX_RECENT_FILES (number)\nThe maximum number of recent files to save to session files.\nRecent files are stored in `io.recent_files`.\nThe default value is `10`. @@ -418,7 +419,7 @@ auto_c_auto_hide buffer.auto_c_auto_hide (bool)\nAutomatically hide the autocomp auto_c_cancel buffer.auto_c_cancel(buffer)\nCancels the autocompletion list.\n@param buffer The global buffer. auto_c_cancel_at_start buffer.auto_c_cancel_at_start (bool)\nCancel an autocompletion or user list when backspacing to a position before\nwhere autocompletion started instead of before the word being completed.\nThe default value is `true`. auto_c_case_insensitive_behaviour buffer.auto_c_case_insensitive_behaviour (number)\nThe behavior mode for a case insensitive autocompletion or user list when\n`buffer.auto_c_ignore_case` is `true`.\n\n* `buffer.CASEINSENSITIVEBEHAVIOR_RESPECTCASE`\n Prefer to select case-sensitive matches.\n* `buffer.CASEINSENSITIVEBEHAVIOR_IGNORECASE`\n No preference.\n\nThe default value is `buffer.CASEINSENSITIVEBEHAVIOR_RESPECTCASE`. -auto_c_choose_single buffer.auto_c_choose_single (bool)\nAutomatically choose the item in a single-item autocompletion list.\nThe default value is `false`. +auto_c_choose_single buffer.auto_c_choose_single (bool)\nAutomatically choose the item in a single-item autocompletion list. This\noption has no effect for a user list.\nThe default value is `false`. auto_c_complete buffer.auto_c_complete(buffer)\nAutocompletes the selected word in the autocompletion list.\n@param buffer The global buffer. auto_c_current buffer.auto_c_current (number, Read-only)\nThe index of the currently selected item in the autocompletion list. auto_c_current_text buffer.auto_c_current_text (string, Read-only)\nThe text of the currently selected item in the autocompletion list. @@ -440,7 +441,7 @@ back_tab buffer.back_tab(buffer)\nUn-indents the text on the selected lines.\n@p band bit32.band(...)\nReturns the bitwise "and" of its operands. begin_undo_action buffer.begin_undo_action(buffer)\nStarts a sequence of actions to undo or redo as a single action.\nMay be nested.\n@param buffer The global buffer. bit32 _G.bit32 (module)\nLua bit32 module. -block_comment textadept.editing.block_comment(comment)\nComments or uncomments the selected lines with line comment or block comment\ndelimiters string *comment* or the comment from the `comment_string` table\nfor the current lexer.\nBlock comment delimiters are separated by a '|' character.\nAs long as any part of a line is selected, the entire line is eligible for\ncommenting/uncommenting.\n@param comment Optional comment string inserted or removed from each line in\n the selection. The default value is the comment in the `comment_string`\n table for the current lexer.\n@see comment_string +block_comment textadept.editing.block_comment()\nComments or uncomments the selected lines based on the current lexer.\nAs long as any part of a line is selected, the entire line is eligible for\ncommenting/uncommenting.\n@see comment_string bnot bit32.bnot(x)\nReturns the bitwise negation of `x`. For any integer `x`, the following\nidentity holds:\n\n assert(bit32.bnot(x) == (-1 - x) % 2^32) boms io.boms (table)\nList of byte-order marks (BOMs) for identifying unicode file encodings. bookmarks textadept.bookmarks (module)\nBookmarks for Textadept. @@ -466,7 +467,6 @@ call_tip_position buffer.call_tip_position (boolean)\nDisplay the call tip above call_tip_set_hlt buffer.call_tip_set_hlt(buffer, start_pos, end_pos)\nHighlights the call tip text between positions *start_pos*, starting from\nzero, to *end_pos* with the color `buffer.call_tip_fore_hlt`.\n@param buffer The global buffer.\n@param start_pos The start position in the call tip text to highlight.\n@param end_pos The end position in the call tip text to highlight. call_tip_show buffer.call_tip_show(buffer, pos, text)\nDisplays a call tip containing string *text* for the word behind position\n*pos*.\nAny "\001" or "\002" bytes in *text* are replaced by arrow visuals,\nindicating the word has more than one call tip.\n@param buffer The global buffer.\n@param pos The position in *buffer* to show the call tip at.\n@param text The call tip text to show. call_tip_use_style buffer.call_tip_use_style (number)\nThe pixel size of tab characters in call tips.\nWhen non-zero, also enables the use of style number `buffer.STYLE_CALLTIP`\ninstead of `buffer.STYLE_DEFAULT` for call tip styles.\nThe default value is `0`. -can_paste buffer.can_paste(buffer)\nReturns whether or not the clipboard has text to paste.\n@param buffer The global buffer.\n@return bool can_redo buffer.can_redo(buffer)\nReturns whether or not there is an action to redo.\n@param buffer The global buffer.\n@return bool can_undo buffer.can_undo(buffer)\nReturns whether or not there is an action to undo.\n@param buffer The global buffer.\n@return bool cancel buffer.cancel(buffer)\nCancels the active call tip, autocompletion or user list, selection mode,\netc.\n@param buffer The global buffer. @@ -515,8 +515,8 @@ colourise buffer.colourise(buffer, start_pos, end_pos)\nTells the lexer to style column buffer.column (table, Read-only)\nTable of column numbers, taking tab widths into account, for positions\nstarting from zero. command_entry ui.command_entry (module)\nTextadept's Command Entry. comment_string textadept.editing.comment_string (table)\nMap of lexer names to line comment strings for programming languages, used by\nthe `block_comment()` function.\nKeys are lexer names and values are either the language's line comment\nprefixes or block comment delimiters separated by a '|' character.\n@see block_comment -compile textadept.run.compile()\nCompiles the file based on its extension using the command from the\n`compile_command` table.\nEmits a `COMPILE_OUTPUT` event.\n@see compile_command\n@see _G.events -compile_command textadept.run.compile_command (table)\nMap of file extensions (excluding the leading '.') to their associated\n"compile" shell command line strings or functions returning such strings.\nCommand line strings may have the following macros:\n\n + `%(filepath)`: The full path of the current file.\n + `%(filedir)`: The current file's directory path.\n + `%(filename)`: The name of the file, including its extension.\n + `%(filename_noext)`: The name of the file, excluding its extension.\n\nThis table is typically populated by language modules. +compile textadept.run.compile()\nCompiles the file based on its extension or lexer, using the command from the\n`compile_commands` table.\nEmits a `COMPILE_OUTPUT` event.\n@see compile_commands\n@see _G.events +compile_commands textadept.run.compile_commands (table)\nMap of file extensions (excluding the leading '.') or lexers to their\nassociated "compile" shell command line strings or functions returning such\nstrings.\nCommand line strings may have the following macros:\n\n + `%(filepath)`: The full path of the current file.\n + `%(filedir)`: The current file's directory path.\n + `%(filename)`: The name of the file, including its extension.\n + `%(filename_noext)`: The name of the file, excluding its extension. complete textadept.adeptsense.complete(sense, only_fields, only_functions)\nShows an autocompletion list of functions (unless *only_fields* is `true`)\nand fields (unless *only_funcs* is `true`) for the symbol behind the caret,\nreturning `true` on success.\n@param sense The Adeptsense returned by `adeptsense.new()`. If `nil`, uses\n the current language's Adeptsense (if it exists).\n@param only_fields Optional flag indicating whether or not to return a list\n of only fields. The default value is `false`.\n@param only_functions Optional flag indicating whether or not to return a\n list of only functions. The default value is `false`.\n@return `true` on success or `false`.\n@see get_symbol\n@see get_completions complete_lua ui.command_entry.complete_lua(code)\nShows a set of Lua code completions for string *code* or `entry_text`.\nCompletions are subject to an "abbreviated" environment where the `buffer`,\n`view`, and `ui` tables are also considered as globals.\n@param code The Lua code to complete. The default value is the value of\n `entry_text`. completions textadept.adeptsense.completions (table)\nA list containing lists of possible completions for known symbols.\nEach symbol key has a table value that contains a list of field completions\nwith a `fields` key and a list of functions completions with a `functions`\nkey. This table is normally populated by `load_ctags()`, but can also be set\nby the user. @@ -526,10 +526,9 @@ connect events.connect(event, f, index)\nAdds function *f* to the set of event h constants _SCINTILLA.constants (table)\nMap of Scintilla constant names to their numeric values. context_menu ui.context_menu\nThe editor's context menu, a `ui.menu()`.\n This is a low-level field. You probably want to use the higher-level\n `textadept.menu.set_contextmenu()`. contracted_fold_next buffer.contracted_fold_next(buffer, line_start)\nReturns the line number of the next contracted fold header line starting at\n*line_start*, or `-1`.\n@param buffer The global buffer.\n@param line_start The line number in *buffer* to start at.\n@return number -control_char_symbol buffer.control_char_symbol (number)\nThe byte value of the character displayed in place of control characters,\ncharacters whose byte values are less than 32. Values less than 32 dispay\nASCII mnemonics instead.\nThe default value is `0`. control_structure_patterns _M.lua.control_structure_patterns (table)\nList of patterns for auto-`end` completion for control structures.\n@see try_to_autocomplete_end control_structure_patterns _M.ruby.control_structure_patterns (table)\nPatterns for auto `end` completion for control structures.\n@see try_to_autocomplete_end -convert_eo_ls buffer.convert_eo_ls(buffer, mode)\nConverts all line endings to end of line mode *mode*.\n@param buffer The global buffer.\n@param mode The line ending mode to convert to. Valid values are:\n * `buffer.EOL_CRLF`\n * `buffer.EOL_CR`\n * `buffer.EOL_LF` +convert_eols buffer.convert_eols(buffer, mode)\nConverts all line endings to end of line mode *mode*.\n@param buffer The global buffer.\n@param mode The line ending mode to convert to. Valid values are:\n * `buffer.EOL_CRLF`\n * `buffer.EOL_CR`\n * `buffer.EOL_LF` convert_indentation textadept.editing.convert_indentation()\nConverts indentation between tabs and spaces based on `buffer.use_tabs`.\nIf `buffer.use_tabs` is `true`, `buffer.tab_width` indenting spaces are\nconverted to tabs. Otherwise, all indenting tabs are converted to\n`buffer.tab_width` spaces.\n@see buffer.use_tabs copy buffer.copy(buffer)\nCopies the selected text to the clipboard.\nMultiple selections are copied in order with no delimiters. Rectangular\nselections are copied from top to bottom with line ending delimiters. Virtual\nspace is not copied.\n@param buffer The global buffer. copy_allow_line buffer.copy_allow_line(buffer)\nCopies the selected text or the current line to the clipboard.\n@param buffer The global buffer. @@ -568,7 +567,8 @@ delete_back buffer.delete_back(buffer)\nDeletes the selected text or the charact delete_back_not_line buffer.delete_back_not_line(buffer)\nDeletes the selected text or the character behind the caret unless the caret\nis at the beginning of a line.\n@param buffer The global buffer. delete_range buffer.delete_range(buffer, pos, length)\nDeletes the buffer's text from position *pos* to *pos* + *length*.\n@param buffer The global buffer.\n@param pos The start position of the range of text in *buffer* to delete.\n@param length The number of characters in the range of text to delete. delimited_range lexer.delimited_range(chars, single_line, no_escape, balanced)\nCreates and returns a pattern that matches a range of text bounded by\n*chars* characters.\nThis is a convenience function for matching more complicated delimited ranges\nlike strings with escape characters and balanced parentheses. *single_line*\nindicates whether or not ranges must be on a single line, *no_escape*\nindicates whether or not to treat '\' character as an escape character, and\n*balanced* indicates whether or not to handle balanced ranges like\nparentheses and requires *chars* to be composed of two characters.\n@param chars The character(s) that bound the matched range.\n@param single_line Optional flag indicating whether or not the range must be\n on a single line.\n@param no_escape Optional flag indicating whether or not the range end\n character may be escaped by a '\\' character.\n@param balanced Optional flag indicating whether or not to match a balanced\n range, like the "%b" Lua pattern. This flag only applies if *chars*\n consists of two different characters (e.g. "()").\n@usage local dq_str_escapes = l.delimited_range('"')\n@usage local dq_str_noescapes = l.delimited_range('"', false, true)\n@usage local unbalanced_parens = l.delimited_range('()')\n@usage local balanced_parens = l.delimited_range('()', false, false, true)\n@return pattern\n@see nested_pair -dialog ui.dialog(kind, ...)\nDisplays a gtdialog of kind *kind* with the given string arguments to\npass to the dialog and returns a formatted string of the dialog's output.\nTable arguments containing strings are allowed and expanded in place. This is\nuseful for filtered list dialogs with many items.\nFor more information on gtdialog, see http://foicica.com/gtdialog.\n@param kind The kind of gtdialog.\n@param ... Parameters to the gtdialog.\n@return string gtdialog result. +dialog ui.dialog(kind, ...)\nLow-level function for prompting the user with a gtdialogs of kind *kind*\nwith the given string and table arguments, returning a formatted string of\nthe dialog's output.\nYou probably want to use the higher-level functions in the `ui.dialogs`\nmodule.\nTable arguments containing strings are allowed and expanded in place. This is\nuseful for filtered list dialogs with many items.\n@param kind The kind of gtdialog.\n@param ... Parameters to the gtdialog.\n@return string gtdialog result. +dialogs ui.dialogs (module)\nProvides a set of interactive dialog prompts for user input. difftime os.difftime(t2, t1)\nReturns the number of seconds from time `t1` to time `t2`. In POSIX,\nWindows, and some other systems, this value is exactly `t2`*-*`t1`. digit lexer.digit (pattern)\nA pattern that matches any digit ('0'-'9'). dir lfs.dir(path)\nLua iterator over the entries of a given directory. Each time the iterator is\ncalled with dir_obj it returns a directory entry's name as a string, or nil\nif there are no more entries. You can also iterate by calling dir_obj:next(),\nand explicitly close the directory before the iteration finished with\ndir_obj:close(). Raises an error if path is not a directory. @@ -581,6 +581,7 @@ document_end_extend buffer.document_end_extend(buffer)\nMoves the caret to the e document_start buffer.document_start(buffer)\nMoves the caret to the beginning of the buffer.\n@param buffer The global buffer. document_start_extend buffer.document_start_extend(buffer)\nMoves the caret to the beginning of the buffer, extending the selected text\nto the new position.\n@param buffer The global buffer. dofile _G.dofile([filename])\nOpens the named file and executes its contents as a Lua chunk. When\ncalled without arguments,\n`dofile` executes the contents of the standard input (`stdin`). Returns\nall values returned by the chunk. In case of errors, `dofile` propagates\nthe error to its caller (that is, `dofile` does not run in protected mode). +dropdown ui.dialogs.dropdown(options)\nPrompts the user with a drop down item selection dialog defined by dialog\noptions table *options*, returning the index of the selected button along\nwith the index of the selected item or, if *options*.`string_output` is\n`true`, the selected button's label along with the selected item's text.\nIf *options*.`exit_onchange` closed the dialog, returns `4` along with either\nthe index of the selected item or the selected item's text. If the dialog\ntimed out, returns `0` or `"timeout"`. If the user canceled the dialog,\nreturns `-1` or `"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 or the dialog's exit\n status along with the selected item's text instead of the button's index\n or the exit code along with the item's index. The default value is\n `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n 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)\nReturns a string containing a binary representation of the given\nfunction, so that a later `load` on this string returns a copy of the\nfunction (but with new upvalues). edge_colour buffer.edge_colour (number)\nThe color, in "0xBBGGRR" format, marking long lines. edge_column buffer.edge_column (number)\nThe column number to start marking long lines at. @@ -601,12 +602,12 @@ ensure_visible buffer.ensure_visible(buffer, line)\nEnsures line number *line* i ensure_visible_enforce_policy buffer.ensure_visible_enforce_policy(buffer, line)\nEnsures line number *line* is visible by expanding any fold header lines\nhiding it and applies the vertical caret policy set with\n`buffer:set_visible_policy()`.\n@param buffer The global buffer.\n@param line The line number in *buffer* to ensure visible. enter_mode ui.command_entry.enter_mode(mode)\nOpens the command entry in key mode *mode*.\nKey bindings will be looked up in `keys[mode]` instead of `keys`. The `Esc`\n(`⎋` on Mac OSX | `Esc` in curses) key exits the current mode, closes the\ncommand entry, and restores normal key lookup.\nThis function is useful for binding keys to enter a command entry mode.\n@param mode The key mode to enter into, or `nil` to exit the current mode.\n@usage keys['ce'] = {ui.command_entry.enter_mode, 'command_entry'}\n@see _G.keys.MODE entry_text ui.command_entry.entry_text (string)\nThe text in the command entry. -eol_mode buffer.eol_mode (number)\nThe current end of line mode. Changing the mode does not convert existing\nline endings. Use `buffer:convert_eo_ls()` to do so.\n\n* `buffer.EOL_CRLF`\n Carriage return with line feed ("\r\n").\n* `buffer.EOL_CR`\n Carriage return ("\r").\n* `buffer.EOL_LF`\n Line feed ("\n").\n\nThe default value is `buffer.EOL_CRLF` on Windows platforms,\n`buffer.EOL_LF` otherwise. +eol_mode buffer.eol_mode (number)\nThe current end of line mode. Changing the mode does not convert existing\nline endings. Use `buffer:convert_eols()` to do so.\n\n* `buffer.EOL_CRLF`\n Carriage return with line feed ("\r\n").\n* `buffer.EOL_CR`\n Carriage return ("\r").\n* `buffer.EOL_LF`\n Line feed ("\n").\n\nThe default value is `buffer.EOL_CRLF` on Windows platforms,\n`buffer.EOL_LF` otherwise. error _G.error(message [, level])\nTerminates the last protected function called and returns `message`\nas the error message. Function `error` never returns.\n\nUsually, `error` adds some information about the error position at the\nbeginning of the message, if the message is a string. The `level` argument\nspecifies how to get the error position. With level 1 (the default), the\nerror position is where the `error` function was called. Level 2 points the\nerror to where the function that called `error` was called; and so on.\nPassing a level 0 avoids the addition of error position information to the\nmessage. -error_detail textadept.run.error_detail (table)\nMap of lexer names to their error string details, tables containing the\nfollowing fields:\n\n + `pattern`: A Lua pattern that matches the language's error string,\n capturing the filename the error occurs in, the line number the error\n occurred on, and optionally the error message.\n + `filename`: The numeric index of the Lua capture containing the filename\n the error occurred in.\n + `line`: The numeric index of the Lua capture containing the line number\n the error occurred on.\n + `message`: (Optional) The numeric index of the Lua capture containing the\n error's message. An annotation will be displayed if a message was\n captured.\n\nWhen an error message is double-clicked, the user is taken to the point of\nerror.\nThis table is usually populated by language modules. +error_patterns textadept.run.error_patterns (table)\nList of warning and error string patterns that match various compile and run\nwarnings and errors.\nPatterns contain filename, line number, and optional warning or error message\ncaptures for single lines. When a warning or error message is double-clicked,\nthe user is taken to the point of warning/error.\nWhen adding to this list, use `(.-)` to match filenames and `(%d+)` to match\nline numbers. Also keep in mind that patterns are matched in sequential\norder; once a pattern matches, no more are tried. events _G.events (module)\nTextadept's core event structure and handlers. execute os.execute([command])\nThis function is equivalent to the ANSI C function `system`. It passes\n`command` to be executed by an operating system shell. Its first result is\n`true` if the command terminated successfully, or `nil` otherwise. After this\nfirst result the function returns a string and a number, as follows:\n "exit": the command terminated normally; the following number is the exit\n status of the command.\n "signal": the command was terminated by a signal; the following number is\n the signal that terminated the command.\n\nWhen called without a `command`, `os.execute` returns a boolean that is true\nif a shell is available. -execute_lua ui.command_entry.execute_lua(code)\nExecutes string *code* as Lua code.\nCode is subject to an "abbreviated" environment where the `buffer`, `view`,\nand `ui` tables are also considered as globals.\nPrints the results of '=' expressions like in the Lua prompt.\n@param code The Lua code to execute. +execute_lua ui.command_entry.execute_lua(code)\nExecutes string *code* as Lua code.\nCode is subject to an "abbreviated" environment where the contents of the\n`buffer`, `view`, and `ui` tables are also considered as globals.\nPrints the results of '=' expressions like in the Lua prompt.\n@param code The Lua code to execute. exit os.exit([code [, close]])\nCalls the ANSI C function `exit` to terminate the host program. If `code` is\n`true`, the returned status is `EXIT_SUCCESS`; if `code` is `false`, the\nreturned status is `EXIT_FAILURE`; if `code` is a number, the returned status\nis this number. The default value for `code` is `true`.\n\nIf the optional second argument `close` is true, closes the Lua state before\nexiting. exp math.exp(x)\nReturns the value *e^x*. expand_children buffer.expand_children(buffer, line, level)\nExpands the fold states of the fold header on line number *line* and its\nchildren with fold level *level*.\n@param buffer The global buffer.\n@param line The line number in *buffer* to expand the folds for.\n@param level The previous fold level of *line*, not the current one. This is\n because this function is used to respond to changes in a line's fold level\n or fold header status, so a new fold level has already been set. @@ -617,8 +618,10 @@ extra_descent buffer.extra_descent (number)\nThe amount of pixel padding below l extract bit32.extract(n, field [, width])\nReturns the unsigned number formed by the bits `field` to `field + width - 1`\nfrom `n`. Bits are numbered from 0 (least significant) to 31 (most\nsignificant). All accessed bits must be in the range [0, 31].\n\nThe default for `width` is 1. file_types textadept.file_types (module)\nHandles file type detection for Textadept. filename buffer.filename (string)\nThe absolute path to the file associated with the buffer. +filesave ui.dialogs.filesave(options)\nPrompts the user with a file save dialog defined by dialog options table\n*options*, returning the string file chosen.\nIf the user canceled the dialog, returns `nil`.\n@param options Table of key-value option pairs for the dialog.\n\n * `title`: The dialog's title text.\n * `with_directory`: The initial filesystem directory to show.\n * `with_file`: The initially chosen filename. This option requires\n `with_directory` to be set.\n * `with_extension`: The list of extensions selectable files must have.\n * `no_create_directories`: Prevent the user from creating new directories.\n The default value is `false`.\n@return filename or nil +fileselect ui.dialogs.fileselect(options)\nPrompts the user with a file selection dialog defined by dialog options\ntable *options*, returning the string file selected or, if\n*options*.`select_multiple` is `true`, the list of files selected.\nIf the user canceled the dialog, returns `nil`.\n@param options Table of key-value option pairs for the dialog.\n\n * `title`: The dialog's title text.\n * `with_directory`: The initial filesystem directory to show.\n * `with_file`: The initially selected filename. This option requires\n `with_directory` to be set.\n * `with_extension`: The list of extensions selectable files must have.\n * `select_multiple`: Allow the user to select multiple files. The default\n value is `false`.\n * `select_only_directories`: Only allow the user to select directories. The\n default value is `false`.\n@usage ui.dialogs.fileselect{title = 'Open C File', with_directory = _HOME,\n with_extension = {'c', 'h'}, select_multiple = true}\n@return filename, list of filenames, or nil filter_through textadept.editing.filter_through(command)\nPasses selected or all buffer text to string shell command *command* as\nstandard input (stdin) and replaces the input text with the command's\nstandard output (stdout).\nStandard input is as follows:\n\n1. If text is selected and spans multiple lines, all text on the lines\ncontaining the selection is used. However, if the end of the selection is at\nthe beginning of a line, only the EOL (end of line) characters from the\nprevious line are included as input. The rest of the line is excluded.\n2. If text is selected and spans a single line, only the selected text is\nused.\n3. If no text is selected, the entire buffer is used.\n@param command The Linux, BSD, Mac OSX, or Windows shell command to filter\n text through. -filteredlist ui.filteredlist(title, columns, items, int_return, ...)\nConvenience function for `ui.dialog('filteredlist', ...)` with "Ok" and\n"Cancel" buttons that returns the text or index of the selection depending on\nthe boolean value of *int_return*.\n*title* is the title of the dialog, *columns* is a list of column names, and\n*items* is a list of items to show.\n@param title The title for the filtered list dialog.\n@param columns A column name or list of column names.\n@param items An item or list of items.\n@param int_return Optional flag indicating whether to return the integer\n index of the selected item in the filtered list or the string selected\n item. A `true` value is not compatible with the `'--select-multiple'`\n option. The default value is `false`.\n@param ... Optional additional parameters to pass to `ui.dialog()`.\n@usage ui.filteredlist('Title', 'Foo', {'Bar', 'Baz'})\n@usage ui.filteredlist('Title', {'Foo', 'Bar'}, {'a', 'b', 'c', 'd'}, false,\n '--output-column', '2')\n@return Either a string or integer on success; `nil` otherwise. In strings,\n multiple items are separated by newlines.\n@see dialog +filteredlist ui.dialogs.filteredlist(options)\nPrompts the user with a filtered list item selection dialog defined by dialog\noptions table *options*, returning the index of the selected button along\nwith the index(es) of the selected item(s) (depending on whether or not\n*options*.`select_multiple` is `true`) or, if *options*.`string_output` is\n`true`, the selected button's label along with the selected item's or items'\ntext.\nIf the dialog timed out, returns `0` or `"timeout"`. If the user canceled the\ndialog, returns `-1` or `"delete"`.\nSpaces in the filter text are treated as wildcards.\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 * `columns`: The list of string column names for list rows.\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 * `select_multiple`: Allow the user to select multiple items. The default\n value is `false`.\n * `search_column`: The column number to filter the input text against. The\n default value is `1`. This option requires `columns` to be set and\n contain at least *n* column names.\n * `output_column`: The column number to use for `string_output`. The\n default value is `1`. This option requires `columns` to be set and\n contain at least *n* column names.\n * `string_output`: Return the selected button's label or the dialog's exit\n status along with the selected item's text instead of the button's index\n or the exit code along with the item's index. The default value is\n `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@usage ui.dialogs.filteredlist{title = 'Title', columns = {'Foo', 'Bar'},\n items = {'a', 'b', 'c', 'd'}}\n@return selected button or exit code, selected item or list of selected items find string.find(s, pattern [, init [, plain]])\nLooks for the first match of `pattern` in the string `s`. If it finds a\nmatch, then `find` returns the indices of `s` where this occurrence starts\nand ends; otherwise, it returns nil. A third, optional numerical argument\n`init` specifies where to start the search; its default value is 1 and\ncan be negative. A value of true as a fourth, optional argument `plain`\nturns off the pattern matching facilities, so the function does a plain\n"find substring" operation, with no characters in `pattern` being considered\nmagic. Note that if `plain` is given, then `init` must be given as well.\n\nIf the pattern has captures, then in a successful match the captured values\nare also returned, after the two indices. find ui.find (module)\nTextadept's Find & Replace pane. find_column buffer.find_column(buffer, line, column)\nReturns the position of column number *column* on line number *line*, taking\ntab and multi-byte characters into account, or the position at the end of\nline *line*.\n@param buffer The global buffer.\n@param line The line number in *buffer* to use.\n@param column The column number to use. @@ -680,11 +683,11 @@ getuservalue debug.getuservalue(u)\nReturns the Lua value associated to `u`. If gmatch string.gmatch(s, pattern)\nReturns an iterator function that, each time it is called, returns the\nnext captures from `pattern` over the string `s`. If `pattern` specifies no\ncaptures, then the whole match is produced in each call.\n\nAs an example, the following loop will iterate over all the words from string\n`s`, printing one per line:\n\n s = "hello world from Lua"\n for w in string.gmatch(s, "%a+") do\n print(w)\n end\n\nThe next example collects all pairs `key=value` from the given string into a\ntable:\n\n t = {}\n s = "from=world, to=Lua"\n for k, v in string.gmatch(s, "(%w+)=(%w+)") do\n t[k] = v\n end\n\nFor this function, a caret '`^`' at the start of a pattern does not work as\nan anchor, as this would prevent the iteration. goto_buffer view.goto_buffer(view, n, relative)\nGoes to buffer number *n* in the view.\n*relative* indicates whether or not *n* is an index relative to the index of\nthe current buffer in `_G._BUFFERS` instead of an absolute index.\nEmits `BUFFER_BEFORE_SWITCH` and `BUFFER_AFTER_SWITCH` events.\n@param view The view to switch buffers in.\n@param n A relative or absolute buffer index in `_G._BUFFERS`. An absolute\n index of `-1` goes to the last buffer.\n@param relative Optional flag indicating whether *n* is a relative or\n absolute index. The default value is `false`, for an absolute index.\n@see _G._G._BUFFERS\n@see events.BUFFER_BEFORE_SWITCH\n@see events.BUFFER_AFTER_SWITCH goto_ctag textadept.adeptsense.goto_ctag(sense, kind, title)\nPrompts the user to select a symbol to jump to from a list of all known\nsymbols of kind *kind* (classes, functions, fields, etc.) shown in a filtered\nlist dialog whose title text is *title*.\n@param sense The Adeptsense returned by `adeptsense.new()`.\n@param kind The Ctag character kind (e.g. `'f'` for a Lua function).\n@param title The title for the filtered list dialog. -goto_error textadept.run.goto_error(line, next)\nGoes to the source of the recognized compile/run error on line number *line*\nin the message buffer or the next or previous recognized error depending on\nboolean *next*.\nDisplays an annotation with the error message, if available.\n@param line The line number in the message buffer that contains the\n compile/run error to go to.\n@param next Optional flag indicating whether to go to the next recognized\n error or the previous one. Only applicable when *line* is `nil` or `false`.\n@see error_detail\n@see cwd +goto_error textadept.run.goto_error(line, next)\nGoes to the source of the recognized compile/run warning or error on line\nnumber *line* in the message buffer or the next or previous recognized\nwarning or error depending on boolean *next*.\nDisplays an annotation with the warning or error message, if available.\n@param line The line number in the message buffer that contains the\n compile/run warning/error to go to.\n@param next Optional flag indicating whether to go to the next recognized\n warning/error or the previous one. Only applicable when *line* is `nil` or\n `false`.\n@see error_patterns\n@see cwd goto_file ui.goto_file(filename, split, preferred_view, sloppy)\nGoes to the buffer whose filename is *filename* in an existing view,\notherwise splitting the current view if *split* is `true` or going to the\nnext or *preferred_view* view instead of staying in the current one.\n*sloppy* indicates whether or not only the last part of *filename* is matched\nto a buffer's `filename`.\n@param filename The filename of the buffer to go to.\n@param split Optional flag indicating whether or not to open the buffer in a\n split view if there is only one view. The default value is `false`.\n@param preferred_view Optional view to open the desired buffer in if the\n buffer is not visible in any other view.\n@param sloppy Optional flag indicating whether or not to not match *filename*\n to `buffer.filename` exactly. When `true`, matches *filename* to only the\n last part of `buffer.filename` This is useful for run and compile commands\n which output relative filenames and paths instead of full ones and it is\n likely that the file in question is already open. The default value is\n `false`. goto_file_found ui.find.goto_file_found(line, next)\nGoes to the source of the find in files search result on line number *line*\nin the files found buffer, or if `nil`, the next or previous search result\ndepending on boolean *next*.\n@param line The line number in the files found buffer that contains the\n search result to go to.\n@param next Optional flag indicating whether to go to the next search result\n or the previous one. Only applicable when *line* is `nil` or `false`. goto_line buffer.goto_line(buffer, line)\nMoves the caret to the beginning of line number *line* and scrolls it into\nview.\n@param buffer The global buffer.\n@param line The line number in *buffer* to go to. -goto_line textadept.editing.goto_line(line)\nMoves the caret to the beginning of line number *line* or the user-specified\nline, ensuring the line is visible.\n@param line Optional line number to go to. If `nil`, the user is prompted for\n one. +goto_line textadept.editing.goto_line(line)\nMoves the caret to the beginning of line number *line* or user-specified\nline, ensuring the line is visible.\n@param line Optional line number to go to. If `nil`, the user is prompted for\n one. goto_mark textadept.bookmarks.goto_mark(next)\nPrompts the user to select a bookmarked line to move the caret to the\nbeginning of unless *next* is given.\nIf *next* is `true` or `false`, moves the caret to the beginning of the next\nor previously bookmarked line, respectively.\n@param next Optional flag indicating whether to go to the next or previous\n bookmarked line relative to the current line. The default value is `nil`,\n prompting the user for a bookmarked line to go to. goto_pos buffer.goto_pos(buffer, pos)\nMoves the caret to position *pos* and scrolls it into view.\n@param buffer The global buffer.\n@param pos The position in *buffer* to go to. goto_view ui.goto_view(n, relative)\nGoes to view number *n*.\n*relative* indicates whether or not *n* is an index relative to the index of\nthe current view in `_G._VIEWS` instead of an absolute index.\nEmits `VIEW_BEFORE_SWITCH` and `VIEW_AFTER_SWITCH` events.\n@param n A relative or absolute view index in `_G._VIEWS`.\n@param relative Optional flag indicating whether *n* is a relative or\n absolute index. The default value is `false`, for an absolute index.\n@see _G._G._VIEWS\n@see events.VIEW_BEFORE_SWITCH\n@see events.VIEW_AFTER_SWITCH @@ -730,6 +733,7 @@ indicator_fill_range buffer.indicator_fill_range(buffer, pos, fill_length)\nSets indicator_start buffer.indicator_start(buffer, indicator, pos)\nReturns the position of the beginning of indicator number *indicator*, in the\nrange of `0` to `31`, at position *pos*.\n@param buffer The global buffer.\n@param indicator An indicator number in the range of `0` to `31`.\n@param pos The position in *buffer* of the indicator. inherited_classes textadept.adeptsense.inherited_classes (table)\nA map of classes and a list of their inherited classes, normally populated by\n`load_ctags()`. input io.input([file])\nWhen called with a file name, it opens the named file (in text mode),\nand sets its handle as the default input file. When called with a file\nhandle, it simply sets this file handle as the default input file. When\ncalled without parameters, it returns the current default input file.\n\nIn case of errors this function raises the error, instead of returning an\nerror code. +inputbox ui.dialogs.inputbox(options)\nPrompts the user with a one-line input box dialog defined by dialog options\ntable *options*, returning the index of the selected button along with the\ninput text or, if *options*.`string_output` is `true`, the selected button's\nlabel along with the input text.\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 input box.\n\n * `title`: The dialog's title text.\n * `informative_text`: The dialog's main message text.\n * `text`: The dialog's initial input text.\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 or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@usage ui.dialogs.inputbox{title = 'Goto Line', informative_text = 'Line:',\n text = '1'}\n@return selected button or exit code, input text insert table.insert(list, [pos, ] value)\nInserts element `value` at position `pos` in `list`, shifting up the elements\n`list[pos], list[pos+1], ···, list[#list]`. The default value for `pos` is\n`#list+1`, so that a call `table.insert(t,x)` inserts `x` at the end of list\n`t`. insert_text buffer.insert_text(buffer, pos, text)\nInserts string *text* at position *pos* or the caret position if *pos* is\n`-1`, removing any selections.\nIf the caret is after the *pos*, it is moved appropriately, but not scrolled\ninto view.\n@param buffer The global buffer.\n@param pos The position in *buffer* to insert text at, or `-1` for the\n current position.\n@param text The text to insert. integer lexer.integer (pattern)\nA pattern that matches a decimal, hexadecimal, or octal number. @@ -826,7 +830,7 @@ marker_add buffer.marker_add(buffer, line, marker_num)\nAdds marker number *mark marker_add_set buffer.marker_add_set(buffer, line, marker_mask)\nAdds the markers specified in the marker bit-mask *marker_mask* to line\nnumber *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 The global 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. marker_back buffer.marker_back (table, Write-only)\nTable of background colors, in "0xBBGGRR" format, of marker numbers from\n`0` to `31`. -marker_back_selected buffer.marker_back_selected (table, Write-only)\nTable of background colors, in "0xBBGGRR" format, of markers whose folding\nblocks are selected for marker numbers from `0` to `31`.\nThe default values are `0x0000FF`. +marker_back_selected buffer.marker_back_selected (table, Write-only)\nTable of background colors, in "0xBBGGRR" format, of markers whose folding\nblocks are selected for marker numbers from `0` to `31`. marker_define buffer.marker_define(buffer, marker_num, marker_symbol)\nAssociates marker number *marker_num*, in the range of `0` to `31`, with\nsymbol *marker_symbol*.\n*marker_symbol* is shown in symbol margins next to lines marked with\n*marker_num*.\n@param buffer The global buffer.\n@param marker_num The marker number in the range of `0` to `31` to set\n *marker_symbol* for.\n@param marker_symbol The marker symbol: `buffer.MARK_*`.\n@see _SCINTILLA.next_marker_number marker_define_pixmap buffer.marker_define_pixmap(buffer, marker_num, pixmap)\nAssociates marker number *marker_num*, in the range of `0` to `31`, with XPM\nimage *pixmap*.\nThe `buffer.MARK_PIXMAP` symbol must be associated with *marker_num*.\nThe image is shown in symbol margins next to lines marked with *marker_num*.\n@param buffer The global buffer.\n@param marker_num The marker number in the range of `0` to `31` to define\n pixmap *pixmap* for.\n@param pixmap The string pixmap data. marker_define_rgba_image buffer.marker_define_rgba_image(buffer, marker_num, pixels)\nAssociates marker number *marker_num*, in the range of `0` to `31`, with RGBA\nimage *pixels*.\nThe dimensions for *pixels*, `buffer.rgba_image_width` and\n`buffer.rgba_image_height`, must have already been defined. *pixels* is a\nsequence of 4 byte pixel values (red, blue, green, and alpha) defining the\nimage line by line starting at the top-left pixel.\nThe `buffer.MARK_RGBAIMAGE` symbol must be associated with *marker_num*.\nThe image is shown in symbol margins next to lines marked with *marker_num*.\nRGBA image markers use the `buffer.MARK_RGBAIMAGE` marker symbol.\n@param buffer The global buffer.\n@param marker_num The marker number in the range of `0` to `31` to define\n RGBA data *pixels* for.\n@param pixels The string sequence of 4 byte pixel values starting with the\n pixels for the top line, with the leftmost pixel first, then continuing\n with the pixels for subsequent lines. There is no gap between lines for\n alignment reasons. Each pixel consists of, in order, a red byte, a green\n byte, a blue byte and an alpha byte. The colour bytes are not premultiplied\n by the alpha value. That is, a fully red pixel that is 25% opaque will be\n `[FF, 00, 00, 3F]`. @@ -859,6 +863,7 @@ mouse_dwell_time buffer.mouse_dwell_time (number)\nThe number of milliseconds th move_caret_inside_view buffer.move_caret_inside_view(buffer)\nMoves the caret into view if it is not already, removing any selections.\n@param buffer The global buffer. move_selected_lines_down buffer.move_selected_lines_down(buffer)\nMoves the selected lines down one line.\n@param buffer The global buffer. move_selected_lines_up buffer.move_selected_lines_up(buffer)\nMoves the selected lines up one line.\n@param buffer The global buffer. +msgbox ui.dialogs.msgbox(options)\nPrompts the user with a generic message box dialog defined by dialog options\ntable *options*, returning the index of the selected button or, if\n*options*.`string_output` is `true`, 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 or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n 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_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_selection buffer.multiple_selection (bool)\nEnable multiple selection.\nThe default value is `false`. nested_pair lexer.nested_pair(start_chars, end_chars)\nSimilar to `delimited_range()`, but allows for multi-character, nested\ndelimiters *start_chars* and *end_chars*.\nWith single-character delimiters, this function is identical to\n`delimited_range(start_chars..end_chars, false, true, true)`.\n@param start_chars The string starting a nested sequence.\n@param end_chars The string ending a nested sequence.\n@usage local nested_comment = l.nested_pair('/*', '*/')\n@return pattern\n@see delimited_range @@ -873,8 +878,9 @@ next_user_list_type _SCINTILLA.next_user_list_type()\nReturns a unique user list nonnewline lexer.nonnewline (pattern)\nA pattern that matches any non-newline character. nonnewline_esc lexer.nonnewline_esc (pattern)\nA pattern that matches any non-newline character, excluding newlines\nescaped with '\'. oct_num lexer.oct_num (pattern)\nA pattern that matches an octal number. +ok_msgbox ui.dialogs.ok_msgbox(options)\nPrompts the user with a generic message box dialog defined by dialog options\ntable *options* and with localized "Ok" and "Cancel" buttons, returning the\nindex of the selected button or, if *options*.`string_output` is `true`, the\nselected 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 * `no_cancel`: Do not display the "Cancel" button. The default value is\n `false`.\n * `string_output`: Return the selected button's label or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@return selected button or exit code open io.open(filename [, mode])\nThis function opens a file, in the mode specified in the string `mode`. It\nreturns a new file handle, or, in case of errors, nil plus an error message.\n\nThe `mode` string can be any of the following:\n "r": read mode (the default);\n "w": write mode;\n "a": append mode;\n "r+": update mode, all previous data is preserved;\n "w+": update mode, all previous data is erased;\n "a+": append update mode, previous data is preserved, writing is only\n allowed at the end of file.\n\nThe `mode` string can also have a '`b`' at the end, which is needed in\nsome systems to open the file in binary mode. -open_file io.open_file(filenames)\nOpens *filenames*, a "\n" delimited string of filenames, or user-selected\nfiles.\nEmits a `FILE_OPENED` event.\n@param filenames Optional string list filenames to open. If `nil`, the user\n is prompted with a fileselect dialog.\n@see _G.events +open_file io.open_file(filenames)\nOpens *filenames*, a string filename, table of filenames, or user-selected\nfilenames.\nEmits a `FILE_OPENED` event.\n@param filenames Optional string filename or table of filenames to open. If\n `nil`, the user is prompted with a fileselect dialog.\n@see _G.events open_recent_file io.open_recent_file()\nPrompts the user to open a recently opened file.\n@see recent_files os _G.os (module)\nLua os module. output io.output([file])\nSimilar to `io.input`, but operates over the default output file. @@ -981,11 +987,11 @@ rshift bit32.rshift(x, disp)\nReturns the number `x` shifted `disp` bits to the ruby _G.keys.ruby (table)\nContainer for Ruby-specific key bindings. ruby _G.snippets.ruby (table)\nContainer for Ruby-specific snippets. ruby _M.ruby (module)\nThe ruby module.\nIt provides utilities for editing Ruby code. -run textadept.run (module)\nCompile and run/execute source files with Textadept.\nTypically, language modules populate the `compile_command`,\n`run_command`, and `error_detail` tables for a particular language's file\nextension. -run textadept.run.run()\nRuns/executes the file based on its extension using the command from the\n`run_command` table.\nEmits a `RUN_OUTPUT` event.\n@see run_command\n@see _G.events -run_command textadept.run.run_command (table)\nMap of file extensions (excluding the leading '.') to their associated\n"run" shell command line strings or functions returning such strings.\nCommand line strings may have the following macros:\n\n + `%(filepath)`: The full path of the current file.\n + `%(filedir)`: The current file's directory path.\n + `%(filename)`: The name of the file, including its extension.\n + `%(filename_noext)`: The name of the file, excluding its extension.\n\nThis table is typically populated by language modules. +run textadept.run (module)\nCompile and run/execute source files with Textadept.\nLanguage modules may tweak the `compile_commands`, `run_commands`, and/or\n`error_patterns` tables for particular languages. +run textadept.run.run()\nRuns/executes the file based on its extension or lexer, using the command\nfrom the `run_commands` table.\nEmits a `RUN_OUTPUT` event.\n@see run_commands\n@see _G.events +run_commands textadept.run.run_commands (table)\nMap of file extensions (excluding the leading '.') or lexers to their\nassociated "run" shell command line strings or functions returning such\nstrings.\nCommand line strings may have the following macros:\n\n + `%(filepath)`: The full path of the current file.\n + `%(filedir)`: The current file's directory path.\n + `%(filename)`: The name of the file, including its extension.\n + `%(filename_noext)`: The name of the file, excluding its extension. running coroutine.running()\nReturns the running coroutine plus a boolean, true when the running coroutine\nis the main one. -save textadept.session.save(filename)\nSaves a Textadept session to file *filename* or a user-selected file.\nSaves split views, opened buffers, cursor information, and recent files.\n@param filename Optional absolute path to the session file to save. If `nil`,\n the user is prompted for one.\n@usage textadept.session.save(filename)\n@see DEFAULT_SESSION +save textadept.session.save(filename)\nSaves a Textadept session to file *filename* or user-selected file.\nSaves split views, opened buffers, cursor information, and recent files.\n@param filename Optional absolute path to the session file to save. If `nil`,\n the user is prompted for one.\n@usage textadept.session.save(filename)\n@see DEFAULT_SESSION save_all_files io.save_all_files()\nSaves all unsaved buffers to their respective files.\n@see io.save_file save_file io.save_file()\nSaves the current buffer to its file.\nEmits `FILE_BEFORE_SAVE` and `FILE_AFTER_SAVE` events. save_file_as io.save_file_as(filename)\nSaves the current buffer to file *filename* or user-specified filename.\nEmits a `FILE_SAVED_AS` event.\n@param filename Optional new filepath to save the buffer to. If `nil`, the\n user is prompted for one. @@ -1002,6 +1008,8 @@ search_next buffer.search_next(buffer, flags, text)\nSearches for and selects th search_prev buffer.search_prev(buffer, flags, text)\nSearches for and selects the last occurrence of string *text* before the\nsearch anchor using search flags *flags*, returning the position of the\noccurrence or `-1`.\n@param buffer The global buffer.\n@param flags The search flags to use. See `buffer.search_flags`.\n@param text The text to search for.\n@return number\n@see search_flags searchers package.searchers (table)\nA table used by `require` to control how to load modules.\nEach entry in this table is a *searcher function*. When looking for a\nmodule, `require` calls each of these searchers in ascending order, with\nthe module name (the argument given to `require`) as its sole parameter.\nThe function can return another function (the module *loader*) plus an\nextra value that will be passed to that loader, or a string explaining why\nit did not find that module (or nil if it has nothing to say).\nLua initializes this table with four functions.\nThe first searcher simply looks for a loader in the `package.preload`\ntable.\nThe second searcher looks for a loader as a Lua library, using the path\nstored at `package.path`. The search is done as described in function\n`package.searchpath`.\nThe third searcher looks for a loader as a C library, using the path given\nby the variable `package.cpath`. Again, the search is done as described in\nfunction `package.searchpath`. For instance, if the C path is the string\n "./?.so;./?.dll;/usr/local/?/init.so"\nthe searcher for module `foo` will try to open the files `./foo.so`,\n`./foo.dll`, and `/usr/local/foo/init.so`, in that order. Once it finds\na C library, this searcher first uses a dynamic link facility to link the\napplication with the library. Then it tries to find a C function inside the\nlibrary to be used as the loader. The name of this C function is the string\n"`luaopen_`" concatenated with a copy of the module name where each dot\nis replaced by an underscore. Moreover, if the module name has a hyphen,\nits prefix up to (and including) the first hyphen is removed. For instance,\nif the module name is `a.v1-b.c`, the function name will be `luaopen_b_c`.\nThe fourth searcher tries an *all-in-one loader*. It searches the C\npath for a library for the root name of the given module. For instance,\nwhen requiring `a.b.c`, it will search for a C library for `a`. If found,\nit looks into it for an open function for the submodule; in our example,\nthat would be `luaopen_a_b_c`. With this facility, a package can pack\nseveral C submodules into one single library, with each submodule keeping\nits original open function.\nAll searchers except the first one (preload) return as the extra value the\nfile name where the module was found, as returned by `package.searchpath`.\nThe first searcher returns no extra value. searchpath package.searchpath(name, path [, sep [, rep]])\nSearches for the given `name` in the given `path`.\n\nA path is a string containing a sequence of _templates_ separated by\nsemicolons. For each template, the function replaces each interrogation mark\n(if any) in the template with a copy of `name` wherein all occurrences of\n`sep` (a dot, by default) were replaced by `rep` (the system's directory\nseparator, by default), and then tries to open the resulting file name.\nFor instance, if the path is the string\n "./?.lua;./?.lc;/usr/local/?/init.lua"\nthe search for the name `foo.a` will try to open the files `./foo/a.lua`,\n`./foo/a.lc`, and `/usr/local/foo/a/init.lua`, in that order.\nReturns the resulting name of the first file that it can open in read mode\n(after closing the file), or nil plus an error message if none succeeds.\n(This error message lists all file names it tried to open.) +secure_inputbox ui.dialogs.secure_inputbox(options)\nPrompts the user with a one-line masked input box dialog defined by dialog\noptions table *options*, returning the index of the selected button along\nwith the input text or, if *options*.`string_output` is `true`, the selected\nbutton's label along with the input text.\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 input box.\n\n * `title`: The dialog's title text.\n * `informative_text`: The dialog's main message text.\n * `text`: The dialog's initial input text.\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 or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@return selected button or exit code, input text +secure_standard_inputbox ui.dialogs.secure_standard_inputbox(options)\nPrompts the user with a one-line masked input box dialog defined by dialog\noptions table *options* and with localized "Ok" and "Cancel" buttons,\nreturning the index of the selected button along with the input text or, if\n*options*.`string_output` is `true`, the selected button's label along with\nthe input text.\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 input box.\n\n * `title`: The dialog's title text.\n * `informative_text`: The dialog's main message text.\n * `text`: The dialog's initial input text.\n * `no_cancel`: Do not display the "Cancel" button. The default value is\n `false`.\n * `string_output`: Return the selected button's label or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@return selected button or exit code, input text seek file:seek([whence [, offset]])\nSets and gets the file position, measured from the beginning of the\nfile, to the position given by `offset` plus a base specified by the string\n`whence`, as follows:\n "set": base is position 0 (beginning of the file);\n "cur": base is current position;\n "end": base is end of file;\n\nIn case of success, function `seek` returns the final file position,\nmeasured in bytes from the beginning of the file. If `seek` fails, it returns\nnil, plus a string describing the error.\n\nThe default value for `whence` is `"cur"`, and for `offset` is 0. Therefore,\nthe call `file:seek()` returns the current file position, without changing\nit; the call `file:seek("set")` sets the position to the beginning of the\nfile (and returns 0); and the call `file:seek("end")` sets the position\nto the end of the file, and returns its size. sel_alpha buffer.sel_alpha (number)\nThe alpha value, ranging from `0` (transparent) to `255` (opaque), of the\nselection.\nThe default value is `buffer.ALPHA_NOALPHA`, for no alpha. sel_eol_filled buffer.sel_eol_filled (bool)\nExtend the selection to the right margin of the view.\nThe default value is `false`. @@ -1013,7 +1021,7 @@ select_indented_block textadept.editing.select_indented_block()\nSelects indente select_lexer textadept.file_types.select_lexer()\nPrompts the user to select a lexer for the current buffer.\n@see buffer.set_lexer select_line textadept.editing.select_line()\nSelects the current line. select_paragraph textadept.editing.select_paragraph()\nSelects the current paragraph.\nParagraphs are surrounded by one or more blank lines. -select_word textadept.editing.select_word()\nSelects the current word.\n@see buffer.word_chars +select_word textadept.editing.select_word()\nSelects the current word.\nIf already selected, selects the next occurrence as a multiple selection.\n@see buffer.word_chars selection_duplicate buffer.selection_duplicate(buffer)\nDuplicates the selected text to its right or the current line on a new line\nbelow.\n@param buffer The global buffer. selection_empty buffer.selection_empty (bool, Read-only)\nWhether or not no text is selected. selection_end buffer.selection_end (number)\nThe position of the end of the selected text.\nWhen set, becomes the current position, but is not scrolled into view. @@ -1039,7 +1047,7 @@ sense _M.rails.sense\nThe Rails Adeptsense.\n It loads user tags from *`_USERHO sense _M.rhtml.sense\nThe RHTML Adeptsense.\n It loads user tags from *`_USERHOME`/modules/rhtml/tags* and user apidocs\n from *`_USERHOME`/modules/rhtml/api*. sense _M.ruby.sense\nThe Ruby Adeptsense.\n It loads user tags from *`_USERHOME`/modules/ruby/tags* and user apidocs\n from *`_USERHOME`/modules/ruby/api*. session textadept.session (module)\nSession support for Textadept. -set_buffer_encoding io.set_buffer_encoding(encoding)\nConverts the current buffer's contents to string encoding *encoding*.\n@param encoding The string encoding to set. Valid encodings are ones that GNU\n iconv accepts.\n@usage io.set_buffer_encoding('ASCII') +set_buffer_encoding io.set_buffer_encoding(encoding)\nConverts the current buffer's contents to encoding *encoding*.\n@param encoding The string encoding to set. Valid encodings are ones that GNU\n iconv accepts.\n@usage io.set_buffer_encoding('ASCII') set_chars_default buffer.set_chars_default(buffer)\nResets `buffer.word_chars`, `buffer.whitespace_chars`, and\n`buffer.punctuation_chars` to their respective defaults.\n@param buffer The global buffer.\n@see word_chars\n@see whitespace_chars\n@see punctuation_chars set_contextmenu textadept.menu.set_contextmenu(menu)\nSets `ui.context_menu` from *menu*, an ordered list of menu items.\nMenu items are tables containing menu text and either a function to call or\na table containing a function with its parameters to call when an item is\nclicked. Menu items may also be sub-menus, ordered lists of menu items with\nan additional `title` key for the sub-menu's title text.\n@param menu The menu table to create the context menu from.\n@see ui.context_menu\n@see ui.menu set_empty_selection buffer.set_empty_selection(buffer, pos)\nMoves the caret to position *pos* without scrolling the view and removes any\nselections.\n@param buffer The buffer\n@param pos The position in *buffer* to move to. @@ -1081,13 +1089,15 @@ singular _M.rails.singular\nA map of plural controller names to their singulars. sinh math.sinh(x)\nReturns the hyperbolic sine of `x`. size ui.size (table)\nA table containing the width and height pixel values of the Textadept window. size view.size (number)\nThe pixel position of the split resizer if this view is part of a split\nview. -snapopen io.snapopen(paths, filter, exclude_FILTER, ...)\nQuickly open files from *paths*, a "\n" delimited string of directory paths,\nusing a filtered list dialog.\nFiles shown in the dialog do not match any pattern in string or table\n*filter*, and, unless *exclude_FILTER* is `true`, `lfs.FILTER` as well. A\nfilter table contains Lua patterns that match filenames to exclude, with\npatterns matching folders to exclude listed in a `folders` sub-table.\nPatterns starting with '!' exclude files and folders that do not match the\npattern that follows. Use a table of raw file extensions assigned to an\n`extensions` key for fast filtering by extension. The number of files in the\nlist is capped at `SNAPOPEN_MAX`.\n@param paths String list of directory paths to search.\n@param filter Optional filter for files and folders to exclude.\n@param exclude_FILTER Optional flag indicating whether or not to exclude the\n default filter `lfs.FILTER` in the search. If `false`, adds `lfs.FILTER` to\n *filter*.\n The default value is `false` to include the default filter.\n@param ... Optional additional parameters to pass to `ui.dialog()`.\n@usage io.snapopen(buffer.filename:match('^.+/')) -- list all files in the\n current file's directory, subject to the default filter\n@usage io.snapopen('/project', '!%.lua$') -- list all Lua files in a project\n directory\n@usage io.snapopen('/project', {folders = {'build'}}) -- list all source\n files in a project directory\n@see lfs.FILTER\n@see SNAPOPEN_MAX +snapopen io.snapopen(paths, filter, exclude_FILTER, opts)\nQuickly open files from *paths*, a string directory path or table of\ndirectory paths, using a filtered list dialog.\nFiles shown in the dialog do not match any pattern in string or table\n*filter*, and, unless *exclude_FILTER* is `true`, `lfs.FILTER` as well. A\nfilter table contains Lua patterns that match filenames to exclude, with\npatterns matching folders to exclude listed in a `folders` sub-table.\nPatterns starting with '!' exclude files and folders that do not match the\npattern that follows. Use a table of raw file extensions assigned to an\n`extensions` key for fast filtering by extension. The number of files in the\nlist is capped at `SNAPOPEN_MAX`.\n@param paths String directory path or table of directory paths to search.\n@param filter Optional filter for files and folders to exclude.\n@param exclude_FILTER Optional flag indicating whether or not to exclude the\n default filter `lfs.FILTER` in the search. If `false`, adds `lfs.FILTER` to\n *filter*.\n The default value is `false` to include the default filter.\n@param opts Optional additional options to pass to\n `ui.dialogs.filteredlist()`.\n@usage io.snapopen(buffer.filename:match('^.+/')) -- list all files in the\n current file's directory, subject to the default filter\n@usage io.snapopen('/project', '!%.lua$') -- list all Lua files in a project\n directory\n@usage io.snapopen('/project', {folders = {'build'}}) -- list all source\n files in a project directory\n@see lfs.FILTER\n@see SNAPOPEN_MAX snippets _G.snippets (table)\nMap of snippet triggers with their snippet text, with language-specific\nsnippets tables assigned to a lexer name key.\nThis table also contains the `textadept.snippets` module. snippets textadept.snippets (module)\nSnippets for Textadept. sort table.sort(list [, comp])\nSorts list elements in a given order, *in-place*, from `list[1]` to\n`list[#list]`. If `comp` is given, then it must be a function that receives\ntwo list elements and returns true when the first element must come before\nthe second in the final order (so that `not comp(list[i+1],list[i])` will be\ntrue after the sort). If `comp` is not given, then the standard Lua operator\n`<` is used instead.\n\nThe sort algorithm is not stable; that is, elements considered equal by the\ngiven order may have their relative positions changed by the sort. space lexer.space (pattern)\nA pattern that matches any whitespace character ('\t', '\v', '\f', '\n',\n'\r', space). split view.split(view, vertical)\nSplits the view into top and bottom views unless *vertical* is `true`,\nfocuses the new view, and returns both the old and new views.\nIf *vertical* is `false`, splits the view vertically into left and\nright views.\nEmits a `VIEW_NEW` event.\n@param view The view to split.\n@param vertical Optional flag indicating whether or not to split the view\n vertically. The default value is `false`, for horizontal.\n@return old view and new view.\n@see events.VIEW_NEW sqrt math.sqrt(x)\nReturns the square root of `x`. (You can also use the expression `x^0.5`\nto compute this value.) +standard_dropdown ui.dialogs.standard_dropdown(options)\nPrompts the user with a drop down item selection dialog defined by dialog\noptions table *options* and with localized "Ok" and "Cancel" buttons,\nreturning the index of the selected button along with the index of the\nselected item or, if *options*.`string_output` is `true`, the selected\nbutton's label along with the selected item's text.\nIf *options*.`exit_onchange` closed the dialog, returns `4` along with either\nthe index of the selected item or the selected item's text. If the dialog\ntimed out, returns `0` or `"timeout"`. If the user canceled the dialog,\nreturns `-1` or `"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 * `no_cancel`: Do not display the "Cancel" button. The default value is\n `false`.\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 or the dialog's exit\n status along with the selected item's text instead of the button's index\n or the exit code along with the item's index. The default value is\n `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@return selected button or exit code, selected item +standard_inputbux ui.dialogs.standard_inputbux(options)\nPrompts the user with a one-line input box dialog defined by dialog options\ntable *options* and with localized "Ok" and "Cancel" buttons, returning the\nindex of the selected button along with the input text or, if\n*options*.`string_output` is `true`, the selected button's label along with\nthe input text.\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 input box.\n\n * `title`: The dialog's title text.\n * `informative_text`: The dialog's main message text.\n * `text`: The dialog's initial input text.\n * `no_cancel`: Do not display the "Cancel" button. The default value is\n `false`.\n * `string_output`: Return the selected button's label or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@return selected button or exit code, input text start_styling buffer.start_styling(buffer, position, style_mask, styling_mask)\nBegin styling at position *position* with styling bit-mask *styling_mask*.\n*styling_mask* specifies which style bits can be set with\n`buffer:set_styling()`.\n@param buffer The global buffer.\n@param position The position in *buffer* to start styling at.\n@param styling_mask The bit mask of style bits that can be set when styling.\n@usage buffer:start_styling(0, 0xFF) starts_line lexer.starts_line(patt)\nCreates and returns a pattern that matches pattern *patt* only at the\nbeginning of a line.\n@param patt The LPeg pattern to match on the beginning of a line.\n@usage local preproc = token(l.PREPROCESSOR, #P('#') * l.starts_line('#' *\n l.nonnewline^0))\n@return pattern status coroutine.status(co)\nReturns the status of coroutine `co`, as a string: `"running"`, if\nthe coroutine is running (that is, it called `status`); `"suspended"`, if\nthe coroutine is suspended in a call to `yield`, or if it has not started\nrunning yet; `"normal"` if the coroutine is active but not running (that\nis, it has resumed another coroutine); and `"dead"` if the coroutine has\nfinished its body function, or if it has stopped with an error. @@ -1138,6 +1148,7 @@ text_length buffer.text_length (number, Read-only)\nThe number of bytes in the b text_range buffer.text_range(buffer, start_pos, end_pos)\nReturns the buffer's text between positions *start_pos* and *end_pos*.\n@param buffer The global buffer.\n@param start_pos The start position of the range of text to get in *buffer*.\n@param end_pos The end position of the range of text to get in *buffer*. text_width buffer.text_width(buffer, style_num, text)\nReturns the pixel width of string *text* styled with style number\n*style_num*, in the range of `0` to `255`.\n@param buffer The global buffer.\n@param style_num The style number between `0` and `255` to use.\n@param text The text to measure the width of.\n@return number textadept _G.textadept (module)\nThe textadept module.\nIt provides utilities for editing text in Textadept. +textbox ui.dialogs.textbox(options)\nPrompts the user with a multiple-line textbox dialog defined by dialog\noptions table *options*, returning the index of the selected button along\nwith the textbox text if *options*.`editable` is `true` or, if\n*options*.`string_output` is `true`, the selected button's label along with\nthe textbox text if *options*.`editable` is also `true`.\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 dialog.\n\n * `title`: The dialog's title text.\n * `informative_text`: The dialog's main message text.\n * `text`: The dialog's initial textbox text.\n * `text_from_file`: The filename whose contents are loaded into the\n textbox. This option has no effect when `text` is given.\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 * `editable`: Allows the user to edit the text in the textbox. The default\n value is `false`.\n * `focus_textbox`: Focus the textbox instead of the dialog buttons. The\n default value is `false`.\n * `scroll_to`: Where to scroll the textbox text when it is not all visible.\n The available values are `"top"` and `"bottom"`. The default value is\n `"top"`.\n * `selected`: Select all textbox text. The default value is `false`.\n * `monospaced_font`: Use a monospaced font in the textbox instead of a\n proportional one. The default value is `false`.\n * `string_output`: Return the selected button's label or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@usage ui.dialogs.textbox{title = 'License Agreement',\n informative_text = 'You agree to:', text_from_file = _HOME..'/LICENSE'}\n@return selected button or exit code, textbox text time os.time([table])\nReturns the current time when called without arguments, or a time\nrepresenting the date and time specified by the given table. This table\nmust have fields `year`, `month`, and `day`, and may have fields `hour`\n(default is 12), `min` (default is 0), `sec` (default is 0), and `isdst`\n(default is nil). For a description of these fields, see the `os.date`\nfunction.\n\nThe returned value is a number, whose meaning depends on your system. In\nPOSIX, Windows, and some other systems, this number counts the number of\nseconds since some given start time (the "epoch"). In other systems, the\nmeaning is not specified, and the number returned by `time` can be used only\nas an argument to `os.date` and `os.difftime`. timeout _G.timeout(interval, f, ...)\nCalls function *f* with the given arguments after *interval* seconds and then\nrepeatedly while *f* returns `true`. A `nil` or `false` return value stops\nrepetition.\n@param interval The interval in seconds to call *f* after.\n@param f The function to call.\n@param ... Additional arguments to pass to *f*. title ui.title (string, Write-only)\nThe title text of the Textadept window. @@ -1190,7 +1201,7 @@ view _G.view (module)\nA Textadept view object. view _G.view (table)\nThe current view. view_eol buffer.view_eol (bool)\nDisplay end of line characters.\nThe default value is `false`. view_ws buffer.view_ws (number)\nThe whitespace character visibility mode.\n\n* `buffer.WS_INVISIBLE`\n Whitespace is invisible.\n* `buffer.WS_VISIBLEALWAYS`\n Display all whitespace as dots and arrows.\n* `buffer.WS_VISIBLEAFTERINDENT`\n Display only non-indentation whitespace as dots and arrows.\n\nThe default value is `buffer.WS_INVISIBLE`. -virtual_space_options buffer.virtual_space_options (number)\nThe virtual space mode.\n\n* `buffer.VS_NONE`\n Disable virtual space.\n* `buffer.VS_RECTANGULARSELECTION`\n Enable virtual space only for rectangular selections.\n* `buffer.VS_USERACCESSIBLE`\n Enable virtual space.\n\nThe default value is `buffer.VS_NONE`. +virtual_space_options buffer.virtual_space_options (number)\nThe virtual space mode.\n\n* `buffer.VS_NONE`\n Disable virtual space.\n* `buffer.VS_RECTANGULARSELECTION`\n Enable virtual space only for rectangular selections.\n* `buffer.VS_USERACCESSIBLE`\n Enable virtual space.\n\nWhen virtual space is enabled, the caret may move into the space past the\nends of lines.\nThe default value is `buffer.VS_NONE`. visible_from_doc_line buffer.visible_from_doc_line(buffer, line)\nReturns the displayed line number of actual line number *line*, taking hidden\nlines into account, or `-1` if *line* is outside the range of lines in the\nbuffer.\nLines can occupy more than one display line if they wrap.\n@param buffer The global buffer.\n@param line The line number in *buffer* to use.\n@return number whitespace_chars buffer.whitespace_chars (string)\nThe string set of characters recognized as whitespace characters.\nSet this only after setting `buffer.word_chars`.\nThe default value is a string containing all non-newline characters less\nthan ASCII value 33. whitespace_size buffer.whitespace_size (number)\nThe pixel size of the dots representing space characters when whitespace is\nvisible.\nThe default value is `1`. @@ -1227,6 +1238,7 @@ x_offset buffer.x_offset (number)\nThe horizontal scroll position in pixels.\nA xdigit lexer.xdigit (pattern)\nA pattern that matches any hexadecimal digit ('0'-'9', 'A'-'F', 'a'-'f'). xor bit32.xor(...)\nReturns the bitwise "exclusive or" of its operands. xpcall _G.xpcall(f, msgh [, arg1, ···])\nThis function is similar to `pcall`, except that it sets a new message\nhandler `msgh`. +yesno_msgbox ui.dialogs.yesno_msgbox(options)\nPrompts the user with a generic message box dialog defined by dialog options\ntable *options* and with localized "Yes", "No", and "Cancel" buttons,\nreturning the index of the selected button or, if *options*.`string_output`\nis `true`, 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 * `no_cancel`: Do not display the "Cancel" button. The default value is\n `false`.\n * `string_output`: Return the selected button's label or the dialog's exit\n status instead of the button's index or the exit code. The default value\n is `false`.\n * `width`: The pixel width of the dialog.\n * `height`: The pixel height of the dialog.\n * `float`: Show the dialog on top of all desktop windows. The default value\n is `false`.\n * `timeout`: The number of seconds the dialog waits for the user to select\n a button before timing out. Dialogs do not time out by default.\n@return selected button or exit code yield coroutine.yield(···)\nSuspends the execution of the calling coroutine. Any arguments to `yield` are\npassed as extra results to `resume`. zoom buffer.zoom (number)\nThe number of points to add to the size of all fonts.\nNegative values are allowed.\nThe default value is `0`. zoom_in buffer.zoom_in(buffer)\nIncreases the size of all fonts by one point, up to 20.\n@param buffer The global buffer. |