aboutsummaryrefslogtreecommitdiffhomepage
path: root/modules/lua
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2011-03-29 19:09:20 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2011-03-29 19:09:20 -0400
commit56ca83c50e928fc01200021a851215aa26d03f50 (patch)
tree3263ca37d2137e632758bef3ce944a8b54f809e0 /modules/lua
parent44ccc9b2ac07047ba87d365e3b548c8adc6769b2 (diff)
Updated Lua module tags and apidoc.
Diffstat (limited to 'modules/lua')
-rw-r--r--modules/lua/api8
-rw-r--r--modules/lua/tags4
2 files changed, 4 insertions, 8 deletions
diff --git a/modules/lua/api b/modules/lua/api
index 153bd037..d4637587 100644
--- a/modules/lua/api
+++ b/modules/lua/api
@@ -138,10 +138,9 @@ DEFAULT_DEPTH _m.textadept.snapopen.DEFAULT_DEPTH\nMaximum directory depth to se
MAX _m.textadept.snapopen.MAX\nMaximum number of files to list (defaults to 1000).\n
_cancel_current _m.textadept.snippets._cancel_current()\nCancels the active snippet, reverting to the state before its activation,\nand restores the previously running snippet (if any).\n
_insert _m.textadept.snippets._insert(text)\nInserts a snippet.\n@param Optional snippet text. If none is specified, the snippet text is\ndetermined from the trigger and lexer.\n@return false if no snippet was expanded; true otherwise.\n
-_previous _m.textadept.snippets._previous()\nGoes back to the previous placeholder or tab stop, reverting any changes\nfrom the current placeholder or tab stop.\n@return false if no snippet is active; nil otherwise.\n
+_previous _m.textadept.snippets._previous()\nGoes back to the previous placeholder, reverting any changes from the\ncurrent one.\n@return false if no snippet is active; nil otherwise.\n
_select _m.textadept.snippets._select()\nPrompts the user to select a snippet to insert from a filtered list\ndialog. Global snippets and snippets in the current lexer are shown.\n
-MARK_SNIPPET _m.textadept.snippets.MARK_SNIPPET\nThe unique integer mark used to identify the line that\n marks the end of a snippet.\n\n
-MARK_SNIPPET_COLOR _m.textadept.snippets.MARK_SNIPPET_COLOR\nThe Scintilla color used for the line that marks the end of the snippet.\n
+INDIC_SNIPPET _m.textadept.snippets.INDIC_SNIPPET\nThe unique integer indicator used to mark the end of a snippet.\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
register args.register(switch1, switch2, narg, f, description)\nRegisters a command line switch.\n@param String switch (short version).\n@param String switch (long version).\n@param The number of expected parameters for the switch.\n@param The Lua function to run when the switch is tripped.\n@param Description of the switch.\n
add_selection buffer.add_selection(buffer, caret, anchor)\nAdds a new selection from anchor to caret as the main selection. All other\nselections are retained as additional selections.\n
@@ -599,7 +598,7 @@ notification events.notification(n)\nHandles Scintilla notifications.\n@param Th
_print gui._print(buffer_type, ...)\nHelper function for printing messages to buffers. Splits the view and opens a\nnew buffer for printing messages. If the message buffer is already open and a\nview is currently showing it, the message is printed to that view. Otherwise\nthe view is split, goes to the open message buffer, and prints to it.\n@param String type of message buffer.\n@param Message strings.\n@usage gui._print(L('[Error Buffer]'), error_message)\n@usage gui._print(L('[Message Buffer]'), message)\n
check_focused_buffer gui.check_focused_buffer(buffer)\nChecks if the buffer being indexed is the currently focused buffer. This is\nnecessary because any buffer actions are performed in the focused views'\nbuffer, which may not be the buffer being indexed. Throws an error if the\ncheck fails.\n@param The buffer in question.\n
dialog gui.dialog(kind, ...)\nDisplays a CocoaDialog of a specified type with the given string\narguments. Each argument is like a string in Lua's 'arg' table. Tables of\nstrings are allowed as arguments and are expanded in place. This is useful\nfor filteredlist dialogs with many items.\n@return string CocoaDialog result.\n
-filteredlist gui.filteredlist(title, columns, items, int_return, ...)\nShortcut function for gui.dialog('filtered_list', ...) with 'Ok' and 'Cancel'\nbuttons.\n@param The title for the filteredlist dialog.\n@param A column name or list of column names.\n@param An item or list of items.\n@param If true, returns the integer index of the selected item in the\nfilteredlist. Defaults to false which returns the string item.\n@param Additional parameters to pass to gui.dialog().\n@usage gui.filteredlist('Title', 'Foo', { 'Bar', 'Baz' })\n@usage gui.filteredlist('Title', { 'Foo', 'Bar' }, { 'a', 'b', 'c', 'd' },\nfalse, '--output-column', '2')\n@return Either a string or integer on success; nil otherwise.\n
+filteredlist gui.filteredlist(title, columns, items, int_return, ...)\nShortcut function for gui.dialog('filtered_list', ...) with 'Ok' and 'Cancel'\nbuttons.\n@param The title for the filteredlist dialog.\n@param A column name or list of column names.\n@param An item or list of items.\n@param If true, returns the integer index of the selected item in the\nfilteredlist. Defaults to false, which returns the string item. Not compatible\nwith a '--select-multiple' filteredlist.\n@param Additional parameters to pass to gui.dialog().\n@usage gui.filteredlist('Title', 'Foo', { 'Bar', 'Baz' })\n@usage gui.filteredlist('Title', { 'Foo', 'Bar' }, { 'a', 'b', 'c', 'd' },\nfalse, '--output-column', '2')\n@return Either a string or integer on success; nil otherwise.\n
get_split_table gui.get_split_table()\nGets the current split view structure.\n@return table of split views. Each split view entry is a table with 4 fields:\n1, 2, vertical, and size. 1 and 2 have values of either split view entries\nor the index of the buffer shown in each view. vertical is a flag indicating\nif the split is vertical or not, and size is the integer position of the\nsplit resizer.\n
goto_view gui.goto_view(n, absolute)\nGoes to the specified view. Activates the 'view_*_switch' signal.\n@param A relative or absolute view index.\n@param Flag indicating if n is an absolute index or not.\n
gtkmenu gui.gtkmenu(menu_table)\nCreates a GTK menu, returning the userdata.\n@param A table defining the menu. It is an ordered list of tables with a string\nmenu item and integer menu ID. The string menu item is handled as follows:\n'gtk-*' - a stock menu item is created based on the GTK stock-id. 'separator'\n- a menu separator item is created. Otherwise a regular menu item with a\nmnemonic is created. Submenus are just nested menu-structure tables. Their\ntitle text is defined with a 'title' key.\n
@@ -646,7 +645,6 @@ write io.write(ยทยทยท)\nEquivalent to `io.output():write`.\n
stderr io.stderr\nStandard error.\n
stdin io.stdin\nStandard in.\n
stdout io.stdout\nStandard out.\n
-SCOPES_ENABLED keys.SCOPES_ENABLED\nFlag indicating whether scopes/styles can be used for key commands.\n
CTRL keys.CTRL\nThe string representing the Control key.\n
SHIFT keys.SHIFT\nThe string representing the Shift key.\n
ALT keys.ALT\nThe string representing the Alt key (the Apple key on Mac OSX).\n
diff --git a/modules/lua/tags b/modules/lua/tags
index a9db6c44..46865baa 100644
--- a/modules/lua/tags
+++ b/modules/lua/tags
@@ -283,8 +283,7 @@ _insert _ 0;" f class:_m.textadept.snippets
_previous _ 0;" f class:_m.textadept.snippets
_select _ 0;" f class:_m.textadept.snippets
_G.snippets _ 0;" t class:_m.textadept.snippets
-MARK_SNIPPET _ 0;" F class:_m.textadept.snippets
-MARK_SNIPPET_COLOR _ 0;" F class:_m.textadept.snippets
+INDIC_SNIPPET _ 0;" F class:_m.textadept.snippets
args _ 0;" m
args _ 0;" t class:_G
args _ 0;" t
@@ -815,7 +814,6 @@ keys _ 0;" m
keys _ 0;" t class:_G
keys _ 0;" t
KEYSYMS _ 0;" t class:keys
-SCOPES_ENABLED _ 0;" F class:keys
CTRL _ 0;" F class:keys
SHIFT _ 0;" F class:keys
ALT _ 0;" F class:keys