diff options
Diffstat (limited to 'core/.gui.luadoc')
| -rw-r--r-- | core/.gui.luadoc | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/core/.gui.luadoc b/core/.gui.luadoc index 38001ea9..2ff13019 100644 --- a/core/.gui.luadoc +++ b/core/.gui.luadoc @@ -19,7 +19,7 @@ module('gui') --- -- Goes to the specified view. --- Activates the 'view_*_switch' signal. +-- Generates `VIEW_BEFORE_SWITCH` and `VIEW_AFTER_SWITCH` events. -- @param n A relative or absolute view index. -- @param relative Flag indicating if n is a relative index or not. Defaults to -- false. @@ -28,10 +28,10 @@ function goto_view(n, relative) end --- -- Gets the current split view structure. -- @return table of split views. Each split view entry is a table with 4 --- fields: 1, 2, vertical, and size. 1 and 2 have values of either --- split view entries or the index of the buffer shown in each view. --- vertical is a flag indicating if the split is vertical or not, and --- size is the integer position of the split resizer. +-- fields: `1`, `2`, `vertical`, and `size`. `1` and `2` have values of either +-- split view entries or the index of the buffer shown in each view; +-- `vertical` is a flag indicating if the split is vertical or not; and +-- `size` is the integer position of the split resizer. function get_split_table() end --- @@ -40,11 +40,11 @@ function get_split_table() end -- with a string menu item, integer menu ID, and optional keycode and modifier -- mask. The latter two are used to display key shortcuts in the menu. The -- string menu item is handled as follows: --- 'gtk-*' - a stock menu item is created based on the GTK stock-id. --- 'separator' - a menu separator item is created. +-- `'gtk-*'` - a stock menu item is created based on the GTK stock-id. +-- `'separator'` - a menu separator item is created. -- Otherwise a regular menu item with a mnemonic is created. -- Submenus are just nested menu-structure tables. Their title text is defined --- with a 'title' key. +-- with a `title` key. -- @see keys.get_gdk_key function gtkmenu(menu_table) end @@ -62,7 +62,8 @@ function _print(buffer_type, ...) end --- -- Prints messages to the Textadept message buffer. --- Opens a new buffer (if one hasn't already been opened) for printing messages. +-- Opens a new buffer (if one has not already been opened) for printing +-- messages. -- @param ... Message strings. function print(...) end @@ -72,24 +73,24 @@ function print(...) end function switch_buffer() end --- --- Displays a CocoaDialog of a specified type with the given string arguments. --- Each argument is like a string in Lua's 'arg' table. Tables of strings are +-- Displays a gcocoadialog of a specified type with the given string arguments. +-- Each argument is like a string in Lua's `arg` table. Tables of strings are -- allowed as arguments and are expanded in place. This is useful for -- filteredlist dialogs with many items. --- @return string CocoaDialog result. +-- @return string gcocoadialog result. function dialog(kind, ...) end --- --- Shortcut function for gui.dialog('filtered_list', ...) with 'Ok' and 'Cancel' --- buttons. +-- Shortcut function for `gui.dialog('filtered_list', ...)` with 'Ok' and +-- 'Cancel' buttons. -- @param title The title for the filteredlist dialog. -- @param columns A column name or list of column names. -- @param items An item or list of items. --- @param int_return If true, returns the integer index of the selected item in --- the filteredlist. Defaults to false, which returns the string item. Not --- compatible with a '--select-multiple' filteredlist. --- @param ... Additional parameters to pass to gui.dialog(). --- @return Either a string or integer on success; nil otherwise. +-- @param int_return If `true`, returns the integer index of the selected item +-- in the filteredlist. Defaults to `false`, which returns the string item. +-- Not compatible with a `'--select-multiple'` filteredlist. +-- @param ... Additional parameters to pass to `gui.dialog()`. +-- @return Either a string or integer on success; `nil` otherwise. -- @usage gui.filteredlist('Title', 'Foo', { 'Bar', 'Baz' }) -- @usage gui.filteredlist('Title', { 'Foo', 'Bar' }, { 'a', 'b', 'c', 'd' }, -- false, '--output-column', '2') |