Contents

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() for more information.


Fields


additional_caret_fore (number)

The foreground color, in “0xBBGGRR” format, of additional carets.


additional_carets_blink (bool)

Allow additional carets to blink. The default value is true.


additional_carets_visible (bool)

Display additional carets. The default value is true.


additional_sel_alpha (number)

The alpha value, ranging from 0 (transparent) to 255 (opaque), of additional selections. The default value is 256, for no alpha.


additional_sel_back (number)

The background color, in “0xBBGGRR” format, of additional selections. This field has no effect when calling buffer:set_sel_back(false, ...).


additional_sel_fore (number)

The foreground color, in “0xBBGGRR” format, of additional selections. This field has no effect when calling buffer:set_sel_fore(false, ...).


additional_selection_typing (bool)

Type into multiple selections. The default value is false.


all_lines_visible (bool, Read-only)

Whether or not all lines in the buffer are visible.


anchor (number)

The position of the beginning of the selected text.


annotation_lines (table, Read-only)

Table of the number of annotation lines for line numbers starting from zero.


annotation_style (table)

Table of style numbers for annotations for line numbers starting from zero. Only some style attributes are active in annotations: font, size/size_fractional, bold/weight, italics, fore, back, and character_set.


annotation_style_offset (number)

The beginning of the range of style numbers used for annotations. Annotation styles may be completely separated from standard text styles by setting a style offset. For example, setting this to 512 would allow the annotation styles to be numbered from 512 upto 767 so they do not overlap styles set by lexers (or margins if margins offset is 256). Each style number set with annotation_style has the offset added before looking up the style. The default value is 0.


annotation_text (table)

Table of annotation text for line numbers starting from zero.


annotation_visible (number)

The annotation visibility mode.

The default value is 0.


auto_c_auto_hide (bool)

Automatically hide the autocompletion list when no entries match typed text. The default value is true.


auto_c_cancel_at_start (bool)

Cancel autocompletion when backspacing to a position before where autocompletion started or before the word being completed. The default value is true, to cancel when backspacing before where autocompletion started.


auto_c_case_insensitive_behaviour (number)

The behavior setting for case insensitive autocompletion when buffer.auto_c_ignore_case is true.

The default value is 0.


auto_c_choose_single (bool)

Automatically choose the item in a single-item autocompletion list. The default value is false.


auto_c_current (number, Read-only)

The index of the currently selected item in the autocompletion list.


auto_c_current_text (string, Read-only)

The text of the currently selected item in the autocompletion list.


auto_c_drop_rest_of_word (bool)

Delete word characters after autocompleted text. The default value is false.


auto_c_fill_ups (string, Write-only)

A set of characters that choose the currently selected item in an autocompletion list when typed. The default value is an empty string.


auto_c_ignore_case (bool)

Ignore case when searching an autocompletion list for matches. The default value is false.


auto_c_max_height (number)

The maximum number of items to show in autocompletion and user lists. The default value is 5.


auto_c_max_width (number)

The maximum number of characters per row to show in autocompletion and user lists. The default value is 0, which automatically sizes the list to fit the longest item.


auto_c_order (number)

The order setting for autocompletion lists.

The default value is 0.


auto_c_separator (number)

The character byte that separates autocompletion list items. The default value is 32 (‘ ’).


auto_c_type_separator (number)

The character byte that separates autocompletion list items and their image types. Autocompletion list items can display both an image and text. Register images and their types using buffer:register_image() or buffer:register_rgba_image() before appending image types to list items after type separator characters. The default value is 63 (‘?’).


automatic_fold (number)

Bit-mask of options for automatic folding behavior.

The default value is 0.


back_space_un_indents (bool)

Un-indent text when backspacing within indentation. The default value is false.


buffered_draw (bool)

Buffer drawing to avoid flickering. Buffering draws each line of text into a bitmap buffer before drawing the bitmap to the screen. The default value is true.


call_tip_back (number, Write-only)

The background color, in “0xBBGGRR” format, for a call tip.


call_tip_fore (number, Write-only)

The foreground color, in “0xBBGGRR” format, for a call tip.


call_tip_fore_hlt (number, Write-only)

The foreground color, in “0xBBGGRR” format, for the highlighted part of a call tip.


call_tip_position (boolean)

Display the call tip above or below the text. The default value is false to display the call tip below the text.


call_tip_use_style (number)

The size in pixels of tab characters in call tips. When non-zero, also enables the use of _SCINTILLA.constants.STYLE_CALLTIP instead of _SCINTILLA.constants.STYLE_DEFAULT for call tip styles. The default value is 0, which does not treat tab characters specially.


caret_fore (number)

The foreground color, in “0xBBGGRR” format, of the caret.


caret_line_back (number)

The background color, in “0xBBGGRR” format, of the line containing the caret.


caret_line_back_alpha (number)

The background alpha value, ranging from 0 (transparent) to 255 (opaque), of the caret line. The default value is 256, for no alpha.


caret_line_visible (bool)

Color the background of the line containing the caret a different color. The default value is false.


caret_line_visible_always (bool)

Always show the caret line, even when the window is not in focus. The default value is false, showing the line only when the window is in focus.


caret_period (number)

The time in milliseconds between caret blinks. A value of 0 stops blinking. The default value is 500.


caret_sticky (number)

The preferred horizontal position of the caret when moving between lines.

The default value is 0.


caret_style (number)

The style of caret to draw.

The default value is 1.


caret_width (number)

The pixel width of the caret in insert mode, either 0, 1, 2, or 3, and only applicable to line carets. The default value is 1.


char_at (table, Read-only)

Table of character bytes at positions in the buffer starting from zero.


code_page (number)

The code page used to interpret buffer bytes as characters.

The default value is 0.


column (table, Read-only)

Table of column numbers, taking tab widths into account, for positions in the buffer starting from zero.


control_char_symbol (number)

The byte value of the character displayed in place of control characters, characters whose byte values are less than 32. Values less than 32 dispay ASCII mnemonics instead. The default value is 0.


current_pos (number)

The position of the caret. When set, does not scroll the caret into view.


cursor (number)

The cursor type.

The default value is -1.


dirty (bool)

Whether or not the buffer has unsaved changes. Unlike buffer.modify, this field is accessible from any buffer, not just the global one.


edge_colour (number)

The color, in “0xBBGGRR” format, used for the long line marker.


edge_column (number)

The column number to display the long line marker at.


edge_mode (number)

The long line edge mode.


encoding (string or nil)

The string encoding of the file on the hard drive or nil for binary files.


encoding_bom (string)

The byte-order mark, if any, of the file encoding.


end_at_last_line (bool)

Disable scrolling past the last line. The default value is true.


end_styled (number, Read-only)

The position of the last correctly styled character.


eol_mode (number)

The current end of line mode.

The default value is 0 on Windows platforms, 2 otherwise.


extra_ascent (number)

The amount of pixel padding above line text. The default value is 0.


extra_descent (number)

The amount of pixel padding below line text. The default is 0.


filename (string)

The UTF-8-encoded absolute path to the file associated with the buffer. Use string.iconv() and _G._CHARSET for charset conversions.


first_visible_line (number)

The line number of the line at the top of the view, starting from zero.


fold_expanded (table)

