diff options
Diffstat (limited to 'core/.buffer.luadoc')
| -rw-r--r-- | core/.buffer.luadoc | 543 |
1 files changed, 277 insertions, 266 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index 5686df1d..c224cac5 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -3,8 +3,12 @@ -- global buffer table. --- --- The current buffer in the current view. --- It also represents the structure of any buffer table in `_G._BUFFER`. +-- A Textadept buffer object. +-- Be careful when storing references to a buffer object because if you attempt +-- call a buffer function with a non-global buffer, you will get an error. See +-- [`check_global()`](#check_global) for more information. +-- +-- [buffer]: _G.html#buffer -- @field additional_caret_fore (number) -- The foreground color of additional carets in `0xBBGGRR` format. -- @field additional_carets_blink (bool) @@ -893,7 +897,7 @@ module('buffer') -- @param buffer The global buffer. -- @param caret The caret. -- @param anchor The anchor. -function buffer.add_selection(buffer, caret, anchor) end +function add_selection(buffer, caret, anchor) end --- -- Add text to the document at current position. @@ -901,19 +905,19 @@ function buffer.add_selection(buffer, caret, anchor) end -- scrolled into view. -- @param buffer The global buffer. -- @param text The text to add. -function buffer.add_text(buffer, text) end +function add_text(buffer, text) end --- -- Enlarge the document to a particular size of text bytes. -- The document will not be made smaller than its current contents. -- @param buffer The global buffer. -- @param bytes -function buffer.allocate(buffer, bytes) end +function allocate(buffer, bytes) end --- -- Clear the annotations from all lines. -- @param buffer The global buffer. -function buffer.annotation_clear_all(buffer) end +function annotation_clear_all(buffer) end --- -- Append a string to the end of the document without changing the selection. @@ -921,33 +925,33 @@ function buffer.annotation_clear_all(buffer) end -- view. -- @param buffer The global buffer. -- @param text The text. -function buffer.append_text(buffer, text) end +function append_text(buffer, text) end --- -- Is there an auto-completion list visible? -- @param buffer -- @return bool -function buffer.auto_c_active(buffer) end +function auto_c_active(buffer) end --- -- Remove the auto-completion list from the screen. -- A set of characters that will cancel autocompletion can be specified with -- `buffer:auto_c_stops()`. -- @param buffer The global buffer. -function buffer.auto_c_cancel(buffer) end +function auto_c_cancel(buffer) end --- -- User has selected an item so remove the list and insert the selection. -- This has the same effect as the tab key. -- @param buffer The global buffer. -function buffer.auto_c_complete(buffer) end +function auto_c_complete(buffer) end --- -- Retrieve the position of the caret when the auto-completion list was -- displayed. -- @param buffer The global buffer. -- @return number -function buffer.auto_c_pos_start(buffer) end +function auto_c_pos_start(buffer) end --- -- Select the item in the auto-completion list that starts with a string. @@ -955,7 +959,7 @@ function buffer.auto_c_pos_start(buffer) end -- `buffer.auto_c_ignore_case`. -- @param buffer The global buffer. -- @param string -function buffer.auto_c_select(buffer, string) end +function auto_c_select(buffer, string) end --- -- Display an auto-completion list. @@ -963,30 +967,30 @@ function buffer.auto_c_select(buffer, string) end -- the context. -- @param item_list List of words separated by separator characters (initially -- spaces). The list of words should be in sorted order. -function buffer.auto_c_show(buffer, len_entered, item_list) end +function auto_c_show(buffer, len_entered, item_list) end --- -- Define a set of characters that when typed cancel the auto-completion list. -- @param buffer The global buffer. -- @param chars String list of characters. This list is empty by default. -function buffer.auto_c_stops(buffer, chars) end +function auto_c_stops(buffer, chars) end --- -- Dedent the selected lines. -- @param buffer The global buffer. -function buffer.back_tab(buffer) end +function back_tab(buffer) end --- -- Start a sequence of actions that is undone and redone as a unit. -- May be nested. -- @param buffer The global buffer. -function buffer.begin_undo_action(buffer) end +function begin_undo_action(buffer) end --- -- Highlight the character at a position indicating there is no matching brace. -- @param buffer The global buffer. -- @param pos The position or -1 to remove the highlight. -function buffer.brace_bad_light(buffer, pos) end +function brace_bad_light(buffer, pos) end --- -- Use specified indicator to highlight non matching brace instead of changing @@ -994,7 +998,7 @@ function buffer.brace_bad_light(buffer, pos) end -- @param buffer The global buffer. -- @param use_indicator Use an indicator. -- @param indic_num The indicator number. -function buffer.brace_bad_light_indicator(buffer, use_indicator, indic_num) end +function brace_bad_light_indicator(buffer, use_indicator, indic_num) end --- -- Highlight the characters at two positions. @@ -1004,7 +1008,7 @@ function buffer.brace_bad_light_indicator(buffer, use_indicator, indic_num) end -- @param buffer The global buffer. -- @param pos1 The first position. -- @param pos2 The second position. -function buffer.brace_highlight(buffer, pos1, pos2) end +function brace_highlight(buffer, pos1, pos2) end --- -- Use specified indicator to highlight matching braces instead of changing @@ -1012,7 +1016,7 @@ function buffer.brace_highlight(buffer, pos1, pos2) end -- @param buffer The global buffer. -- @param use_indicator Use an indicator. -- @param indic_num The indicator number. -function buffer.brace_highlight_indicator(buffer, use_indicator, indic_num) end +function brace_highlight_indicator(buffer, use_indicator, indic_num) end --- -- Find the position of a matching brace or `-1` if no match. @@ -1024,33 +1028,33 @@ function buffer.brace_highlight_indicator(buffer, use_indicator, indic_num) end -- @param buffer The global buffer. -- @param pos The position. -- @return number. -function buffer.brace_match(buffer, pos) end +function brace_match(buffer, pos) end --- -- Is there an active call tip? -- @param buffer The global buffer. -- @return bool -function buffer.call_tip_active(buffer) end +function call_tip_active(buffer) end --- -- Remove the call tip from the screen. -- Call tips are also removed if any keyboard commands that are not compatible -- with editing the argument list of a function are used. -- @param buffer The global buffer. -function buffer.call_tip_cancel(buffer) end +function call_tip_cancel(buffer) end --- -- Retrieve the position where the caret was before displaying the call tip. -- @param buffer The global buffer. -- @return number -function buffer.call_tip_pos_start(buffer) end +function call_tip_pos_start(buffer) end --- -- Highlights a segment of a call tip. -- @param buffer The global buffer. -- @param start_pos The start position. -- @param end_pos The end position. -function buffer.call_tip_set_hlt(buffer, start_pos, end_pos) end +function call_tip_set_hlt(buffer, start_pos, end_pos) end --- -- Show a call tip containing a definition near position pos. @@ -1061,30 +1065,30 @@ function buffer.call_tip_set_hlt(buffer, start_pos, end_pos) end -- @param buffer The global buffer. -- @param pos The position. -- @param text The text. -function buffer.call_tip_show(buffer, pos, text) end +function call_tip_show(buffer, pos, text) end --- -- Will a paste succeed? -- @param buffer The global buffer. -- @return bool -function buffer.can_paste(buffer) end +function can_paste(buffer) end --- -- Are there any redoable actions in the undo history? -- @param buffer The global buffer. -- @return bool -function buffer.can_redo(buffer) end +function can_redo(buffer) end --- -- Are there any undoable actions in the undo history? -- @param buffer The global buffer. -- @return bool -function buffer.can_undo(buffer) end +function can_undo(buffer) end --- -- Cancel any modes such as call tip or auto-completion list display. -- @param buffer The global buffer. -function buffer.cancel(buffer) end +function cancel(buffer) end --- -- Indicate that the internal state of a lexer has changed over a range and @@ -1092,23 +1096,23 @@ function buffer.cancel(buffer) end -- @param buffer The global buffer. -- @param start_pos The start position. -- @param end_pos The end position. -function buffer.change_lexer_state(buffer, start_pos, end_pos) end +function change_lexer_state(buffer, start_pos, end_pos) end --- -- Move caret left one character. -- @param buffer The global buffer. -function buffer.char_left(buffer) end +function char_left(buffer) end --- -- Move caret left one character extending selection to new caret position. -- @param buffer The global buffer. -function buffer.char_left_extend(buffer) end +function char_left_extend(buffer) end --- -- Move caret left one character, extending rectangular selection to new caret -- position. -- @param buffer The global buffer. -function buffer.char_left_rect_extend(buffer) end +function char_left_rect_extend(buffer) end --- -- Find the position of a character from a point within the window. @@ -1116,7 +1120,7 @@ function buffer.char_left_rect_extend(buffer) end -- @param x -- @param y -- @return number -function buffer.char_position_from_point(buffer, x, y) end +function char_position_from_point(buffer, x, y) end --- -- Find the position of a character from a point within the window. @@ -1125,23 +1129,23 @@ function buffer.char_position_from_point(buffer, x, y) end -- @param x -- @param y -- @return number -function buffer.char_position_from_point_close(buffer, x, y) end +function char_position_from_point_close(buffer, x, y) end --- -- Move caret right one character. -- @param buffer The global buffer. -function buffer.char_right(buffer) end +function char_right(buffer) end --- -- Move caret right one character extending selection to new caret position. -- @param buffer The global buffer. -function buffer.char_right_extend(buffer) end +function char_right_extend(buffer) end --- -- Move caret right one character, extending rectangular selection to new caret -- position. -- @param buffer The global buffer. -function buffer.char_right_rect_extend(buffer) end +function char_right_rect_extend(buffer) end --- -- Set the last x chosen value to be the caret x position. @@ -1150,37 +1154,37 @@ function buffer.char_right_rect_extend(buffer) end -- such as by using the up and down keys. This function sets the current x -- position of the caret as the remembered value. -- @param buffer The global buffer. -function buffer.choose_caret_x(buffer) end +function choose_caret_x(buffer) end --- -- Clear the selection. -- @param buffer The global buffer. -function buffer.clear(buffer) end +function clear(buffer) end --- -- Delete all text in the document. -- @param buffer The global buffer. -function buffer.clear_all(buffer) end +function clear_all(buffer) end --- -- Drop all key mappings. -- @param buffer The global buffer. -function buffer.clear_all_cmd_keys(buffer) end +function clear_all_cmd_keys(buffer) end --- -- Set all style bytes to `0`, remove all folding information. -- @param buffer The global buffer. -function buffer.clear_document_style(buffer) end +function clear_document_style(buffer) end --- -- Clear all the registered XPM images. -- @param buffer The global buffer. -function buffer.clear_registered_images(buffer) end +function clear_registered_images(buffer) end --- -- Clear selections to a single empty stream selection. -- @param buffer The global buffer. -function buffer.clear_selections(buffer) end +function clear_selections(buffer) end --- -- Colorise a segment of the document using the current lexing language. @@ -1188,7 +1192,7 @@ function buffer.clear_selections(buffer) end -- @param start_pos The start position. -- @param end_pos The end position or `-1` to style from `start_pos` to the end -- of the document. -function buffer.colourise(buffer, start_pos, end_pos) end +function colourise(buffer, start_pos, end_pos) end --- -- Find the next line at or after line_start that is a contracted fold header @@ -1197,7 +1201,7 @@ function buffer.colourise(buffer, start_pos, end_pos) end -- @param buffer The global buffer. -- @param line_start The start line number. -- @return number -function buffer.contracted_fold_next(buffer, line_start) end +function contracted_fold_next(buffer, line_start) end --- -- Converts all line endings in the document to one mode. @@ -1206,17 +1210,17 @@ function buffer.contracted_fold_next(buffer, line_start) end -- `_SCINTILLA.constants.SC_EOL_CRLF` (0), -- `_SCINTILLA.constants.SC_EOL_CR (1)`, or -- `_SCINTILLA.constants.SC_EOL_LF (2)`. -function buffer.convert_eo_ls(buffer, mode) end +function convert_eo_ls(buffer, mode) end --- -- Copy the selection to the clipboard. -- @param buffer The buffer -function buffer.copy(buffer) end +function copy(buffer) end --- -- Copy the selection, if selection empty copy the line with the caret. -- @param buffer The global buffer. -function buffer.copy_allow_line(buffer) end +function copy_allow_line(buffer) end --- -- Copy a range of text to the clipboard. Positions are clipped into the @@ -1224,107 +1228,107 @@ function buffer.copy_allow_line(buffer) end -- @param buffer The global buffer. -- @param start_pos The start position. -- @param end_pos The end position. -function buffer.copy_range(buffer, start_pos, end_pos) end +function copy_range(buffer, start_pos, end_pos) end --- -- Copy argument text to the clipboard. -- @param buffer The global buffer. -- @param text The text. -function buffer.copy_text(buffer, text) end +function copy_text(buffer, text) end --- -- Count characters between two positions. -- @param start_pos -- @param end_pos -- @return number -function buffer.count_characters(buffer, start_pos, end_pos) end +function count_characters(buffer, start_pos, end_pos) end --- -- Cut the selection to the clipboard. -- @param buffer The global buffer. -function buffer.cut(buffer) end +function cut(buffer) end --- -- Delete back from the current position to the start of the line. -- @param buffer The global buffer. -function buffer.del_line_left(buffer) end +function del_line_left(buffer) end --- -- Delete forwards from the current position to the end of the line. -- @param buffer The global buffer. -function buffer.del_line_right(buffer) end +function del_line_right(buffer) end --- -- Delete the word to the left of the caret. -- @param buffer The global buffer. -function buffer.del_word_left(buffer) end +function del_word_left(buffer) end --- -- Delete the word to the right of the caret. -- @param buffer The global buffer. -function buffer.del_word_right(buffer) end +function del_word_right(buffer) end --- -- Delete the word to the right of the caret, but not the trailing non-word -- characters. -- @param buffer The global buffer. -function buffer.del_word_right_end(buffer) end +function del_word_right_end(buffer) end --- -- Delete the selection or if no selection, the character before the caret. -- @param buffer The global buffer. -function buffer.delete_back(buffer) end +function delete_back(buffer) end --- -- Delete the selection or if no selection, the character before the caret. -- Will not delete the character before at the start of a line. -function buffer.delete_back_not_line(buffer) end +function delete_back_not_line(buffer) end --- -- Delete a range of text in the document. -- @param pos The start position of the range to delete. -- @param length The length of the range to delete. -function buffer.delete_range(buffer, pos, length) end +function delete_range(buffer, pos, length) end --- -- Find the document line of a display line taking hidden lines into account. -- @param buffer The global buffer. -- @return number -function buffer.doc_line_from_visible(buffer) end +function doc_line_from_visible(buffer) end --- -- Move caret to last position in document. -- @param buffer The global buffer. -function buffer.document_end(buffer) end +function document_end(buffer) end --- -- Move caret to last position in document extending selection to new caret -- position. -- @param buffer The global buffer. -function buffer.document_end_extend(buffer) end +function document_end_extend(buffer) end --- -- Move caret to first position in document. -- @param buffer The global buffer. -function buffer.document_start(buffer) end +function document_start(buffer) end --- -- Move caret to first position in document extending selection to new caret -- position. -- @param buffer The global buffer. -function buffer.document_start_extend(buffer) end +function document_start_extend(buffer) end --- -- Switch from insert to overtype mode or the reverse. -- @param buffer The global buffer. -function buffer.edit_toggle_overtype(buffer) end +function edit_toggle_overtype(buffer) end --- -- Delete the undo history. -- It also sets the save point to the start of the undo buffer, so the document -- will appear to be unmodified. -- @param buffer The global buffer. -function buffer.empty_undo_buffer(buffer) end +function empty_undo_buffer(buffer) end --- -- Translates a UTF8 string into the document encoding. @@ -1332,25 +1336,25 @@ function buffer.empty_undo_buffer(buffer) end -- @param buffer The global buffer. -- @param string The string. -- @return number -function buffer.encoded_from_utf8(buffer, string) end +function encoded_from_utf8(buffer, string) end --- -- End a sequence of actions that is undone and redone as a unit. -- @param buffer The global buffer. -function buffer.end_undo_action(buffer) end +function end_undo_action(buffer) end --- -- Ensure a particular line is visible by expanding any header line hiding it. -- @param buffer The global buffer. -- @param line The line number. -function buffer.ensure_visible(buffer, line) end +function ensure_visible(buffer, line) end --- -- Ensure a particular line is visible by expanding any header line hiding it. -- Use the currently set visibility policy to determine which range to display. -- @param buffer The global buffer. -- @param line The line number. -function buffer.ensure_visible_enforce_policy(buffer, line) end +function ensure_visible_enforce_policy(buffer, line) end --- -- Find the position of a column on a line taking into account tabs and @@ -1359,38 +1363,38 @@ function buffer.ensure_visible_enforce_policy(buffer, line) end -- @param buffer The global buffer. -- @param line The line number. -- @param column The column number. -function buffer.find_column(buffer, line, column) end +function find_column(buffer, line, column) end --- -- Insert a Form Feed character. -- @param buffer The global buffer. -function buffer.form_feed(buffer) end +function form_feed(buffer) end --- -- Retrieve the text of the line containing the caret. -- Also returns the index of the caret on the line. -- @param buffer The global buffer. -- @return string, number -function buffer.get_cur_line(buffer) end +function get_cur_line(buffer) end --- -- Get the back color for active hotspots in 0xBBGGRR format. -- @param buffer The global buffer. -- @return number -function buffer.get_hotspot_active_back(buffer) end +function get_hotspot_active_back(buffer) end --- -- Get the fore color for active hotspots. -- @param buffer The global buffer. -- @return number -function buffer.get_hotspot_active_fore(buffer) end +function get_hotspot_active_fore(buffer) end --- -- Find the last child line of a header line. -- @param buffer The global buffer. -- @param header_line The line number of a header line. -- @param level The level or `-1` for the level of header_line. -function buffer.get_last_child(buffer, header_line, level) end +function get_last_child(buffer, header_line, level) end --- -- Retrieve the contents of a line. @@ -1398,21 +1402,21 @@ function buffer.get_last_child(buffer, header_line, level) end -- @param buffer The global buffer. -- @param line The line number. -- @return string, number -function buffer.get_line(buffer, line) end +function get_line(buffer, line) end --- -- Retrieve the position of the end of the selection at the given line (`-1` if -- no selection on this line). -- @param buffer The global buffer. -- @param line The line number. -function buffer.get_line_sel_end_position(buffer, line) end +function get_line_sel_end_position(buffer, line) end --- -- Retrieve the position of the start of the selection at the given line (`-1` -- if no selection on this line). -- @param buffer The global buffer. -- @param line The line number. -function buffer.get_line_sel_start_position(buffer, line) end +function get_line_sel_start_position(buffer, line) end --- -- Return a read-only pointer to a range of characters in the document. @@ -1421,38 +1425,38 @@ function buffer.get_line_sel_start_position(buffer, line) end -- The gap is not moved unless it is within the requested range so this call can -- be faster than `SCI_GETCHARACTERPOINTER`. This can be used by application -- code that is able to act on blocks of text or ranges of lines. -function buffer.get_range_pointer(buffer, position, range_length) end +function get_range_pointer(buffer, position, range_length) end --- -- Retrieve the selected text. -- Also returns the length of the text. -- @param buffer The global buffer. -- @return string, number -function buffer.get_sel_text(buffer) end +function get_sel_text(buffer) end --- -- Retrieve all the text in the document. -- Also returns number of characters retrieved. -- @param buffer The global buffer. -function buffer.get_text(buffer) end +function get_text(buffer) end --- -- Set caret to start of a line and ensure it is visible. -- @param buffer The global buffer. -- @param line The line number. -function buffer.goto_line(buffer, line) end +function goto_line(buffer, line) end --- -- Set caret to a position and ensure it is visible. -- The anchor position is set the same as the current position. -- @param buffer The global buffer. -- @param pos The position. -function buffer.goto_pos(buffer, pos) end +function goto_pos(buffer, pos) end --- -- Set the focus to this view. -- @param buffer The global buffer. -function buffer.grab_focus(buffer) end +function grab_focus(buffer) end --- -- Make a range of lines invisible. @@ -1461,52 +1465,52 @@ function buffer.grab_focus(buffer) end -- @param buffer The global buffer. -- @param start_line The start line. -- @param end_line The end line. -function buffer.hide_lines(buffer, start_line, end_line) end +function hide_lines(buffer, start_line, end_line) end --- -- Draw the selection in normal style or with selection highlighted. -- @param buffer The global buffer. -- @param normal Draw normal selection. -function buffer.hide_selection(buffer, normal) end +function hide_selection(buffer, normal) end --- -- Move caret to first position on line. -- @param buffer The global buffer. -function buffer.home(buffer) end +function home(buffer) end --- -- Move caret to first position on display line. -- @param buffer The global buffer. -function buffer.home_display(buffer) end +function home_display(buffer) end --- -- Move caret to first position on display line extending selection to new caret -- position. -- @param buffer The global buffer. -function buffer.home_display_extend(buffer) end +function home_display_extend(buffer) end --- -- Move caret to first position on line extending selection to new caret -- position. -- @param buffer The global buffer. -function buffer.home_extend(buffer) end +function home_extend(buffer) end --- -- Move caret to first position on line, extending rectangular selection to new -- caret position. -- @param buffer The global buffer. -function buffer.home_rect_extend(buffer) end +function home_rect_extend(buffer) end --- -- Move caret to the start of the display line when word-wrap is enabled. -- If already there, go to the start of the document line. -- @param buffer The global buffer. -function buffer.home_wrap(buffer) end +function home_wrap(buffer) end --- -- Like `buffer:home_wrap()` but extending selection to new caret position. -- @param buffer The global buffer. -function buffer.home_wrap_extend(buffer) end +function home_wrap_extend(buffer) end --- -- Retrieve a bitmap value representing which indicators are non-zero at a @@ -1515,21 +1519,21 @@ function buffer.home_wrap_extend(buffer) end -- @param buffer The global buffer. -- @param pos The position. -- @return number -function buffer.indicator_all_on_for(buffer, pos) end +function indicator_all_on_for(buffer, pos) end --- -- Turn a indicator off over a range. -- @param buffer The global buffer. -- @param pos The start position. -- @param clear_length The length. -function buffer.indicator_clear_range(buffer, pos, clear_length) end +function indicator_clear_range(buffer, pos, clear_length) end --- -- Find the position where a particular indicator ends. -- @param buffer The global buffer. -- @param indicator An indicator number in the range of `0` to `31`. -- @param pos The position of the indicator. -function buffer.indicator_end(buffer, indicator, pos) end +function indicator_end(buffer, indicator, pos) end --- -- Turn a indicator on over a range. @@ -1537,14 +1541,14 @@ function buffer.indicator_end(buffer, indicator, pos) end -- @param buffer The global buffer. -- @param pos the start position. -- @param fill_length The length. -function buffer.indicator_fill_range(buffer, pos, fill_length) end +function indicator_fill_range(buffer, pos, fill_length) end --- -- Find the position where a particular indicator starts. -- @param buffer The global buffer. -- @param indicator An indicator number in the range of `0` to `31`. -- @param pos The position of the indicator. -function buffer.indicator_start(buffer, indicator, pos) end +function indicator_start(buffer, indicator, pos) end --- -- Retrieve the value of a particular indicator at a position. @@ -1553,7 +1557,7 @@ function buffer.indicator_start(buffer, indicator, pos) end -- @param indicator The indicator number in the range of `0` to `31`. -- @param pos The position. -- @return number -function buffer.indicator_value_at(buffer, indicator, pos) end +function indicator_value_at(buffer, indicator, pos) end --- -- Insert string at a position. @@ -1562,89 +1566,89 @@ function buffer.indicator_value_at(buffer, indicator, pos) end -- @param buffer The global buffer. -- @param pos The position to insert text at or `-1` for the current position. -- @param text The text to insert. -function buffer.insert_text(buffer, pos, text) end +function insert_text(buffer, pos, text) end --- -- Copy the line containing the caret. -- @param buffer The global buffer. -function buffer.line_copy(buffer) end +function line_copy(buffer) end --- -- Cut the line containing the caret. -- @param buffer The global buffer. -function buffer.line_cut(buffer) end +function line_cut(buffer) end --- -- Delete the line containing the caret. -- @param buffer The global buffer. -function buffer.line_delete(buffer) end +function line_delete(buffer) end --- -- Move caret down one line. -- @param buffer The global buffer. -function buffer.line_down(buffer) end +function line_down(buffer) end --- -- Move caret down one line extending selection to new caret position. -- @param buffer The global buffer. -function buffer.line_down_extend(buffer) end +function line_down_extend(buffer) end --- -- Move caret down one line, extending rectangular selection to new caret -- position. -- @param buffer The global buffer. -function buffer.line_down_rect_extend(buffer) end +function line_down_rect_extend(buffer) end --- -- Duplicate the current line. -- @param buffer The global buffer. -function buffer.line_duplicate(buffer) end +function line_duplicate(buffer) end --- -- Move caret to last position on line. -- @param buffer The global buffer. -function buffer.line_end(buffer) end +function line_end(buffer) end --- -- Move caret to last position on display line. -- @param buffer The global buffer. -function buffer.line_end_display(buffer) end +function line_end_display(buffer) end --- -- Move caret to last position on display line extending selection to new caret -- position. -- @param buffer The global buffer. -function buffer.line_end_display_extend(buffer) end +function line_end_display_extend(buffer) end --- -- Move caret to last position on line extending selection to new caret -- position. -- @param buffer The global buffer. -function buffer.line_end_extend(buffer) end +function line_end_extend(buffer) end --- -- Move caret to last position on line, extending rectangular selection to new -- caret position. -- @param buffer The global buffer. -function buffer.line_end_rect_extend(buffer) end +function line_end_rect_extend(buffer) end --- -- Move caret to the end of the display line when word-wrap is enabled. -- If already there, go to the end of the document line. -- @param buffer The global buffer. -function buffer.line_end_wrap(buffer) end +function line_end_wrap(buffer) end --- -- Like `buffer:line_end_wrap()` but extending selection to new caret position. -- @param buffer The global buffer. -function buffer.line_end_wrap_extend(buffer) end +function line_end_wrap_extend(buffer) end --- -- Retrieve the line containing a position. -- @param buffer The global buffer. -- @param pos The position. -- @return number -function buffer.line_from_position(buffer, pos) end +function line_from_position(buffer, pos) end --- -- Returns how many characters are on a line, including end of line characters. @@ -1653,68 +1657,68 @@ function buffer.line_from_position(buffer, pos) end -- @param buffer The global buffer. -- @param line The line number. -- @return number -function buffer.line_length(buffer, line) end +function line_length(buffer, line) end --- -- Scroll horizontally and vertically. -- @param buffer The global buffer. -- @param columns The number of columns to scroll horizontally. -- @param lines The number of lines to scroll vertically. -function buffer.line_scroll(buffer, columns, lines) end +function line_scroll(buffer, columns, lines) end --- -- Scroll the document down, keeping the caret visible. -- @param buffer The global buffer. -function buffer.line_scroll_down(buffer) end +function line_scroll_down(buffer) end --- -- Scroll the document up, keeping the caret visible. -- @param buffer The global buffer. -function buffer.line_scroll_up(buffer) end +function line_scroll_up(buffer) end --- -- Switch the current line with the previous. -- @param buffer The global buffer. -function buffer.line_transpose(buffer) end +function line_transpose(buffer) end --- -- Move caret up one line. -- @param buffer The global buffer. -function buffer.line_up(buffer) end +function line_up(buffer) end --- -- Move caret up one line extending selection to new caret position. -- @param buffer The global buffer. -function buffer.line_up_extend(buffer) end +function line_up_extend(buffer) end --- -- Move caret up one line, extending rectangular selection to new caret -- position. -- @param buffer The global buffer. -function buffer.line_up_rect_extend(buffer) end +function line_up_rect_extend(buffer) end --- -- Join the lines in the target. -- Where this would lead to no space between words, an extra space is inserted. -- @param buffer The global buffer. -function buffer.lines_join(buffer) end +function lines_join(buffer) end --- -- Split the lines in the target into lines that are less wide than -- `pixel_width` where possible. -- @param buffer The global buffer. -- @param pixel_width The pixel width. When `0`, the width of the view is used. -function buffer.lines_split(buffer, pixel_width) end +function lines_split(buffer, pixel_width) end --- -- Transform the selection to lower case. -- @param buffer The global buffer. -function buffer.lower_case(buffer) end +function lower_case(buffer) end --- -- Clear the margin text on all lines. -- @param buffer The global buffer. -function buffer.margin_text_clear_all(buffer) end +function margin_text_clear_all(buffer) end --- -- Add a marker to a line, returning an ID which can be used to find or delete @@ -1724,7 +1728,7 @@ function buffer.margin_text_clear_all(buffer) end -- @param line The line number. -- @param marker_num A marker number in the range of `0` to `31`. -- @return number -function buffer.marker_add(buffer, line, marker_num) end +function marker_add(buffer, line, marker_num) end --- -- Add a set of markers to a line. @@ -1732,7 +1736,7 @@ function buffer.marker_add(buffer, line, marker_num) end -- @param line The line number. -- @param marker_mask A mask of markers to set. Set bit 0 to set marker 0, bit -- 1 for marker 1 and so on. -function buffer.marker_add_set(buffer, line, marker_mask) end +function marker_add_set(buffer, line, marker_mask) end --- -- Set the symbol used for a particular marker number. @@ -1740,14 +1744,14 @@ function buffer.marker_add_set(buffer, line, marker_mask) end -- @param marker_num A marker number in the range of `0` to `31`. -- @param marker_symbol A marker symbol: `_SCINTILLA.constants.SC_MARK_*`. -- @see _SCINTILLA.next_marker_number -function buffer.marker_define(buffer, marker_num, marker_symbol) end +function marker_define(buffer, marker_num, marker_symbol) end --- -- Define a marker from a pixmap. -- @param buffer The global buffer. -- @param marker_num A marker number in the range of `0` to `31`. -- @param pixmap `NULL`-terminated pixmap data. -function buffer.marker_define_pixmap(buffer, marker_num, pixmap) end +function marker_define_pixmap(buffer, marker_num, pixmap) end --- -- Define a marker from RGBA data. @@ -1762,7 +1766,7 @@ function buffer.marker_define_pixmap(buffer, marker_num, pixmap) end -- byte and an alpha byte. The colour bytes are not premultiplied by the alpha -- value. That is, a fully red pixel that is 25% opaque will be `[FF, 00, 00, -- 3F]`. -function buffer.marker_define_rgba_image(buffer, marker_num, pixels) end +function marker_define_rgba_image(buffer, marker_num, pixels) end --- -- Delete a marker from a line. @@ -1770,27 +1774,27 @@ function buffer.marker_define_rgba_image(buffer, marker_num, pixels) end -- @param line The line number. -- @param marker_num A marker number in the range of `0` to `31` or `-1` to -- delete all markers from the line. -function buffer.marker_delete(buffer, line, marker_num) end +function marker_delete(buffer, line, marker_num) end --- -- Delete all markers with a particular number from all lines. -- @param buffer The global buffer. -- @param marker_num A marker number in the range of `0` to `31` or `-1` to -- delete all markers from the line. -function buffer.marker_delete_all(buffer, marker_num) end +function marker_delete_all(buffer, marker_num) end --- -- Delete a marker. -- @param buffer The global buffer. -- @param handle The identifier of a marker returned by `buffer:marker_add()`. -function buffer.marker_delete_handle(buffer, handle) end +function marker_delete_handle(buffer, handle) end --- -- Enable/disable highlight for current folding block (smallest one that -- contains the caret) -- @param buffer The global buffer. -- @param enabled -function buffer.marker_enable_highlight(buffer, enabled) end +function marker_enable_highlight(buffer, enabled) end --- -- Get a bit mask of all the markers set on a line. @@ -1798,7 +1802,7 @@ function buffer.marker_enable_highlight(buffer, enabled) end -- @param buffer The global buffer. -- @param line The line number. -- @return number. -function buffer.marker_get(buffer, line) end +function marker_get(buffer, line) end --- -- Retrieve the line number at which a particular marker is located. @@ -1806,7 +1810,7 @@ function buffer.marker_get(buffer, line) end -- @param buffer The global buffer. -- @param handle The identifier of a marker returned by `buffer:marker_add()`. -- @return number -function buffer.marker_line_from_handle(buffer, handle) end +function marker_line_from_handle(buffer, handle) end --- -- Find the next line at or after start_line that includes a marker in mask. @@ -1816,7 +1820,7 @@ function buffer.marker_line_from_handle(buffer, handle) end -- @param marker_mask A mask of markers to find. Set bit 0 to find marker 0, bit -- 1 for marker 1 and so on. -- @return number -function buffer.marker_next(buffer, start_line, marker_mask) end +function marker_next(buffer, start_line, marker_mask) end --- -- Find the previous line before `start_line` that includes a marker in mask. @@ -1825,20 +1829,20 @@ function buffer.marker_next(buffer, start_line, marker_mask) end -- @param marker_mask A mask of markers to find. Set bit 0 to find marker 0, bit -- 1 for marker 1 and so on. -- @return number -function buffer.marker_previous(buffer, start_line, marker_mask) end +function marker_previous(buffer, start_line, marker_mask) end --- -- Return the symbol defined for marker_num with `buffer:marker_define()`. -- @param buffer The global buffer. -- @param marker_num A marker number in the range of `0` to `31`. -- @return number -function buffer.marker_symbol_defined(buffer, marker_num) end +function marker_symbol_defined(buffer, marker_num) end --- -- Move the caret inside current view if it is not there already. -- Any selection is lost. -- @param buffer The global buffer. -function buffer.move_caret_inside_view(buffer) end +function move_caret_inside_view(buffer) end --- -- Move the selected lines down one line, shifting the line below before the @@ -1847,7 +1851,7 @@ function buffer.move_caret_inside_view(buffer) end -- selection's first line and the end of the seletion's last line. If nothing -- was selected, the line the cursor is currently at will be selected. -- @param buffer The global buffer. -function buffer.move_selected_lines_down(buffer) end +function move_selected_lines_down(buffer) end --- -- Move the selected lines up one line, shifting the line above after the @@ -1856,79 +1860,79 @@ function buffer.move_selected_lines_down(buffer) end -- selection's first line and the end of the seletion's last line. If nothing -- was selected, the line the cursor is currently at will be selected. -- @param buffer The global buffer. -function buffer.move_selected_lines_up(buffer) end +function move_selected_lines_up(buffer) end --- -- Insert a new line, may use a CRLF, CR or LF depending on EOL mode. -- @param buffer The global buffer. -function buffer.new_line(buffer) end +function new_line(buffer) end --- -- Move caret one page down. -- @param buffer The global buffer. -function buffer.page_down(buffer) end +function page_down(buffer) end --- -- Move caret one page down extending selection to new caret position. -- @param buffer The global buffer. -function buffer.page_down_extend(buffer) end +function page_down_extend(buffer) end --- -- Move caret one page down, extending rectangular selection to new caret -- position. -- @param buffer The global buffer. -function buffer.page_down_rect_extend(buffer) end +function page_down_rect_extend(buffer) end --- -- Move caret one page up. -- @param buffer The global buffer. -function buffer.page_up(buffer) end +function page_up(buffer) end --- -- Move caret one page up extending selection to new caret position. -- @param buffer The global buffer. -function buffer.page_up_extend(buffer) end +function page_up_extend(buffer) end --- -- Move caret one page up, extending rectangular selection to new caret -- position. -- @param buffer The global buffer. -function buffer.page_up_rect_extend(buffer) end +function page_up_rect_extend(buffer) end --- -- Move caret one paragraph down (delimited by empty lines). -- @param buffer The global buffer. -function buffer.para_down(buffer) end +function para_down(buffer) end --- -- Move caret one paragraph down (delimited by empty lines) extending selection -- to new caret position. -- @param buffer The global buffer. -function buffer.para_down_extend(buffer) end +function para_down_extend(buffer) end --- -- Move caret one paragraph up (delimited by empty lines). -- @param buffer The global buffer. -function buffer.para_up(buffer) end +function para_up(buffer) end --- -- Move caret one paragraph up (delimited by empty lines) extending selection to -- new caret position. -- @param buffer The global buffer. -function buffer.para_up_extend(buffer) end +function para_up_extend(buffer) end --- -- Paste the contents of the clipboard into the document replacing the -- selection. -- @param buffer The global buffer. -function buffer.paste(buffer) end +function paste(buffer) end --- -- For private communication between an application and a known lexer. -- @param buffer The global buffer. -- @param operation An operation number. -- @param data Number data. -function buffer.private_lexer_call(buffer, operation, data) end +function private_lexer_call(buffer, operation, data) end --- -- Retrieve the x value of the point in the window where a position is @@ -1936,7 +1940,7 @@ function buffer.private_lexer_call(buffer, operation, data) end -- @param buffer The global buffer. -- @param pos The position. -- @return number -function buffer.point_x_from_position(buffer, pos) end +function point_x_from_position(buffer, pos) end --- -- Retrieve the y value of the point in the window where a position is @@ -1944,14 +1948,14 @@ function buffer.point_x_from_position(buffer, pos) end -- @param buffer The global buffer. -- @param pos The position. -- @return number -function buffer.point_y_from_position(buffer, pos) end +function point_y_from_position(buffer, pos) end --- -- Given a valid document position, return the next position taking code page -- into account. Maximum value returned is the last position in the document. -- @param buffer The global buffer. -- @param pos The position. -function buffer.position_after(buffer, pos) end +function position_after(buffer, pos) end --- -- Given a valid document position, return the previous position taking code @@ -1959,7 +1963,7 @@ function buffer.position_after(buffer, pos) end -- @param buffer The global buffer. -- @param pos The position. -- @return number -function buffer.position_before(buffer, pos) end +function position_before(buffer, pos) end --- -- Retrieve the position at the start of a line. @@ -1967,7 +1971,7 @@ function buffer.position_before(buffer, pos) end -- @param buffer The global buffer. -- @param line The line. -- @return number -function buffer.position_from_line(buffer, line) end +function position_from_line(buffer, line) end --- -- Find the position from a point within the window. @@ -1975,7 +1979,7 @@ function buffer.position_from_line(buffer, line) end -- @param x -- @param y -- @return number -function buffer.position_from_point(buffer, x, y) end +function position_from_point(buffer, x, y) end --- -- Returns the position from a point within the window, but return `-1` if not @@ -1984,19 +1988,19 @@ function buffer.position_from_point(buffer, x, y) end -- @param x -- @param y -- @return number -function buffer.position_from_point_close(buffer, x, y) end +function position_from_point_close(buffer, x, y) end --- -- Redoes the next action on the undo history. -- @param buffer The global buffer. -function buffer.redo(buffer) end +function redo(buffer) end --- -- Register an XPM image for use in autocompletion lists. -- @param buffer The global buffer. -- @param type Integer type to register the image with. -- @param xpm_data XPM data as is described for `buffer:marker_define_pixmap()`. -function buffer.register_image(buffer, type, xpm_data) end +function register_image(buffer, type, xpm_data) end --- -- Register an RGBA image for use in autocompletion lists. @@ -2006,7 +2010,7 @@ function buffer.register_image(buffer, type, xpm_data) end -- @param type Integer type to register the image with. -- @param pixels RGBA data as is described for -- `buffer:marker_define_rgba_image()`. -function buffer.register_rgba_image(buffer, type, pixels) end +function register_rgba_image(buffer, type, pixels) end --- -- Replace the selected text with the argument text. @@ -2014,7 +2018,7 @@ function buffer.register_rgba_image(buffer, type, pixels) end -- into view. -- @param buffer The global buffer. -- @param text The text. -function buffer.replace_sel(buffer, text) end +function replace_sel(buffer, text) end --- -- Replace the target text with the argument text. @@ -2023,7 +2027,7 @@ function buffer.replace_sel(buffer, text) end -- @param buffer The global buffer. -- @param text The text (can contain NULs). -- @return number -function buffer.replace_target(buffer, text) end +function replace_target(buffer, text) end --- -- Replace the target text with the argument text after `\d` processing. @@ -2034,34 +2038,34 @@ function buffer.replace_target(buffer, text) end -- @param buffer The global buffer. -- @param text The text (can contain NULs). -- @return number -function buffer.replace_target_re(buffer, text) end +function replace_target_re(buffer, text) end --- -- Set the main selection to the next selection. -- @param buffer The global buffer. -function buffer.rotate_selection(buffer) end +function rotate_selection(buffer) end --- -- Ensure the caret is visible. -- @param buffer The global buffer. -function buffer.scroll_caret(buffer) end +function scroll_caret(buffer) end --- -- Scroll to end of document. -- @param buffer The global buffer. -function buffer.scroll_to_end(buffer) end +function scroll_to_end(buffer) end --- -- Scroll to start of document. -- @param buffer The global buffer. -function buffer.scroll_to_start(buffer) end +function scroll_to_start(buffer) end --- -- Sets the current caret position to be the search anchor. -- Always call this before calling either of `buffer:search_next()` or -- `buffer:search_prev()`. -- @param buffer The global buffer. -function buffer.search_anchor(buffer) end +function search_anchor(buffer) end --- -- Search for a counted string in the target and set the target to the found @@ -2071,7 +2075,7 @@ function buffer.search_anchor(buffer) end -- @param buffer The global buffer. -- @param text The text (can contain NULs). -- @return number -function buffer.search_in_target(buffer, text) end +function search_in_target(buffer, text) end --- -- Find some text starting at the search anchor. @@ -2082,7 +2086,7 @@ function buffer.search_in_target(buffer, text) end -- @param flags Search flags. See `buffer.search_flags`. -- @param text The text. -- @return number -function buffer.search_next(buffer, flags, text) end +function search_next(buffer, flags, text) end --- -- Find some text starting at the search anchor and moving backwards. @@ -2093,19 +2097,19 @@ function buffer.search_next(buffer, flags, text) end -- @param flags Search flags. See `buffer.search_flags`. -- @param text The text. -- @return number -function buffer.search_prev(buffer, flags, text) end +function search_prev(buffer, flags, text) end --- -- Select all the text in the document. -- The current position is not scrolled into view. -- @param buffer The global buffer. -function buffer.select_all(buffer) end +function select_all(buffer) end --- -- Duplicate the selection. -- If selection empty duplicate the line containing the caret. -- @param buffer The global buffer. -function buffer.selection_duplicate(buffer) end +function selection_duplicate(buffer) end --- -- Reset the set of characters for whitespace and word characters to the @@ -2113,54 +2117,54 @@ function buffer.selection_duplicate(buffer) end -- This sets whitespace to space, tab and other characters with codes less than -- `0x20`, with word characters set to alphanumeric and `'_'`. -- @param buffer The global buffer. -function buffer.set_chars_default(buffer) end +function set_chars_default(buffer) end --- -- Set caret to a position, while removing any existing selection. -- The caret is not scrolled into view. -- @param buffer The buffer -- @param pos The position to move to. -function buffer.set_empty_selection(buffer, pos) end +function set_empty_selection(buffer, pos) end --- -- Set the colors used as a chequerboard pattern in the fold margin. -- @param buffer The global buffer. -- @param use_setting Enable color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_fold_margin_colour(buffer, use_setting, color) end +function set_fold_margin_colour(buffer, use_setting, color) end --- -- Set the colors used as a checkerboard pattern in the fold margin. -- @param buffer The global buffer. -- @param use_setting Enable color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_fold_margin_hi_colour(buffer, use_setting, color) end +function set_fold_margin_hi_colour(buffer, use_setting, color) end --- -- Set a back color for active hotspots. -- @param buffer The global buffer. -- @param use_setting Enable the color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_hotspot_active_back(buffer, use_setting, color) end +function set_hotspot_active_back(buffer, use_setting, color) end --- -- Set a fore color for active hotspots. -- @param buffer The global buffer. -- @param use_setting Enable the color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_hotspot_active_fore(buffer, use_setting, color) end +function set_hotspot_active_fore(buffer, use_setting, color) end --- -- Set the length of the utf8 argument for calling `buffer:encoded_from_utf8()`. -- @param buffer The global buffer. -- @param bytes Bytes or `-1` for measuring to first NUL. -function buffer.set_length_for_encode(buffer, bytes) end +function set_length_for_encode(buffer, bytes) end --- -- Remember the current position in the undo history as the position at which -- the document was saved. -- @param buffer The global buffer. -function buffer.set_save_point(buffer) end +function set_save_point(buffer) end --- -- Select a range of text. @@ -2170,7 +2174,7 @@ function buffer.set_save_point(buffer) end -- document. -- @param end_pos End position. If negative, it means remove any selection (i.e. -- set the `anchor` to the same position as `current_pos`). -function buffer.set_sel(buffer, start_pos, end_pos) end +function set_sel(buffer, start_pos, end_pos) end --- -- Set the background color of the main and additional selections and whether to @@ -2178,7 +2182,7 @@ function buffer.set_sel(buffer, start_pos, end_pos) end -- @param buffer The global buffer. -- @param use_setting Enable color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_sel_back(buffer, use_setting, color) end +function set_sel_back(buffer, use_setting, color) end --- -- Set the foreground color of the main and additional selections and whether @@ -2186,14 +2190,14 @@ function buffer.set_sel_back(buffer, use_setting, color) end -- @param buffer The global buffer. -- @param use_setting Enable color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_sel_fore(buffer, use_setting, color) end +function set_sel_fore(buffer, use_setting, color) end --- -- Set a simple selection from anchor to caret. -- @param buffer The global buffer. -- @param caret The caret. -- @param anchor The anchor. -function buffer.set_selection(buffer, caret, anchor) end +function set_selection(buffer, caret, anchor) end --- -- Change style from current styling position for length characters to a style @@ -2201,13 +2205,13 @@ function buffer.set_selection(buffer, caret, anchor) end -- @param buffer The global buffer. -- @param length The length to style. -- @param style The style number to set. -function buffer.set_styling(buffer, length, style) end +function set_styling(buffer, length, style) end --- -- Replace the contents of the document with the argument text. -- @param buffer The global buffer. -- @param text The text. -function buffer.set_text(buffer, text) end +function set_text(buffer, text) end --- -- Set the way the display area is determined when a particular line is to be @@ -2217,21 +2221,21 @@ function buffer.set_text(buffer, text) end -- @param visible_policy A combination of `_SCINTILLA.constants.VISIBLE_SLOP`, -- (0x01) and `_SCINTILLA.constants.VISIBLE_STRICT` (0x04). -- @param visible_slop The slop value. -function buffer.set_visible_policy(buffer, visible_policy, visible_slop) end +function set_visible_policy(buffer, visible_policy, visible_slop) end --- -- Set the background color of all whitespace and whether to use this setting. -- @param buffer The global buffer. -- @param use_setting Enable color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_whitespace_back(buffer, use_setting, color) end +function set_whitespace_back(buffer, use_setting, color) end --- -- Set the foreground color of all whitespace and whether to use this setting. -- @param buffer The global buffer. -- @param use_setting Enable color change. -- @param color A color in `0xBBGGRR` format. -function buffer.set_whitespace_fore(buffer, use_setting, color) end +function set_whitespace_fore(buffer, use_setting, color) end --- -- Set the way the caret is kept visible when going sideways. @@ -2242,7 +2246,7 @@ function buffer.set_whitespace_fore(buffer, use_setting, color) end -- `_SCINTILLA.constants.CARET_JUMPS` (0x10), and -- `_SCINTILLA.constants.CARET_EVEN` (0x08). -- @param caret_slop A slop value. -function buffer.set_x_caret_policy(buffer, caret_policy, caret_slop) end +function set_x_caret_policy(buffer, caret_policy, caret_slop) end --- -- Set the way the line the caret is on is kept visible. @@ -2252,7 +2256,7 @@ function buffer.set_x_caret_policy(buffer, caret_policy, caret_slop) end -- `_SCINTILLA.constants.CARET_JUMPS` (0x10), and -- `_SCINTILLA.constants.CARET_EVEN` (0x08). -- @param caret_slop A slop value. -function buffer.set_y_caret_policy(buffer, caret_policy, caret_slop) end +function set_y_caret_policy(buffer, caret_policy, caret_slop) end --- -- Make a range of lines visible. @@ -2261,12 +2265,12 @@ function buffer.set_y_caret_policy(buffer, caret_policy, caret_slop) end -- @param buffer The global buffer. -- @param start_line The start line. -- @param end_line The end line. -function buffer.show_lines(buffer, start_line, end_line) end +function show_lines(buffer, start_line, end_line) end --- -- Start notifying the container of all key presses and commands. -- @param buffer The global buffer. -function buffer.start_record(buffer) end +function start_record(buffer) end --- -- Set the current styling position to pos and the styling mask to mask. @@ -2275,73 +2279,73 @@ function buffer.start_record(buffer) end -- @param buffer The global buffer. -- @param position The styling position. -- @param mask The bit mask of the style bytes that can be set. -function buffer.start_styling(buffer, position, mask) end +function start_styling(buffer, position, mask) end --- -- Stop notifying the container of all key presses and commands. -- @param buffer The global buffer. -function buffer.stop_record(buffer) end +function stop_record(buffer) end --- -- Move caret to bottom of page, or one page down if already at bottom of page. -- @param buffer The global buffer. -function buffer.stuttered_page_down(buffer) end +function stuttered_page_down(buffer) end --- -- Move caret to bottom of page, or one page down if already at bottom of page, -- extending selection to new caret position. -- @param buffer The global buffer. -function buffer.stuttered_page_down_extend(buffer) end +function stuttered_page_down_extend(buffer) end --- -- Move caret to top of page, or one page up if already at top of page. -- @param buffer The global buffer. -function buffer.stuttered_page_up(buffer) end +function stuttered_page_up(buffer) end --- -- Move caret to top of page, or one page up if already at top of page, -- extending selection to new caret position. -- @param buffer The global buffer. -function buffer.stuttered_page_up_extend(buffer) end +function stuttered_page_up_extend(buffer) end --- -- Clear all the styles and make equivalent to the global default style. -- @param buffer The global buffer. -function buffer.style_clear_all(buffer) end +function style_clear_all(buffer) end --- -- Reset the default style to its state at startup. -- @param buffer The global buffer. -function buffer.style_reset_default(buffer) end +function style_reset_default(buffer) end --- -- Swap that caret and anchor of the main selection. -- @param buffer The global buffer. -function buffer.swap_main_anchor_caret(buffer) end +function swap_main_anchor_caret(buffer) end --- -- If selection is empty or all on one line replace the selection with a tab -- character, or if more than one line selected, indent the lines. -- @param buffer The global buffer. -function buffer.tab(buffer) end +function tab(buffer) end --- -- Returns the target converted to UTF8. -- @param buffer The global buffer. -function buffer.target_as_utf8(buffer) end +function target_as_utf8(buffer) end --- -- Make the target range start and end be the same as the selection range start -- and end. -- @param buffer The global buffer. -function buffer.target_from_selection(buffer) end +function target_from_selection(buffer) end --- -- Retrieve the height of a particular line of text in pixels. -- @param buffer The global buffer. -- @param line The line number. -- @return number -function buffer.text_height(buffer, line) end +function text_height(buffer, line) end --- -- Measure the pixel width of some text in a particular style. @@ -2350,36 +2354,36 @@ function buffer.text_height(buffer, line) end -- @param style_num The style number between `0` and `255`. -- @param text The text. -- @return number -function buffer.text_width(buffer, style_num, text) end +function text_width(buffer, style_num, text) end --- -- Switch between sticky and non-sticky: meant to be bound to a key. -- See `buffer.caret_sticky`. -- @param buffer The global buffer. -function buffer.toggle_caret_sticky(buffer) end +function toggle_caret_sticky(buffer) end --- -- Switch a header line between expanded and contracted. -- @param buffer The global buffer. -- @param line The line number. -function buffer.toggle_fold(buffer, line) end +function toggle_fold(buffer, line) end --- -- Undo one action in the undo history. -- @param buffer The global buffer. -function buffer.undo(buffer) end +function undo(buffer) end --- -- Transform the selection to upper case. -- @param buffer The global buffer. -function buffer.upper_case(buffer) end +function upper_case(buffer) end --- -- Sets whether a pop up menu is displayed automatically when the user presses -- the wrong mouse button. -- @param buffer The global buffer. -- @param allow_popup Allow popup menu. -function buffer.use_pop_up(buffer, allow_popup) end +function use_pop_up(buffer, allow_popup) end --- -- Display a list of strings and send notification when user chooses one. @@ -2388,54 +2392,54 @@ function buffer.use_pop_up(buffer, allow_popup) end -- @param item_list List of words separated by separator characters (initially -- spaces). -- @see _SCINTILLA.next_user_list_type -function buffer.user_list_show(buffer, list_type, item_list) end +function user_list_show(buffer, list_type, item_list) end --- -- Move caret to before first visible character on line. -- If already there move to first character on line. -- @param buffer The global buffer. -function buffer.vc_home(buffer) end +function vc_home(buffer) end --- -- Move caret to before first visible character on display line. -- If already there move to first character on display line. -- @param buffer The global buffer. -function buffer.vc_home_display(buffer) end +function vc_home_display(buffer) end --- -- Like `buffer:vc_home_display()` but extending selection to new caret -- position. -- @param buffer The global buffer. -function buffer.vc_home_display_extend(buffer) end +function vc_home_display_extend(buffer) end --- -- Like `buffer:vc_home()` but extending selection to new caret position. -- @param buffer The global buffer. -function buffer.vc_home_extend(buffer) end +function vc_home_extend(buffer) end --- -- Move caret to before first visible character on line. -- If already there move to first character on line. In either case, extend -- rectangular selection to new caret position. -- @param buffer The global buffer. -function buffer.vc_home_rect_extend(buffer) end +function vc_home_rect_extend(buffer) end --- -- Move caret to before first visible character on display line when word-wrap -- is enabled. -- If already there, go to first character on display line. -- @param buffer The global buffer. -function buffer.vc_home_wrap(buffer) end +function vc_home_wrap(buffer) end --- -- Like `buffer:vc_home_wrap()` but extending selection to new caret position. -- @param buffer The global buffer. -function buffer.vc_home_wrap_extend(buffer) end +function vc_home_wrap_extend(buffer) end --- -- Center current line in window. -- @param buffer The global buffer. -function buffer.vertical_centre_caret(buffer) end +function vertical_centre_caret(buffer) end --- -- Find the display line of a document line taking hidden lines into account. @@ -2444,7 +2448,7 @@ function buffer.vertical_centre_caret(buffer) end -- @param buffer The global buffer. -- @param line The line number. -- @return number -function buffer.visible_from_doc_line(buffer, line) end +function visible_from_doc_line(buffer, line) end --- -- Get position of end of word. @@ -2455,71 +2459,71 @@ function buffer.visible_from_doc_line(buffer, line) end -- search direction sets the type of the search as word or non-word and the -- search stops at the first non-matching character. Searches are also -- terminated by the start or end of the document. -function buffer.word_end_position(buffer, pos, only_word_chars) end +function word_end_position(buffer, pos, only_word_chars) end --- -- Move caret left one word. -- @param buffer The global buffer. -function buffer.word_left(buffer) end +function word_left(buffer) end --- -- Move caret left one word, position cursor at end of word. -- @param buffer The global buffer. -function buffer.word_left_end(buffer) end +function word_left_end(buffer) end --- -- Move caret left one word, position cursor at end of word, extending selection -- to new caret position. -- @param buffer The global buffer. -function buffer.word_left_end_extend(buffer) end +function word_left_end_extend(buffer) end --- -- Move caret left one word extending selection to new caret position. -- @param buffer The global buffer. -function buffer.word_left_extend(buffer) end +function word_left_extend(buffer) end --- -- Move to the previous change in capitalisation or underscores. -- @param buffer The global buffer. -function buffer.word_part_left(buffer) end +function word_part_left(buffer) end --- -- Move to the previous change in capitalisation or underscores extending -- selection to new caret position. -- @param buffer The global buffer. -function buffer.word_part_left_extend(buffer) end +function word_part_left_extend(buffer) end --- -- Move to the next change in capitalisation or underscores. -- @param buffer The global buffer. -function buffer.word_part_right(buffer) end +function word_part_right(buffer) end --- -- Move to the next change in capitalisation or underscores extending selection -- to new caret position. -- @param buffer The global buffer. -function buffer.word_part_right_extend(buffer) end +function word_part_right_extend(buffer) end --- -- Move caret right one word. -- @param buffer The global buffer. -function buffer.word_right(buffer) end +function word_right(buffer) end --- -- Move caret right one word, position cursor at end of word. -- @param buffer The global buffer. -function buffer.word_right_end(buffer) end +function word_right_end(buffer) end --- -- Move caret right one word, position cursor at end of word, extending -- selection to new caret position. -- @param buffer The global buffer. -function buffer.word_right_end_extend(buffer) end +function word_right_end_extend(buffer) end --- -- Move caret right one word extending selection to new caret position. -- @param buffer The global buffer. -function buffer.word_right_extend(buffer) end +function word_right_extend(buffer) end --- -- Get position of start of word. @@ -2530,26 +2534,26 @@ function buffer.word_right_extend(buffer) end -- search direction sets the type of the search as word or non-word and the -- search stops at the first non-matching character. Searches are also -- terminated by the start or end of the document. -function buffer.word_start_position(buffer, pos, only_word_chars) end +function word_start_position(buffer, pos, only_word_chars) end --- -- Returns the number of display lines needed to wrap a document line. -- @param buffer The global buffer. -- @param line The line number. -- @return number -function buffer.wrap_count(buffer, line) end +function wrap_count(buffer, line) end --- -- Magnify the displayed text by increasing the sizes by 1 point if the current -- zoom factor is less than 20 points. -- @param buffer The global buffer. -function buffer.zoom_in(buffer) end +function zoom_in(buffer) end --- -- Make the displayed text smaller by decreasing the sizes by 1 point if the -- current zoom factor is greater than -10 points. -- @param buffer The global buffer. -function buffer.zoom_out(buffer) end +function zoom_out(buffer) end -- External functions. @@ -2559,54 +2563,61 @@ function buffer.zoom_out(buffer) end -- top of all buffer functions to avoid unexpected behavior since most buffer -- functions operate on `_G.buffer`, which is not necessarily the given one. -- @param buffer The buffer to check. -function buffer.check_global(buffer) end +-- @see _G._G.buffer +function check_global(buffer) end --- -- Deletes the current buffer. -- WARNING: this function should NOT be called via scripts. Use `buffer:close()` --- instead, which prompts for confirmation if necessary. Generates a +-- instead, which prompts for confirmation if necessary. Emits a -- `BUFFER_DELETED` event. -- @param buffer The global buffer. -function buffer.delete(buffer) end +-- @see events.BUFFER_DELETED +function delete(buffer) end --- -- Gets a range of text from the current buffer. -- @param buffer The global buffer. -- @param start_pos The beginning position of the range of text to get. -- @param end_pos The end position of the range of text to get. -function buffer.text_range(buffer, start_pos, end_pos) end +function text_range(buffer, start_pos, end_pos) end --- -- Reloads the file in a given buffer. -- @param buffer The global buffer. -function buffer.reload(buffer) end +function reload(buffer) end --- -- Sets the encoding for the buffer, converting its contents in the process. -- @param buffer The global buffer. --- @param encoding The encoding to set. Valid encodings are ones that GTK's --- `g_convert()` function accepts (typically GNU iconv's encodings). +-- @param encoding The encoding to set. Valid encodings are ones that GNU iconv +-- accepts. -- @usage buffer.set_encoding(buffer, 'ASCII') -function buffer.set_encoding(buffer, encoding) end +function set_encoding(buffer, encoding) end --- -- Saves the current buffer to a file. +-- Emits `FILE_BEFORE_SAVE` and `FILE_AFTER_SAVE` events. -- @param buffer The global buffer. -function buffer.save(buffer) end +-- @see _G.events +function save(buffer) end --- -- Saves the current buffer to a file different than its filename property. +-- Emits a `FILE_SAVED_AS` event. -- @param buffer The global buffer. -- @param utf8_filename The new filepath to save the buffer to. Must be UTF-8 -- encoded. -function buffer.save_as(buffer, utf8_filename) end +-- @see _G.events +function save_as(buffer, utf8_filename) end --- -- Closes the current buffer. -- @param buffer The global buffer. -- If the buffer is dirty, the user is prompted to continue. The buffer is not -- saved automatically. It must be done manually. -function buffer.close(buffer) end +-- @return `true` if the buffer was closed; `nil` otherwise. +function close(buffer) end --- -- Replacement for `buffer.lexer_language =`. @@ -2618,21 +2629,21 @@ function buffer.close(buffer) end -- @param buffer The global buffer. -- @param lang The string language to set. -- @usage buffer.set_lexer(buffer, 'language_name') -function buffer.set_lexer(buffer, lang) end +function set_lexer(buffer, lang) end --- -- Replacement for `buffer.lexer_language`. -- @param buffer The global buffer. -- @param current Whether to get the lexer at the current caret position in -- multi-language lexers. The default is `false` and returns the parent lexer. -function buffer.get_lexer(buffer, current) end +function get_lexer(buffer, current) end --- -- Returns the name of the style associated with a style number. -- @param buffer The global buffer. -- @param style_num A style number from `0` to `255`. -- @see buffer.style_at -function buffer.get_style_name(buffer, style_num) end +function get_style_name(buffer, style_num) end -- Unused Fields. -- * use_palette |