aboutsummaryrefslogtreecommitdiff
path: root/modules/lua/api
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2011-07-29 18:27:06 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2011-07-29 18:27:06 -0400
commit36675f10b0cefaee7e9451b3eec3dfd715888625 (patch)
tree5a2135ef56b3e52bdf63fb4a82d4cec8c5e41eab /modules/lua/api
parent32da7ac1a36d2285daa3a0ee280f1730415f04cf (diff)
downloadtextadept-36675f10b0cefaee7e9451b3eec3dfd715888625.tar.gz
textadept-36675f10b0cefaee7e9451b3eec3dfd715888625.zip
Eliminated the need for keys.conf and keys.osx.conf.
Thanks to Robert Gieseke for the idea and prototype code.
Diffstat (limited to 'modules/lua/api')
-rw-r--r--modules/lua/api8
1 files changed, 6 insertions, 2 deletions
diff --git a/modules/lua/api b/modules/lua/api
index 4bf67f90..55cb8b22 100644
--- a/modules/lua/api
+++ b/modules/lua/api
@@ -853,6 +853,7 @@ comment_string _m.textadept.editing.comment_string [table]\nComment strings for
compile _m.textadept.run.compile()\nCompiles the file as specified by its extension in the compile_command table.\n@see compile_command\n
compile_command _m.textadept.run.compile_command [table]\nFile extensions and their associated 'compile' actions. Each key is a file\nextension whose value is a either a command line string to execute or a\nfunction returning one. This table is typically populated by language-specific\nmodules.\n
complete _m.textadept.adeptsense.complete(sense, only_fields, only_functions)\nShows an autocompletion list for the symbol behind the caret.\n@param sense The adeptsense returned by adeptsense.new().\n@param only_fields If true, returns list of only fields; defaults to false.\n@param only_functions If true, returns list of only functions; defaults\nto false.\n@return true on success or false.\n@see get_symbol\n@see get_completions\n
+complete_symbol _m.textadept.adeptsense.complete_symbol()\nCompletes the symbol at the current position based on the current lexer's\nAdeptsense. This should be called by key commands and menus instead of\n`complete`.\n
completions _m.textadept.adeptsense.completions [table]\nContains lists of possible completions for known symbols. Each symbol key\nhas a table value that contains a list of field completions with a `fields`\nkey and a list of functions completions with a `functions` key. This table\nis normally populated by load_ctags(), but can also be set by the user.\n
concat table.concat(table [, sep [, i [, j]]])\nGiven an array where all elements are strings or numbers, returns\n`table[i]..sep..table[i+1] ··· sep..table[j]`. The default value for `sep`\nis the empty string, the default for `i` is 1, and the default for `j` is\nthe length of the table. If `i` is greater than `j`, returns the empty string.\n
connect events.connect(event, f, index)\nAdds a handler function to an event.\n@param event The string event name. It is arbitrary and need not be defined\nanywhere.\n@param f The Lua function to add.\n@param index Optional index to insert the handler into.\n@return Index of handler.\n@see disconnect\n
@@ -1092,7 +1093,7 @@ java _G.snippets.java [table]\nContainer for Java-specific snippets.\n
java _m.java [module]\nThe java module. It provides utilities for editing Java code. User tags\nare loaded from _USERHOME/modules/java/tags and user apis are loaded from\n_USERHOME/modules/java/api.\n
join_lines _m.textadept.editing.join_lines()\nJoins the current line with the line below.\n
keys _G.keys [module]\nManages key commands in Textadept.\n
-keys _m.textadept.keys [module]\nDefines additional key commands for Textadept. The primary key commands\nare loaded from _USERHOME/keys.conf, _HOME/modules/textadept/keys.conf,\n_USERHOME/keys.osx.conf, or _HOME/modules/textadept/keys.osx.conf depending\non the platform by _m.textadept.menu. This module, like _m.textadept.menu,\nshould be 'require'ed last.\n
+keys _m.textadept.keys [module]\nDefines key commands for Textadept. This set of key commands is pretty\nstandard among other text editors. This module, should be 'require'ed last,\nbut before _m.textadept.menu.\n
keys_unicode buffer.keys_unicode [bool]\nInterpret keyboard input as Unicode.\n
layout_cache buffer.layout_cache [number]\nThe degree of caching of layout information.\n * `_SCINTILLA.constants.SC_CACHE_NONE` (0): No lines are cached.\n * `_SCINTILLA.constants.SC_CACHE_CARET` (1): The line containing the\n text caret. This is the default.\n * `_SCINTILLA.constants.SC_CACHE_PAGE` (2): Visible lines plus the line\n containing the caret.\n * `_SCINTILLA.constants.SC_CACHE_DOCUMENT` (3): All lines in the\n document.\n\n
ldexp math.ldexp(m, e)\nReturns *m2^e* (`e` should be an integer).\n
@@ -1205,7 +1206,7 @@ math _G.math [module]\nLua math module.\n
max math.max(x, ···)\nReturns the maximum value among its arguments.\n
max_line_state buffer.max_line_state [number]\nThe last line number that has line state. (Read-only)\n
maxn table.maxn(table)\nReturns the largest positive numerical index of the given table, or zero if\nthe table has no positive numerical indices. (To do its job this function\ndoes a linear traversal of the whole table.)\n
-menu _m.textadept.menu [module]\nProvides dynamic menus for Textadept. It also loads key commands\nfrom _USERHOME/keys.conf, _HOME/modules/textadept/keys.conf,\n_USERHOME/keys.osx.conf, or _HOME/modules/textadept/keys.osx.conf depending on\nthe platform. This module, like _m.textadept.keys, should be 'require'ed last.\n
+menu _m.textadept.menu [module]\nProvides dynamic menus for Textadept. This module should be 'require'ed last,\nafter _m.textadept.keys since it looks up defined key commands to show them\nin menus.\n
menubar _m.textadept.menu.menubar [table]\nContains the main menubar.\n
menubar gui.menubar [table]\nA table of GTK menus defining a menubar. (Write-only)\n
mime_types _m.textadept.mime_types [module]\nHandles file-specific settings.\n
@@ -1282,6 +1283,8 @@ print_magnification buffer.print_magnification [number]\nThe print magnification
print_wrap_mode buffer.print_wrap_mode [number]\nPrinting line wrap mode.\n * `_SCINTILLA.constants.SC_WRAP_NONE` (0): Each line of text generates\n one line of output and the line is truncated if it is too long to fit\n into the print area.\n * `_SCINTILLA.constants.SC_WRAP_WORD` (1): Wraps printed output so that\n all characters fit into the print rectangle. Tries to wrap only\n between words as indicated by white space or style changes although\n if a word is longer than a line, it will be wrapped before the line\n end. This is the default.\n * `_SCINTILLA.constants.SC_WRAP_CHAR` (2).\n\n
private_lexer_call buffer.private_lexer_call(buffer, operation, data)\nFor private communication between an application and a known lexer.\n@param buffer The focused buffer.\n@param operation An operation number.\n@param data Number data.\n
process args.process()\nProcesses command line arguments. Add command line switches with\nargs.register(). Any unrecognized arguments are treated as filepaths and\nopened. Generates an 'arg_none' event when no args are present.\n@see register\n
+prompt_load _m.textadept.session.prompt_load()\nPrompts the user for a Textadept session to load.\n
+prompt_save _m.textadept.session.prompt_save()\nPrompts the user to save the current Textadept session to a file.\n
properties _SCINTILLA.properties [table]\nScintilla properties.\n
property buffer.property [table]\nTable of keyword:value string pairs used by a lexer for some optional\nfeatures. (Write-only)\n
property_int buffer.property_int [table]\nInterprets `buffer.property[keyword]` as an integer if found or returns\n0. (Read-only)\n
@@ -1440,6 +1443,7 @@ setupvalue debug.setupvalue(func, up, value)\nThis function assigns the value `v
setvbuf file:setvbuf(mode [, size])\nSets the buffering mode for an output file. There are three available\nmodes: "no": no buffering; the result of any output operation appears\nimmediately. "full": full buffering; output operation is performed only\nwhen the buffer is full (or when you explicitly `flush` the file (see\n`io.flush`)). "line": line buffering; output is buffered until a newline is\noutput or there is any input from some special files (such as a terminal\ndevice). For the last two cases, `size` specifies the size of the buffer,\nin bytes. The default is an appropriate size.\n
shebangs _m.textadept.mime_types.shebangs [table]\nShebang words and their associated lexers.\n
show_apidoc _m.textadept.adeptsense.show_apidoc(sense)\nShows a calltip with API documentation for the symbol behind the caret.\n@param sense The adeptsense returned by adeptsense.new().\n@return true on success or false.\n@see get_symbol\n@see get_apidoc\n
+show_documentation _m.textadept.adeptsense.show_documentation()\nShows API documentation for the symbol at the current position based on the\ncurrent lexer's Adeptsense. This should be called by key commands and menus\ninstead of `show_apidoc`.\n
show_lines buffer.show_lines(buffer, start_line, end_line)\nMake a range of lines visible. This has no effect on fold levels or fold\nflags. start_line can not be hidden.\n@param buffer The focused buffer.\n@param start_line The start line.\n@param end_line The end line.\n
sin math.sin(x)\nReturns the sine of `x` (assumed to be in radians).\n
singular _m.rails.singular\nA map of plural controller names to their singulars. Add key-value pairs to\nthis if singularize() is incorrectly converting your plural controller name\nto its singular model name.\n