Table of flags indicating whether or not folds are expanded for line numbers starting from zero. Setting expanded fold states does not toggle folds; it only updates fold margin markers. Use buffer:toggle_fold() instead.


fold_flags (number)

Bit-mask of options for drawing folding lines.

The default value is 0.


fold_level (table)

Table of fold level bit-masks for line numbers starting from zero. Fold level masks are composed of an integer level combined with any of the following bits:


fold_parent (table, Read-only)

Table of parent line numbers (fold points) for child line numbers starting from zero. A line number of -1 means no line was found.


h_scroll_bar (bool)

Display the horizontal scroll bar. The default value is true.


highlight_guide (number)

The indentation guide column number to highlight, or 0 to stop highlighting.


hotspot_active_underline (bool)

Underline active hotspots. The default value is true.


hotspot_single_line (bool)

Limit hotspots to a single line. The default value is true.


indent (number)

The number of spaces used for one level of indentation. The default value is 0, which matches the tab size.


indentation_guides (number)

The indentation guide drawing mode. Indentation guides are dotted vertical lines that appear within indentation whitespace at each level of indentation.

The default value is 0.


indic_alpha (table)

Table of fill color alpha values, ranging from 0 (transparent) to 255 (opaque), for indicator numbers from 0 to 31 whose styles are either INDIC_ROUNDBOX, INDIC_STRAIGHTBOX, or INDIC_DOTBOX. The default values are 256, for no alpha.


indic_fore (table)

Table of foreground colors, in “0xBBGGRR” format, for indicator numbers from 0 to 31.


indic_outline_alpha (table)

Table of outline color alpha values, ranging from 0 (transparent) to 255 (opaque), for indicator numbers from 0 to 31 whose styles are either INDIC_ROUNDBOX, INDIC_STRAIGHTBOX, or INDIC_DOTBOX. The default values are 256, for no alpha.


indic_style (table)

Table of styles for indicator numbers from 0 to 31.

Use _SCINTILLA.next_indic_number() for custom indicators.


indic_under (table)

Table of flags indicating whether or not to draw indicators over text or under it for indicator numbers from 0 to 31. For values to be true, buffer.two_phase_draw must be true. The default values are false for drawing indicators over text.


indicator_current (number)

The indicator number in the range of 0 to 31 used by buffer:indicator_fill_range() and buffer:indicator_clear_range().


indicator_value (number)

The indicator value used for buffer:indicator_fill_range(). Currently, all values are drawn the same, but it may be possible to draw different values in different styles in the future.


layout_cache (number)

The layout cache mode.

The default value is 1.


length (number, Read-only)

The number of bytes in the buffer.


lexer (number)

The numeric ID of the Scintilla lexer used by the buffer.


lexer_language (string)

The name of the Scintilla lexer used by the buffer. You probably want to use buffer:get_lexer() instead.


line_count (number, Read-only)

The number of lines in the buffer. There is always at least one.


line_end_position (table, Read-only)

Table of positions at the ends of lines, but before any end of line characters, for line numbers starting from zero.


line_indent_position (table, Read-only)

Table of positions at the ends of line indentation for line numbers starting from zero.


line_indentation (table)

Table of line indentation amounts, measured in character columns, for line numbers starting from zero.


line_state (table)

Table of integer line states for line numbers starting from zero. Line states are used for storing longer lived parse states per line. They are available in addition to the 8 bits of styling information per character.


line_visible (table, Read-only)

Table of flags indicating whether or not lines are visible for line numbers starting from zero.


lines_on_screen (number, Read-only)

The number of completely visible lines in the view. It is possible to have a partial line visible at the bottom of the view.


main_selection (number)

The main, or most recent, selection. Only an existing selection can be made main.


margin_cursor_n (table)

Table of cursors shown for margin numbers from zero to four.

The default values are 7.


margin_left (number)

The size in pixels of the left margin of the buffer text. The default value is 1.


margin_mask_n (table)

Table of marker bit-masks for showing margin markers for margin numbers from zero to four. The default values are 0, 0x1FFFFFF, 0, 0, and 0, for a line margin and logical marker margin.


margin_options (number)

A bit-mask of margin option settings.

The default value is 0.


margin_right (number)

The size in pixels of the right margin of the buffer text. The default value is 1.


margin_sensitive_n (table)

Table of flags indicating whether or not mouse clicks in margins emit MARGIN_CLICK events for margin numbers from zero to four. The default values are false.


margin_style (table)

Table of style numbers for text margin line numbers starting from zero. Only some style attributes are active in text margins: font, size/size_fractional, bold/weight, italics, fore, back, and character_set.


margin_style_offset (number)

The beginning of the range of style numbers used for margin text. Margin styles may be completely separated from standard text styles by setting a style offset. For example, setting this to 256 would allow the margin styles to be numbered from 256 upto 511 so they do not overlap styles set by lexers. Each style number set with margin_style has the offset added before looking up the style.


margin_text (table)

Table of text in the text margin for line numbers starting from zero.


margin_type_n (table)

Table of margin types for margin numbers from zero to four.

The default values are true, false, false, false, and false, for a line number margin and symbol margins.


margin_width_n (table)

Table of margin widths in pixels for margin numbers from zero to four.


marker_alpha (table, Write-only)

Table of alpha values, ranging from 0 (transparent) to 255 (opaque), used for markers drawn in the text area, not the margin, for markers numbers from 0 to 31. The default values are 256, for no alpha.


marker_back (table, Write-only)

Table of background colors, in “0xBBGGRR” format, used for marker numbers from 0 to 31.


marker_back_selected (table, Write-only)

Table of background colors, in “0xBBGGRR” format, used for markers whose folding blocks are selected for marker numbers from 0 to 31. The default values are 0x0000FF.


marker_fore (table, Write-only)

Table of foreground colors, in “0xBBGGRR” format, used for marker numbers from 0 to 31.


max_line_state (number, Read-only)

The last line number with a non-zero line state.


modify (bool)

Whether or not the buffer has unsaved changes. Unlike buffer.dirty, this field is accessible only from the global buffer.


mouse_dwell_time (number)

The number of milliseconds the mouse must idle in order to generate a DWELL_START event, or _SCINTILLA.constants.SC_TIME_FOREVER to never generate one.


multi_paste (number)

The multiple selection paste mode.

The default value is 0.


multiple_selection (bool)

Enable multiple selection. The default value is false.


overtype (bool)

Enable overtype mode, where typed characters overwrite existing ones. The default value is false.


position_cache (number)

The number of entries in the position cache. The position cache stores position information for short runs of text so that their layout can be determined more quickly if the run recurs. The default value is 1024.


print_colour_mode (number)

The print color mode.


print_magnification (number)

The number of points to add to the size of each font when printing. Negative values are allowed. The default value is 0.


print_wrap_mode (number)

The print line wrap mode.


property (table)

Map of key-value string pairs used by lexers.


property_expanded (table, Read-only)

Map of key-value string pairs used by lexers with $() variable replacement performed in values.


property_int (table, Read-only)

Map of key-value pairs used by lexers with values interpreted as numbers, or 0 if not found.


punctuation_chars (string)

The set of characters considered to be punctuation characters. Set this only after setting buffer.word_chars. The default value is a string containing all characters not considered to be whitespace or word characters.


read_only (bool)

Whether or not the buffer is read-only. The default value is false.


rectangular_selection_anchor (number)

The position of the anchor of the rectangular selection.


rectangular_selection_anchor_virtual_space (number)

The amount of virtual space for the anchor of the rectangular selection.


rectangular_selection_caret (number)

The position of the caret of the rectangular selection.


rectangular_selection_caret_virtual_space (number)

The amount of virtual space for the caret of the rectangular selection.


rectangular_selection_modifier (number)

The modifier key used in combination with a mouse drag to create a rectangular selection.

The default value is 2.


rgba_image_height (number)

The height for an RGBA image to be defined using buffer:marker_define_rgba_image().


rgba_image_scale (number)

The scale factor in percent for an RGBA image to be defined using buffer:marker_define_rgba_image(). This is useful on OSX with a retina display where each display unit is 2 pixels: use a factor of 200 so that each image pixel is dsplayed using a screen pixel. The default scale, 100, will stretch each image pixel to cover 4 screen pixels on a retina display.


rgba_image_width (number)

The width for an RGBA image to be defined using buffer:marker_define_rgba_image() and buffer:register_rgba_image().


scroll_width (number)

The assumed buffer width for horizontal scrolling purposes. For performance, the view does not measure the display width of the buffer to determine the properties of the horizontal scroll bar, but uses an assumed width instead. To ensure the width of the currently visible lines can be scrolled use buffer.scroll_width_tracking. The default value is 2000.


scroll_width_tracking (bool)

Set the scroll width to the maximum width of a displayed line beyond buffer.scroll_width. The default value is false.


search_flags (number)

The bit-mask of search flags used by buffer:search_in_target().

The default value is 0.

Regular expression characters recognized are:


sel_alpha (number)

The alpha value, ranging from 0 (transparent) to 255 (opaque), of the selection. The default value is 256, for no alpha.


sel_eol_filled (bool)

Extend the selection to the right margin of the view. The default value is false.


selection_empty (bool, Read-only)

Whether or not no text is selected.


selection_end (number)

The position of the end of the selected text. When set, becomes the current position, but is not scrolled into view.


selection_is_rectangle (bool, Read-only)

Whether or not the selection is a rectangular selection.


selection_mode (number)

The selection mode.

When set, caret movement alters the selected text until this field is set again to the same value or buffer:cancel() is called.


selection_n_anchor (table)

Table of anchor positions for existing selections numbered from zero, the main selection.


selection_n_anchor_virtual_space (table)

Table of the amount of virtual space for anchors for existing selections numbered from zero, the main selection.


selection_n_caret (table)

Table of caret positions for existing selections numbered from zero, the main selection.


selection_n_caret_virtual_space (table)

Table of the amount of virtual space for carets for existing selections numbered from zero, the main selection.


selection_n_end (table)

Table of positions at the end of existing selections numbered from zero, the main selection.


selection_n_start (table)

Table of positions at the beginning of existing selections numbered from zero, the main selection.


selection_start (number)

The position of the beginning of the selected text. When set, becomes the anchor, but is not scrolled into view.


selections (number, Read-only)

The number of active selections.


style_at (table, Read-only)

Table of style bytes at positions in the buffer starting from zero.


style_back (table)

Table of background colors, in “0xBBGGRR” format, for style numbers from 0 to 255.


style_bits (number)

The number of bits in an 8-bit style byte to use for styling. The number of styling bits required by the current lexer is buffer.style_bits_needed. The default value is 5.


style_bits_needed (number, Read-only)

The number of styling bits required by the current lexer.


style_bold (table)

Table of flags indicating whether or not text within styles has a bold font face for style numbers from 0 to 255. The default values are false.


style_case (table)

Table of letter case modes for text within styles for style numbers from 0 to 255.

The default values are 0.


style_changeable (table)

Table of flags indicating whether or not text within styles is changeable for style numbers from 0 to 255. The default values are true. Currently, read-only styles do not allow the caret into the range of text, but ranges containing read-only text are deletable.


style_character_set (table)

Table of character sets for style numbers from 0 to 255.

The default values are 1.


style_eol_filled (table)

Table of flags indicating whether or not to extend the background colors of styles whose characters occur last on lines all the way to the right margin of the view for style numbers from 0 to 255. The default values are false.


style_font (table)

Table of font faces for style numbers from 0 to 255.


style_fore (table)

Table of foreground colors, in “0xBBGGRR” format, for style numbers from 0 to 255.


style_hot_spot (table)

Table of flags indicating whether or not text within styles is clickable for style numbers from 0 to 255. The default values are false.


style_italic (table)

Table of flags indicating whether or not text within styles has an italic font face for style numbers from 0 to 255. The default values are false.


style_size (table)

Table of font sizes, expressed in whole number points, for style numbers from 0 to 255.


style_size_fractional (table)

Table of character sizes, expressed in hundredths of a point, for style numbers from 0 to 255. For example, a text size of 9.4 points is set using 940.


style_underline (table)

Table of flags indicating whether or not text within styles has an underlined font face for style numbers from 0 to 255. The default values are false.


style_visible (table)

Table of flags indicating whether or not text within styles is visible for style numbers from 0 to 255. The default values are true.


style_weight (table)

Table of character weights ranging from 1 (very light) to 999 (very heavy) for text within styles for style numbers from 0 to 255. However, most fonts only support a small number of weights:

The default values are 400.


tab_indents (bool)

Tabbing indents within indentation. The default value is false.


tab_width (number)

The number of space characters represented by a tab character. The default value is 8.


tag (table)

List of tag match values from a regular expression search.


target_end (number)

The position of the end of the target range. This is also set by a successful buffer:search_in_target().


target_start (number)

The position of the beginning of the target range. This is also set by a successful buffer:search_in_target().


text_length (number, Read-only)

The number of characters in the buffer.


two_phase_draw (bool)

Draw in two phases: first the background and then the foreground. The default is true.


undo_collection (bool)

Collect undo information. When setting to false, call buffer:empty_undo_buffer() to avoid desynchronizing the undo buffer with the buffer text. The default value is true.


use_tabs (bool)

Use tabs or spaces in indentation. The default value is true, for using tabs.


v_scroll_bar (bool)

Display the vertical scroll bar. The default value is true.


view_eol (bool)

Display end of line characters. The default value is false.


view_ws (number)

The whitespace character visibility mode.

The default value is 0.


virtual_space_options (number)

The virtual space mode.

The default value is 0.


whitespace_chars (string)

The set of characters considered to be whitespace characters when moving or selecting text by word. Set this only after setting buffer.word_chars. The default value is a string containing all non-newline characters less than ASCII value 33.


whitespace_size (number)

The size of the dots in pixels used to represent space characters when whitespace is visible. The default value is 1.


word_chars (string)

The set of characters considered to be word characters when moving or selecting text by word. The default value is a string containing alphanumeric characters, an underscore, and all characters greater than ASCII value 127.


wrap_indent_mode (number)

The wrapped line indent mode.

The default value is 0.


wrap_mode (number)

Long line wrap mode.

The default value is 0.


wrap_start_indent (number)

The number of spaces to indent wrapped lines by if buffer.wrap_indent_mode is _SCINTILLA.constants.SC_WRAP_INDENT_FIXED. The default value is 0.


wrap_visual_flags (number)

The wrapped line visual display mode.

The default value is 0.


wrap_visual_flags_location (number)

The wrapped line visual flag drawing mode.

The default value is 0.


x_offset (number)

The horizontal scroll position in pixels. A value of 0 is the normal position with the first text column visible at the left of the view.


zoom (number)

The number of points to add to the size of all fonts. Negative values are allowed. The default value is 0.


Functions


add_selection(buffer, caret, anchor)

Selects the change of text from anchor to caret as the main selection, retaining all other selections as additional selections. Even if no text is selected, the current position counts as an empty selection. Use buffer:set_selection() first when setting a list of selections.

Parameters:


add_text(buffer, text)

Adds string text to the buffer at the caret and moves the caret to the end of the added text, but does not scroll it into view.

Parameters:


allocate(buffer, bytes)

Enlarges the buffer to store bytes number of bytes, but never shrinks it beyond the size of its contents.

Parameters:


annotation_clear_all(buffer)

Clears annotations from all lines.

Parameters:


append_text(buffer, text)

Appends string text to the end of the buffer without changing the selected text or scrolling the text into view.

Parameters:


auto_c_active(buffer)

Returns whether or not an autocompletion list is visible.

Parameters:

Return:


auto_c_cancel(buffer)

Cancels the autocompletion list.

Parameters:


auto_c_complete(buffer)

Autocompletes the selected word in the list.

Parameters:


auto_c_pos_start(buffer)

Returns the position where autocompletion started at.

Parameters:

Return:


auto_c_select(buffer, string)

Selects the first item in the autocompletion list that starts with string, considering case sensitiveness depending on buffer.auto_c_ignore_case.

Parameters:


auto_c_show(buffer, len_entered, item_list)

Displays an autocompletion list from item_list, a sorted string whose items are delimited by buffer.auto_c_separator characters, using len_entered number of characters behind the caret as the prefix of the word to autocomplete. The sorted order of item_list, buffer.auto_c_order, must be already defined.

Parameters:


auto_c_stops(buffer, chars)

Defines chars as the set of characters that cancel autocompletion when typed. The default set is an empty string.

Parameters:


back_tab(buffer)

Dedents the selected lines.

Parameters:


begin_undo_action(buffer)

Starts a sequence of actions to undo or redo as a single action. May be nested.

Parameters:


brace_bad_light(buffer, pos)

Highlights the character at position pos as an unmatched brace character in the _SCINTILLA.constants.STYLE_BRACEBAD style. Removes highlighting when pos is -1.

Parameters:


brace_bad_light_indicator(buffer, use_indicator, indic_num)

Highlights unmatched brace characters with indicator number indic_num, in the range of 0 to 31, instead of the _SCINTILLA.constants.STYLE_BRACEBAD style if use_indicator is true.

Parameters:


brace_highlight(buffer, pos1, pos2)

Highlights the characters at positions pos1 and pos2 as matching braces in the _SCINTILLA.constants.STYLE_BRACELIGHT style. If indent guides are enabled, locate the column with buffer.column and set buffer.highlight_guide in order to highlight the indent guide.

Parameters:


brace_highlight_indicator(buffer, use_indicator, indic_num)

Highlights matching brace characters with indicator number indic_num, in the range of 0 to 31, instead of the _SCINTILLA.constants.STYLE_BRACELIGHT style if use_indicator is true.

Parameters:


brace_match(buffer, pos)

Returns the position of the matching brace for the brace character at position pos, taking nested braces into account, or -1. The brace characters recognized are ‘(’, ‘)’, ‘[’, ‘]’, ‘{’, ‘}’, ‘<’, and ‘>’ and must have the same style.

Parameters:

Return:


call_tip_active(buffer)

Returns whether or not a call tip is visible.

Parameters:

Return:


call_tip_cancel(buffer)

Removes the call tip from view.

Parameters:


call_tip_pos_start(buffer)

Returns the position where the call tip displayed at.

Parameters:

Return:


call_tip_set_hlt(buffer, start_pos, end_pos)

Highlights call tip text from start_pos, starting from zero, to end_pos with the color buffer.call_tip_fore_hlt.

Parameters:


call_tip_show(buffer, pos, text)

Displays a call tip containing string text for the word behind position pos. Any “\001” or “\002” bytes in text are replaced by arrow visuals, indicating the word has more than one call tip.

Parameters:


can_paste(buffer)

Returns whether or not the clipboard has text to paste.

Parameters:

Return:


can_redo(buffer)

Returns whether or not there is an action to redo.

Parameters:

Return:


can_undo(buffer)

Returns whether or not there is an action to undo.

Parameters:

Return:


cancel(buffer)

Cancels the active call tip, autocompletion list, user list, selection mode, etc.

Parameters:


change_lexer_state(buffer, start_pos, end_pos)

Tells the lexer to re-process the range of text from start_pos to end_pos.

Parameters:


char_left(buffer)

Moves the caret left one character.

Parameters:


char_left_extend(buffer)

Moves the caret left one character, extending the selected text to the new position.

Parameters:


char_left_rect_extend(buffer)

Moves the caret left one character, extending the rectangular selection to the new position.

Parameters:


char_position_from_point(buffer, x, y)

Returns the character position closest to view coordinates x and y.

Parameters:

Return:


char_position_from_point_close(buffer, x, y)

Returns the character position closest to view coordinates x and y, or -1 if the point is outside the window or not close to any text.

Parameters:

Return:


char_right(buffer)

Moves the caret right one character.

Parameters:


char_right_extend(buffer)

Moves the caret right one character, extending the selected text to the new position.

Parameters:


char_right_rect_extend(buffer)

Moves the caret right one character, extending the rectangular selection to the new position.

Parameters:


check_global(buffer)

Ensures the buffer is the global one, _G.buffer, throwing an error otherwise. This function must be called in all buffer functions because only the global buffer can be worked with.

Parameters:

See also:


choose_caret_x(buffer)

Sets the preferred horizontal position of the caret when moving between lines to the current position.

Parameters:

See also:


clear(buffer)

Deletes the selected text or the character at the caret.

Parameters:


clear_all(buffer)

Deletes all of the text in the buffer unless the buffer is read-only.

Parameters:


clear_all_cmd_keys(buffer)

Clears Scintilla’s internal key bindings.

Parameters:


clear_document_style(buffer)

Clears all styling and folding information in the buffer.

Parameters:


clear_registered_images(buffer)

Clears all images registered using buffer:register_image() and buffer:register_rgba_image().

Parameters:


clear_selections(buffer)

Removes all selections and moves the caret to the beginning of the buffer.

Parameters:


close(buffer)

Closes the buffer, prompting the user to continue if there are unsaved changes, and returns true if the buffer was closed.

Parameters:

Return:


colourise(buffer, start_pos, end_pos)

Tells the lexer to style and fold the range of text from start_pos to end_pos. If end_pos is -1, styles and folds to the end of the buffer.

Parameters:


contracted_fold_next(buffer, line_start)

Returns the line number of the next contracted fold header line starting at line_start, or -1.

Parameters:

Return:


convert_eo_ls(buffer, mode)

Converts all line endings to end of line mode mode.

Parameters:


copy(buffer)

Copies the selected text to the clipboard. Multiple selections are copied in order with no delimiters. Rectangular selections are copied from top to bottom with line ending delimiters. Virtual space is not copied.

Parameters:


copy_allow_line(buffer)

Copies the selected text or the current line to the clipboard.

Parameters:


copy_range(buffer, start_pos, end_pos)

Copies the range of text from start_pos to end_pos to the clipboard.

Parameters:


copy_text(buffer, text)

Copies string text to the clipboard.

Parameters:


count_characters(buffer, start_pos, end_pos)

Returns the number of whole characters in-between positions start_pos and end_pos.

Parameters:

Return:


cut(buffer)

Cuts the selected text to the clipboard. Multiple selections are copied in order with no delimiters. Rectangular selections are copied from top to bottom with line ending delimiters. Virtual space is not copied.

Parameters:


del_line_left(buffer)

Deletes text from the caret to the beginning of the line.

Parameters:


del_line_right(buffer)

Deletes text from the caret to the end of the line.

Parameters:


del_word_left(buffer)

Deletes the word to the left of the caret, including any leading non-word characters. buffer.word_chars contains word characters.

Parameters:


del_word_right(buffer)

Deletes the word to the right of the caret, including any trailing non-word characters. buffer.word_chars contains word characters.

Parameters:


del_word_right_end(buffer)

Deletes the word to the right of the caret, excluding any trailing non-word characters. buffer.word_chars contains word characters.

Parameters:


delete(buffer)

Deletes the buffer. Do not call this function. Call buffer:close() instead. Emits a BUFFER_DELETED event.

Parameters:

See also:


delete_back(buffer)

Deletes the selected text or the character behind the caret.

Parameters:


delete_back_not_line(buffer)

Deletes the selected text or the character behind the caret unless the caret is at the beginning of a line.

Parameters:


delete_range(buffer, pos, length)

Deletes the range of text from pos to pos + length in the buffer.

Parameters:


doc_line_from_visible(buffer, display_line)

Returns the actual line number of displayed line number display_line, taking hidden lines into account. If display_line is less than or equal to zero, returns 0. If display_line is greater than or equal to the number of displayed lines, returns buffer.line_count.

Parameters:

Return:


document_end(buffer)

Moves the caret to the end of the buffer.

Parameters:


document_end_extend(buffer)

Moves the caret to the end of the buffer, extending the selected text to the new position.

Parameters:


document_start(buffer)

Moves the caret to the beginning of the buffer.

Parameters:


document_start_extend(buffer)

Moves the caret to the beginning of the buffer, extending the selected text to the new position.

Parameters:


edit_toggle_overtype(buffer)

Toggles buffer.overtype.

Parameters:


empty_undo_buffer(buffer)

Deletes the undo and redo history and sets buffer.modify to false.

Parameters:


encoded_from_utf8(buffer, string)

Returns the result of UTF-8-encoded string string converted into the buffer’s encoding.

Parameters:

Return:


end_undo_action(buffer)

Ends a sequence of actions to undo or redo as a single action.

Parameters:


ensure_visible(buffer, line)

Ensures line number line is visible by expanding any fold header lines hiding it.

Parameters:


ensure_visible_enforce_policy(buffer, line)

Ensures line number line is visible by expanding any fold header lines hiding it and applies the vertical caret policy set with buffer:set_visible_policy().

Parameters:


expand_children(buffer, line, level)

Expands the fold states of the fold header on line number line and its children with fold level level.

Parameters:


find_column(buffer, line, column)

Returns the position of column number column on line number line, taking tab and multi-byte characters into account, or the position at the end of line line.

Parameters:


fold_all(buffer, action)

Expands, contracts, or toggles the fold states of all fold headers in the buffer, depending on action. When toggling, the state of the first fold header in the buffer determines whether to expand or contract.

Parameters:


fold_children(buffer, line, action)

Expands, contracts, or toggles the fold states of the fold header on line number line and its children, depending on action.

Parameters:


fold_line(buffer, line, action)

Expands, contracts, or toggles the fold state of the fold header on line number line, depending on action.

Parameters:


form_feed(buffer)

Inserts a Form Feed (“\f”) character at the caret.

Parameters:


get_cur_line(buffer)

Returns the current line’s text and the index of the caret on the line, starting from zero.

Parameters:

Return:


get_hotspot_active_back(buffer)

Returns the numeric background color for active hotspots.

Parameters:

Return:


get_hotspot_active_fore(buffer)

Returns the numeric foreground color for active hotspots.

Parameters:

Return:


get_last_child(buffer, start_line, level)

Returns the line number of the last line after line number start_line whose fold level is greater than level or the level of start_line if level is -1.

Parameters:


get_lexer(buffer, current)

Returns the name of the lexer used by the buffer, or the name of the lexer under the caret in a multiple-language lexer if current is true.

Parameters:


get_line(buffer, line)

Returns the text on line number line, including end of line characters, and the length of the line.

Parameters:

Return:


get_line_sel_end_position(buffer, line)

Returns the position of the end of the selected text on line number line, or -1.

Parameters:


get_line_sel_start_position(buffer, line)

Returns the position of the beginning of the selected text on line number line, or -1.

Parameters:


get_sel_text(buffer)

Returns the selected text and its length. Multiple selections are included in order with no delimiters. Rectangular selections are included from top to bottom with line ending delimiters. Virtual space is not included.

Parameters:

Return:


get_style_name(buffer, style_num)

Returns the name of style number style_num, in the range of 0 to 255.

Parameters:

See also:


get_text(buffer)

Returns all of the text in the buffer and its length.

Parameters:


goto_line(buffer, line)

Places the caret an anchor at the beginning of line number line and scrolls them into view.

Parameters:


goto_pos(buffer, pos)

Places the caret and anchor at position pos and scrolls them into view.

Parameters:


grab_focus(buffer)

Sets the focus to the buffer’s view.

Parameters:


hide_lines(buffer, start_line, end_line)

Hides the range of lines from line number start_line to end_line. This has no effect on fold levels or fold flags and the first line cannot be hidden.

Parameters:


hide_selection(buffer, normal)

Do not highlight selected text if normal is true.

Parameters:


home(buffer)

Moves the caret to the beginning of the current line.

Parameters:


home_display(buffer)

Moves the caret to the beginning of the current wrapped line.

Parameters:


home_display_extend(buffer)

Moves the caret to the beginning of the current wrapped line, extending the selected text to the new position.

Parameters:


home_extend(buffer)

Moves the caret to the beginning of the current line, extending the selected text to the new position.

Parameters:


home_rect_extend(buffer)

Moves the caret to beginning of the current line, extending the rectangular selection to the new position.

Parameters:


home_wrap(buffer)

Moves the caret to beginning of the current wrapped line, or if already there, to the beginning of the actual line.

Parameters:


home_wrap_extend(buffer)

Like buffer:home_wrap(), but extends the selected text to the new position.

Parameters:


indicator_all_on_for(buffer, pos)

Returns a bit-mask representing which indicators are on at position pos. Bit 0 is set if indicator 0 is on, bit 1 for indicator 1, etc.

Parameters:

Return:


indicator_clear_range(buffer, pos, clear_length)

Clears indicator buffer.indicator_current over the range of text from pos to pos + clear_length.

Parameters:


indicator_end(buffer, indicator, pos)

Returns the end position of indicator number indicator, in the range of 0 to 31, at position pos.

Parameters:


indicator_fill_range(buffer, pos, fill_length)

Sets indicator buffer.indicator_value or buffer.indicator_current over the range of text from pos to pos + fill_length.

Parameters:


indicator_start(buffer, indicator, pos)

Returns the position of the beginning of indicator number indicator, in the range of 0 to 31, at position pos.

Parameters:


indicator_value_at(buffer, indicator, pos)

Returns the value of indicator number indicator, in the range of 0 to 31, at position pos.

Parameters:

Return:


insert_text(buffer, pos, text)

Inserts string text at position pos or the caret if pos is -1. If the caret is after the pos, it is moved appropriately, but not scrolled into view.

Parameters:


line_copy(buffer)

Copies the current line to the clipboard.

Parameters:


line_cut(buffer)

Cuts the current line to the clipboard.

Parameters:


line_delete(buffer)

Deletes the current line.

Parameters:


line_down(buffer)

Moves the caret down one line.

Parameters:


line_down_extend(buffer)

Moves the caret down one line, extending the selected text to the new position.

Parameters:


line_down_rect_extend(buffer)

Moves the caret down one line, extending the rectangular selection to the new position.

Parameters:


line_duplicate(buffer)

Duplicates the current line below the line.

Parameters:


line_end(buffer)

Moves the caret to the end of the current line.

Parameters:


line_end_display(buffer)

Moves the caret to the end of the current wrapped line.

Parameters:


line_end_display_extend(buffer)

Moves the caret to the end of the current wrapped line, extending the selected text to the new position.

Parameters:


line_end_extend(buffer)

Moves the caret to the end of the current line, extending the selected text to the new position.

Parameters:


line_end_rect_extend(buffer)

Moves the caret to the end of the current line, extending the rectangular selection to the new position.

Parameters:


line_end_wrap(buffer)

Moves the caret to the end of the current wrapped line, or if already there, to the end of the actual line.

Parameters:


line_end_wrap_extend(buffer)

Like buffer:line_end_wrap(), but extends the selected text to the new position.

Parameters:


line_from_position(buffer, pos)

Returns the line number containing position pos. Returns 0 if pos is less than 0 or buffer.line_count if pos is greater than buffer.length.

Parameters:

Return:


line_length(buffer, line)

Returns the number of characters on line number line, including end of line characters. To get line length excluding end of line characters, use buffer.line_end_position[line] - buffer:position_from_line(line).

Parameters:

Return:


line_scroll(buffer, columns, lines)

Scroll right columns columns and down lines lines. Negative values are allowed.

Parameters:


line_scroll_down(buffer)

Scroll the buffer down one line, keeping the caret visible.

Parameters:


line_scroll_up(buffer)

Scroll the buffer up one line, keeping the caret visible.

Parameters:


line_transpose(buffer)

Switch the current line with the previous one.

Parameters:


line_up(buffer)

Moves the caret up one line.

Parameters:


line_up_extend(buffer)

Moves the caret up one line, extending the selected text to the new position.

Parameters:


line_up_rect_extend(buffer)

Moves the caret up one line, extending the rectangular selection to the new position.

Parameters:


lines_join(buffer)

Joins the lines in the target range, inserting spaces in-between joined words.

Parameters:


lines_split(buffer, pixel_width)

Splits the lines in the target range into lines of width at most pixel_width or the width of the view if pixel_width is 0.

Parameters:


lower_case(buffer)

Converts the selected text to lower case letters.

Parameters:


margin_text_clear_all(buffer)

Clears margin text on all lines.

Parameters:


marker_add(buffer, line, marker_num)

Adds marker number marker_num, in the range of 0 to 31, on line number line, returning a marker handle which can be used in buffer:marker_delete_handle() and buffer:marker_line_from_handle(), or -1 if the marker cannot be added.

Parameters:

Return:


marker_add_set(buffer, line, marker_mask)

Adds the markers specified in the marker bit-mask marker_mask to line number line. Bit 0 is set to add marker 0, bit 1 for marker 1, etc., up to marker 31.

Parameters:


marker_define(buffer, marker_num, marker_symbol)

Sets the symbol marker_symbol shown in the margin for marker number marker_num, in the range of 0 to 31.

Parameters:

See also:


marker_define_pixmap(buffer, marker_num, pixmap)

Defines XPM image pixmap for marker number marker_num, in the range of 0 to 31. Pixmap markers use the _SCINTILLA.constants.SC_MARK_PIXMAP marker symbol.

Parameters:


marker_define_rgba_image(buffer, marker_num, pixels)

Defines RGBA image pixels for marker number marker_num, in the range of 0 to 31. RGBA image markers use the _SCINTILLA.constants.SC_MARK_RGBAIMAGE marker symbol. The dimensions for pixels, buffer.rgba_image_width and buffer.rgba_image_height, must be already defined. pixels is a sequence of 4 byte pixel values (red, blue, green, and alpha) defining the image line by line starting at the top-left pixel.

Parameters:


marker_delete(buffer, line, marker_num)

Deletes marker number marker_num, in the range of 0 to 31 or -1 for all markers, from line number line.

Parameters:


marker_delete_all(buffer, marker_num)

Deletes marker number marker_num, in the range of 0 to 31 or -1 for all markers, from all lines in the buffer.

Parameters:


marker_delete_handle(buffer, handle)

Deletes the marker with handle handle returned by buffer:marker_add().

Parameters:


marker_enable_highlight(buffer, enabled)

Highlights the margin fold markers for the current fold block if enabled is true.

Parameters:


marker_get(buffer, line)

Returns a bit-mask representing which markers are set line number line. Bit 0 is set if marker 0 is set, bit 1 for marker 1, etc.

Parameters:

Return:


marker_line_from_handle(buffer, handle)

Returns the line number the marker with handle handle, returned by buffer:marker_add(), is on, or -1.

Parameters:

Return:


marker_next(buffer, start_line, marker_mask)

Returns the first line number starting at line number start_line that has all of the markers represented by marker bit-mask marker_mask set on, or -1. Bit 0 is set if marker 0 is set, bit 1 for marker 1, etc., up to marker 31.

Parameters:

Return:


marker_previous(buffer, start_line, marker_mask)

Returns the last line number before or on line number start_line that has all of the markers represented by marker bit-mask marker_mask set on, or -1. Bit 0 is set if marker 0 is set, bit 1 for marker 1, etc., up to marker 31.

Parameters:

Return:


marker_symbol_defined(buffer, marker_num)

Returns the symbol defined for marker number marker_num, in the range of 0 to 31, used in buffer:marker_define(), buffer:marker_define_pixmap(), or buffer:marker_define_rgba_image().

Parameters:

Return:


move_caret_inside_view(buffer)

Moves the caret to be visible inside the view if it is not already, removing any selections.

Parameters:


move_selected_lines_down(buffer)

Moves the selected lines down one line.

Parameters:


move_selected_lines_up(buffer)

Moves the selected lines up one line.

Parameters:


new()

Creates and returns a new buffer. Emits a BUFFER_NEW event.

Return:

See also:


new_line(buffer)

Inserts a new line character(s) at the caret depending on the end of line mode.

Parameters:


page_down(buffer)

Moves the caret one page down.

Parameters:


page_down_extend(buffer)

Moves the caret one page down, extending the selected text to the new position.

Parameters:


page_down_rect_extend(buffer)

Moves the caret one page down, extending the rectangular selection to the new position.

Parameters:


page_up(buffer)

Moves the caret one page up.

Parameters:


page_up_extend(buffer)

Moves the caret one page up, extending the selected text to the new position.

Parameters:


page_up_rect_extend(buffer)

Moves the caret one page up, extending the rectangular selection to the new position.

Parameters:


para_down(buffer)

Moves the caret one paragraph down. Paragraphs are surrounded by one or more blank lines.

Parameters:


para_down_extend(buffer)

Moves the caret one paragraph down, extending the selected text to the new position. Paragraphs are surrounded by one or more blank lines.

Parameters:


para_up(buffer)

Moves the caret one paragraph up. Paragraphs are surrounded by one or more blank lines.

Parameters:


para_up_extend(buffer)

Moves the caret one paragraph up, extending the selected text to the new position. Paragraphs are surrounded by one or more blank lines.

Parameters:


paste(buffer)

Pastes the contents of the clipboard into the buffer, replacing the selected text depending on buffer.multi_paste.

Parameters:


point_x_from_position(buffer, pos)

Returns the x-coordinate in the view of position pos.

Parameters:

Return:


point_y_from_position(buffer, pos)

Returns the y-coordinate in the view of position pos.

Parameters:

Return:


position_after(buffer, pos)

Returns the position of the next character after position pos, taking code page into account, or buffer.length - 1.

Parameters:


position_before(buffer, pos)

Returns the position of the previous character before position pos, taking code page into account, or 0.

Parameters:

Return:


position_from_line(buffer, line)

Returns the position at the beginning of line number line. Returns -1 if line is greater than buffer.line_count.

Parameters:

Return:


position_from_point(buffer, x, y)

Returns the position closest to view coordinates x and y, which may be in-between multi-byte characters.

Parameters:

Return:


position_from_point_close(buffer, x, y)

Returns the position closest to view coordinates x and y, which may be in-between multi-byte characters, or -1 if the point is outside the window or not close to any text.

Parameters:

Return:


redo(buffer)

Redoes the next undone action.

Parameters:


register_image(buffer, type, xpm_data)

Registers XPM image xpm_data to type number type for use in autocompletion lists.

Parameters:


register_rgba_image(buffer, type, pixels)

Registers RGBA image pixels to type number type for use in autocompletion lists. The dimensions for pixels, buffer.rgba_image_width and buffer.rgba_image_height, must be already defined. pixels is a sequence of 4 byte pixel values (red, blue, green, and alpha) defining the image line by line starting at the top-left pixel.

Parameters:


reload(buffer)

Reloads the file in the buffer.

Parameters:


replace_sel(buffer, text)

Replaces the selected text with string text, scrolling the caret into view.

Parameters:


replace_target(buffer, text)

Replaces the text in the target range with string text, returning the length of text. The recommended way to delete text in the buffer is to set the target to the text to be removed, and to call this function with an empty string.

Parameters:

Return:


replace_target_re(buffer, text)

Replaces the text in the target range with string text after replacing any “\d” sequences, where d is a number in the range of 1 to 9, with the tag match values from the regular expression or the entire match for “\0”, returning the length of the replacement text.

Parameters:

Return:


rotate_selection(buffer)

Sets the next additional selection to be the main selection.

Parameters:


save(buffer)

Saves the buffer to the file. Emits FILE_BEFORE_SAVE and FILE_AFTER_SAVE events.

Parameters:

See also:


save_as(buffer, utf8_filename)

Saves the buffer to the utf8_filename or user-specified filename. Emits a FILE_SAVED_AS event.

Parameters:

See also:


scroll_caret(buffer)

Scrolls the caret into view based on the policies set with buffer:set_x_caret_policy() and buffer:set_y_caret_policy().

Parameters:

See also:


scroll_range(buffer, secondary_pos, primary_pos)

Scrolls the range between primary_pos and secondary_pos into view, with priority given to primary_pos. Similar to buffer:scroll_caret(), but with primary_pos instead of buffer.current_pos. This is useful for scrolling search results into view.

Parameters:


scroll_to_end(buffer)

Scrolls to the end of the buffer without moving the caret.

Parameters:


scroll_to_start(buffer)

Scrolls to the beginning of the buffer without moving the caret.

Parameters:


search_anchor(buffer)

Sets the current position to anchor subsequent searches with buffer:search_next() and buffer:search_prev().

Parameters:


search_in_target(buffer, text)

Searches for the first occurrence of string text in the target range bounded by buffer.target_start and buffer.target_end using search flags buffer.search_flags and, if found, sets the new target range to that occurrence, returning its position or -1 otherwise.

Parameters:

Return:

See also:


search_next(buffer, flags, text)

Searches for and selects the first occurrence of string text starting at the search anchor using search flags flags, returning the position of the occurrence or -1. Selected text is not scrolled into view.

Parameters:

Return:

See also:


search_prev(buffer, flags, text)

Searches for and selects the last occurrence of string text before the search anchor using search flags flags, returning the position of the occurrence or -1.

Parameters:

Return:

See also:


select_all(buffer)

Selects all of the text in the buffer without scrolling the view.

Parameters:


selection_duplicate(buffer)

Duplicates the selected text or the current line.

Parameters:


set_chars_default(buffer)

Resets the set of whitespace and word characters to their default characters.

Parameters:

See also:


set_empty_selection(buffer, pos)

Sets the current position to position pos without scrolling the view, removing any selections.

Parameters:


set_encoding(buffer, encoding)

Sets the encoding for the buffer to encoding, converting its contents from the old encoding to the new one.

Parameters:

Usage:


set_fold_margin_colour(buffer, use_setting, color)

Overrides the default color of the fold margin with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_fold_margin_hi_colour(buffer, use_setting, color)

Overrides the default highlight color of the fold margin with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_hotspot_active_back(buffer, use_setting, color)

Overrides the default background color of active hotspots with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_hotspot_active_fore(buffer, use_setting, color)

Overrides the default foreground color of active hotspots with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_length_for_encode(buffer, bytes)

Sets the length of string in buffer:encoded_from_utf8() to bytes.

Parameters:


set_lexer(buffer, lang)

Sets the name of the lexer used by the buffer to lang or the auto-detected language and then loads the appropriate language-specific module if the module exists.

Parameters:

Usage:


set_save_point(buffer)

Tells Scintilla the buffer has no unsaved changes.

Parameters:


set_sel(buffer, start_pos, end_pos)

Selects the range of text from start_pos to end_pos in the buffer, scrolling the selected text into view.

Parameters:


set_sel_back(buffer, use_setting, color)

Overrides the default background color of all selected text with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_sel_fore(buffer, use_setting, color)

Overrides the default foreground color of all selected text with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_selection(buffer, caret, anchor)

Selects the range of text from anchor to caret in the buffer, removing all other selections.

Parameters:


set_styling(buffer, length, style)

Sets the style of the next length characters, from the current styling position, to style number style, in the range from 0 to 255, and increments the styling position by length.

Parameters:


set_text(buffer, text)

Replaces all of the text in the buffer with string text.

Parameters:


set_visible_policy(buffer, visible_policy, visible_slop)

Sets the visible policy bit-mask visible_policy for displaying lines using buffer:ensure_visible_enforce_policy() to visible_slop number of lines from the bottom of the view. It is similar in operation to buffer:set_y_caret_policy().

Parameters:


set_whitespace_back(buffer, use_setting, color)

Overrides the background color of whitespace with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_whitespace_fore(buffer, use_setting, color)

Overrides the foreground color of whitespace with color, in “0xBBGGRR” format, if use_setting is true.

Parameters:


set_x_caret_policy(buffer, caret_policy, caret_slop)

Set the way the caret is kept visible when going sideways. The exclusion zone is given in pixels.

Parameters:


set_y_caret_policy(buffer, caret_policy, caret_slop)

Set the way the line the caret is on is kept visible.

Parameters:


show_lines(buffer, start_line, end_line)

Shows the range of lines from line number start_line to end_line. This has no effect on fold levels or fold flags and the first line cannot be hidden.

Parameters:


start_styling(buffer, position, mask)

Begin styling at position position with the 8-bit styling bit-mask mask that determines which style bits can be set with buffer:set_styling().

Parameters:

Usage:


stuttered_page_down(buffer)

Moves the caret to the bottom of the page, or if already there, one page down.

Parameters:


stuttered_page_down_extend(buffer)

Like buffer:stuttered_page_down(), but extends the selected text to the new position.

Parameters:


stuttered_page_up(buffer)

Moves the caret to the top of the page, or if already there, one page up.

Parameters:


stuttered_page_up_extend(buffer)

Like buffer:stuttered_page_up(), but extends the selected text to the new position.

Parameters:


style_clear_all(buffer)

Sets all styles to have the same properties as _SCINTILLA.constants.STYLE_DEFAULT.

Parameters:


style_reset_default(buffer)

Resets _SCINTILLA.constants.STYLE_DEFAULT to its initial state.

Parameters:


swap_main_anchor_caret(buffer)

Swaps the anchor and caret positions of the main selection.

Parameters:


tab(buffer)

Indents the selected lines, replaces the selected text on a line with a Tab character (“\t”), or inserts a Tab character at the caret.

Parameters:


target_as_utf8(buffer)

Returns the result of the text in the target range converted from the buffer’s code page into UTF-8.

Parameters:


target_from_selection(buffer)

Sets the beginning and end positions of the target range to be the beginning and end positions of the main selection.

Parameters:


text_height(buffer, line)

Returns the height in pixels of line number line.

Parameters:

Return:


text_range(buffer, start_pos, end_pos)

Returns the range of text from start_pos to end_pos in the buffer.

Parameters:


text_width(buffer, style_num, text)

Returns the width in pixels of string text styled with style number style_num, in the range of 0 to 255.

Parameters:

Return:


toggle_caret_sticky(buffer)

Cycles between caret sticky option settings _SCINTILLA.constants.SC_CARETSTICKY_ON, _SCINTILLA.constants.SC_CARETSTICKY_WHITESPACE, and _SCINTILLA.constants.SC_CARETSTICKY_OFF.

Parameters:

See also:


toggle_fold(buffer, line)

Toggles the fold state of a fold header line between expanded, where all of its child lines are displayed, and contracted, where all of its child lines are hidden.

Parameters:


undo(buffer)

Undoes the most recent action.

Parameters:


upper_case(buffer)

Converts the selected text to upper case letters.

Parameters:


user_list_show(buffer, list_type, item_list)

Displays a list from item_list, a sorted string whose items are delimited by buffer.auto_c_separator characters, using the list identifier number list_type which is greater than zero and sent in a USER_LIST_SELECTION event after selecting an item.

Parameters:

See also:


vc_home(buffer)

Moves the caret to the first visible character on the current line, or if already there, to the beginning of the current line.

Parameters:


vc_home_display(buffer)

Moves the caret to the first visible character on the current wrapped line, or if already there, to the beginning of the current wrapped line.

Parameters:


vc_home_display_extend(buffer)

Like buffer:vc_home_display(), but extends the selected text to the new position.

Parameters:


vc_home_extend(buffer)

Like buffer:vc_home(), but extends the selected text to the new position.

Parameters:


vc_home_rect_extend(buffer)

Like buffer:vc_home(), but extends the rectangular selection to the new position.

Parameters:


vc_home_wrap(buffer)

Moves the caret to the first visible character on the wrapped line, or if already there, to the beginning of the actual line.

Parameters:


vc_home_wrap_extend(buffer)

Like buffer:vc_home_wrap(), but extends the selected text to the new position.

Parameters:


vertical_centre_caret(buffer)

Centers current line in the view.

Parameters:


visible_from_doc_line(buffer, line)

Returns the displayed line number of actual line number line, taking hidden lines into account, or -1 if line is outside the range of lines in the buffer. Lines can occupy more than one display line if they wrap.

Parameters:

Return:


word_end_position(buffer, pos, only_word_chars)

Returns the position of the end of the word at position pos. buffer.word_chars contains word characters. If pos has a non-word character to its right and only_word_chars is false, returns the position of the first word character.

Parameters:


word_left(buffer)

Moves the caret left one word. buffer.word_chars contains word characters.

Parameters:


word_left_end(buffer)

Moves the caret left one word, positioning the caret at the end of the previous word. buffer.word_chars contains word characters.

Parameters:


word_left_end_extend(buffer)

Like buffer:word_left_end(), but extends the selected text to the new position.

Parameters:


word_left_extend(buffer)

Moves the caret left one word, extending the selected text to the new position. buffer.word_chars contains word characters.

Parameters:


word_part_left(buffer)

Moves to the previous underscore or change in capitalization within the current word. buffer.word_chars contains word characters.

Parameters:


word_part_left_extend(buffer)

Moves to the previous underscore or change in capitalization within the current word, extending the selected text to the new position. buffer.word_chars contains word characters.

Parameters:


word_part_right(buffer)

Moves to the next underscore or change in capitalization within the current word. buffer.word_chars contains word characters.

Parameters:


word_part_right_extend(buffer)

Moves to the next underscore or change in capitalization within the current word, extending the selected text to the new position. buffer.word_chars contains word characters.

Parameters:


word_right(buffer)

Moves the caret right one word. buffer.word_chars contains word characters.

Parameters:


word_right_end(buffer)

Moves the caret right one word, positioning the cursor at the end of the current word. buffer.word_chars contains word characters.

Parameters:


word_right_end_extend(buffer)

Like buffer:word_right_end(), but extends the selected text to the new position.

Parameters:


word_right_extend(buffer)

Moves the caret right one word, extending the selected text to the new position. buffer.word_chars contains word characters.

Parameters:


word_start_position(buffer, pos, only_word_chars)

Returns the position of the beginning of the word at position pos. buffer.word_chars contains word characters. If pos has a non-word character to its left and only_word_chars is false, returns the position of the last word character.

Parameters:


wrap_count(buffer, line)

Returns the number of wrapped lines needed to display line number line.

Parameters:

Return:


zoom_in(buffer)

Increases the size of all fonts by one point, up to 20.

Parameters:


zoom_out(buffer)

Decreases the size of all fonts by one point, down to -10.

Parameters: