Module buffer
The current buffer in the currently focused view. It also represents the structure of any buffer table in 'buffers'.
Fields
doc_pointer
: The pointer to the document associated with this buffer. (Used internally; read-only)dirty
: Flag indicating whether or not the buffer has been modified since it was last saved.filename
: The absolute path to the file associated with this buffer. It is encoded in UTF-8. Usetextadept.iconv()
for charset conversions.encoding
: The encoding of the file on the hard disk. It will be nil if the file is a binary file.encoding_bom
: The byte-order mark of the file encoding (if any).anchor
: The position of the opposite end of the selection to the caret.auto_c_auto_hide
: Flag indicating whether or not autocompletion is hidden automatically when nothing matches.auto_c_cancel_at_start
: Flag indicating whether or not autocompletion should be cancelled if the user backspaces to a position before where it was created.auto_c_choose_single
: Flag indicating whether or not a single item in autocompletion should be chosen automatically.auto_c_drop_rest_of_word
: Flag indicating whether or not autocompletion deletes any word characters after the inserted text upon completion.auto_c_fill_ups
: A string of characters that when typed will cause the autocompletion to choose the selected item.auto_c_ignore_case
: Flag indicating whether or not case is significant when performing autocompletion searches.auto_c_max_height
: The maximum height in rows of autocompletion and user lists. Default is 5.auto_c_max_width
: The maximum width in characters of autocompletion and user lists.auto_c_type_separator
: The (integer) type separator character in the string setting up an autocompletion list.back_space_un_indents
: Flag indicating whether or not a backspace press when the caret is within indentation unindents.buffered_draw
: Flag indicating whether or not text is drawn into a buffer first or directly onto the screen.call_tip_back
: The background color for the call tip. (Write-only)call_tip_fore
: The foreground color for the call tip. (Write-only)call_tip_fore_hlt
: The foreground color for the highlighted part of the call tip.call_tip_use_style
: Call tip tab size in pixels. (EnablesSTYLE_CALLTIP
.)caret_fore
: The foreground color of the caret.caret_line_back
: The color of the background of the line containing the caret.caret_line_back_alpha
: The background alpha of the caret line.caret_line_visible
: Flag indicating whether or not the background of the line containing the caret is a different color.caret_period
: The time in milliseconds that the caret is on and off. 0 is a steady on.caret_sticky
: Flag indicating whether or not the caret preferred x position can only be changed by explicit movement commands.caret_style
: The style of the caret to be drawn.
- 0: invisible
- 1: line
- 2: block
caret_width
: The width of the insert mode caret in pixels.char_at
: The character byte at given index position. (Read-only)code_page
: The code page used to interpret the bytes of the document as characters.column
: The column number of an index position, taking tab width into account.control_char_symbol
: The character used to display control characters. (< 32 uses that control character)current_pos
: The position of the caret.cursor
: The cursor type.
- -1: normal
- 4: wait.
direct_function
: The pointer to a function that processes messages for this Scintilla. (Read-only)direct_pointer
: The pointer value to use as the first function argument when calling the function returned by direct_function.eol_mode
: The end of line mode.
- 0:
CRLF
- 1:
CR
- 2:
LF
- 0:
edge_colour
: The color used in edge indication.edge_column
: The column number which text should be kept within.edge_mode
: The edge highlight mode.
- 0: None
- 1: Line
- 2: Background
end_at_last_line
: Flag indicating whether or not the maximum scroll position has the last line at the bottom of the view. Default is true.end_styled
: The position of the last correctly styled character. (Read-only)first_visible_line
: The display line at the top of the display. (Read-only)focus
: The internal focus flag.fold_expanded
: Flag indicating whether or not an indexed (header) line has been expanded.fold_level
: The fold level of an indexed line.
- 0x400: Base
- 0x1000: White
- 0x2000: Header
- 0x0FFF: Number mask
fold_parent
: The parent line of indexed (child) line. (Read-only)h_scroll_bar
: Flag indicating whether or not the horizontal scroll bar is visible.highlight_guide
: The highlighted indentation guide column.hotspot_active_underline
: Flag indicating whether or not active hotspots are underlined.hotspot_single_line
: Flag indicating whether or not hotspots are limited to a single line so hotspots on two lines do not merge.indent
: The indentation size.indentation_guides
: Flag indicating whether or not indentation guides are visible.indic_fore
: The foreground color of an indexed indicator.indic_style
: The style of an indexed indicator.
- 0: Plain
- 1: Squiggle
- 2: TT
- 3: Diagonal
- 4: Strike
- 5: Hidden
- 6: Box
- 7: Roundbox.
indic_under
: Flag indicating whether or not an indexed indicator is drawn over text. Default istrue
.indicator_current
: The indicator used forindicator_fill_range
andindicator_clear_range
.indicator_value
: The value used forindicator_fill_range
.key_words
: Unused.layout_cache
: The degree of caching of layout information.length
: The number of characters in the document. (Read-only).lexer
: The (integer) lexing language of the document.line_count
: The number of lines in the document (>= 1). (Read-only).line_end_position
: The position after the last visible character on an index line. (Read-only)line_indent_position
: The position before the first non-indentation character on an indexed line. (Read-only)line_indentation
: The number of columns an indexed line is indented.line_state
: Extra styling information of an indexed line.line_visible
: Flag indicating whether or not the indexed line is visible. (Read-only)lines_on_screen
: The number of lines completely visible. (Read-only)margin_left
: The size in pixels of the left margin.margin_mask_n
: The marker mask of an indexed margin.margin_right
: The size in pixels of the right margin.margin_sensitive_n
: Flag indicating whether or not the indexed margin is sensitive to mouse clicks.margin_type_n
: The type of an indexed margin.
- 0: Symbolic
- 1: Numeric
margin_width_n
: The width of an indexed margin in pixels.max_line_state
: The last line number that has a line state. (Read-only).mod_event_mask
: Mask of modification events sent to the container.modify
: Flag indicating whether or not the document is different from when it was last saved.mouse_down_captures
: Flag indicating whether or not the mouse is captured when its button is pressed.mouse_dwell_time
: The time in milliseconds the mouse must sit still to generate a mouse dwell event.overtype
: Flag indicating whether or not overtype mode is active.paste_convert_endings
: Flag indicating whether or not line endings are converted when pasting text.position_cache
: The number of entries in the position cache.print_colour_mode
: The print color mode.
- 0: Normal
- 1: Invert the light value of each style
- 2: Force black on white
- 3: Force background to be white
- 4: Only default background is forced to be white
print_magnification
: The print magnification added to the point size.print_wrap_mode
: Wrap mode.
- 0: None
- 1: Word
property
: The (string) value for a given (string) key index.property_int
: The (integer) value for a given (string) key index. (Read-only)read_only
: Flag indicating whether or not the document is read-only.scroll_width
: The document width assumed for scrolling.scroll_width_tracking
: Flag indicating whether or not the maximum width line displayed is used to set the scroll width.search_flags
: The search flags used bysearch_in_target
.sel_alpha
: The alpha of the selection.sel_eol_filled
: Flag indicating whether or not the selection end of line is filled.selection_end
: The position that ends the selection. (current_pos)selection_is_rectangle
: Flag indicating whether or not the selection is rectangular. (Read-only)selection_mode
: The mode of the current selection.
- 0: Stream
- 1: Rectangle
- 2: Lines
selection_start
: The position that starts the selection. (anchor)status
: error status. 0: OK.style_at
: The style byte at the index position. (Read-only)style_back
: The background color of an indexed style.style_bits
: The number of bits in style bytes.style_bits_needed
: The number of bits the current lexer needs for styling. (Read-only)style_bold
: Flag indicating whether or not the indexed style is bold.style_case
: The case of an indexed style.
- 0: Mixed
- 1: Upper
- 2: Lower
style_changeable
: Flag indicating whether or not the indexed style is changeable.style_character_set
: The character set of the font in the indexed style.style_eol_filled
: Flag indicating whether or not the indexed style's end of line is filled.style_font
: The font of the indexed style.style_fore
: The foreground color of the indexed style.style_hot_spot
: Flag indicating whether or not the indexed style is a hotspot.style_italic
: Flag indicating whether or not the indexed style is italic.style_size
: The font size of the indexed style.style_underline
: Flag indicating whether or not the indexed style is underlined.style_visible
: Flag indicating whether or not the indexed style is visible.tab_indents
: Flag indicating whether or not a tab press when the caret is within indentation indents.tab_width
: The visible size of a tab in multiples of the width of a space character.target_end
: The position that ends the target which is used for updating the document without affecting the scroll position.target_start
: The position that starts the target which is used for updating the document without affecting the scroll position.text_length
: The number of characters in the document. (Read-only)two_phase_draw
: Flag indicating whether or not drawing is performed in two phases: background and then foreground.undo_collection
: Flag indicating whether or not an undo history is being collected.use_palette
: Flag indicating whether or not Scintilla uses the env's palette calls to display more colors.use_tabs
: Flag indicating whether or not indentation uses tabs and spaces or just spaces.v_scroll_bar
: Flag indicating whether or not the vertical scroll bar is visible.view_eol
: Flag indicating whether or not end of line characters are visible.view_ws
: Flag indicating whether or not whitespace characters are visible.whitespace_chars
: The set of characters making up whitespace when moving or selecting by word. Should be called after setting word_chars. (Write-only)word_chars
: The set of characters making up words when moving or selecting by word. (Write-only)wrap_mode
: Flag indicating whether or not text is word wrapped.wrap_start_indent
: The start indent for wrapped lines.wrap_visual_flags
: The display mode of visual flags for wrapped lines.
- 0: None
- 1: End
- 2: Start
wrap_visual_flags_location
: The location of visual flags for wrapped lines.
- 0: Default
- 1: End by text
- 2: Start by text
x_offset
: The horizontal scroll position.zoom
: The zoom level added to all font sizes. +: magnify, -: reduce.
Fields
doc_pointer
: The pointer to the document associated with this buffer. (Used internally; read-only)dirty
: Flag indicating whether or not the buffer has been modified since it was last saved.filename
: The absolute path to the file associated with this buffer. It is encoded in UTF-8. Usetextadept.iconv()
for charset conversions.encoding
: The encoding of the file on the hard disk. It will be nil if the file is a binary file.encoding_bom
: The byte-order mark of the file encoding (if any).anchor
: The position of the opposite end of the selection to the caret.auto_c_auto_hide
: Flag indicating whether or not autocompletion is hidden automatically when nothing matches.auto_c_cancel_at_start
: Flag indicating whether or not autocompletion should be cancelled if the user backspaces to a position before where it was created.auto_c_choose_single
: Flag indicating whether or not a single item in autocompletion should be chosen automatically.auto_c_drop_rest_of_word
: Flag indicating whether or not autocompletion deletes any word characters after the inserted text upon completion.auto_c_fill_ups
: A string of characters that when typed will cause the autocompletion to choose the selected item.auto_c_ignore_case
: Flag indicating whether or not case is significant when performing autocompletion searches.auto_c_max_height
: The maximum height in rows of autocompletion and user lists. Default is 5.auto_c_max_width
: The maximum width in characters of autocompletion and user lists.auto_c_type_separator
: The (integer) type separator character in the string setting up an autocompletion list.back_space_un_indents
: Flag indicating whether or not a backspace press when the caret is within indentation unindents.buffered_draw
: Flag indicating whether or not text is drawn into a buffer first or directly onto the screen.call_tip_back
: The background color for the call tip. (Write-only)call_tip_fore
: The foreground color for the call tip. (Write-only)call_tip_fore_hlt
: The foreground color for the highlighted part of the call tip.call_tip_use_style
: Call tip tab size in pixels. (EnablesSTYLE_CALLTIP
.)caret_fore
: The foreground color of the caret.caret_line_back
: The color of the background of the line containing the caret.caret_line_back_alpha
: The background alpha of the caret line.caret_line_visible
: Flag indicating whether or not the background of the line containing the caret is a different color.caret_period
: The time in milliseconds that the caret is on and off. 0 is a steady on.caret_sticky
: Flag indicating whether or not the caret preferred x position can only be changed by explicit movement commands.caret_style
: The style of the caret to be drawn.
- 0: invisible
- 1: line
- 2: block
caret_width
: The width of the insert mode caret in pixels.char_at
: The character byte at given index position. (Read-only)code_page
: The code page used to interpret the bytes of the document as characters.column
: The column number of an index position, taking tab width into account.control_char_symbol
: The character used to display control characters. (< 32 uses that control character)current_pos
: The position of the caret.cursor
: The cursor type.
- -1: normal
- 4: wait.
direct_function
: The pointer to a function that processes messages for this Scintilla. (Read-only)direct_pointer
: The pointer value to use as the first function argument when calling the function returned by direct_function.eol_mode
: The end of line mode.
- 0:
CRLF
- 1:
CR
- 2:
LF
- 0:
edge_colour
: The color used in edge indication.edge_column
: The column number which text should be kept within.edge_mode
: The edge highlight mode.
- 0: None
- 1: Line
- 2: Background
end_at_last_line
: Flag indicating whether or not the maximum scroll position has the last line at the bottom of the view. Default is true.end_styled
: The position of the last correctly styled character. (Read-only)first_visible_line
: The display line at the top of the display. (Read-only)focus
: The internal focus flag.fold_expanded
: Flag indicating whether or not an indexed (header) line has been expanded.fold_level
: The fold level of an indexed line.
- 0x400: Base
- 0x1000: White
- 0x2000: Header
- 0x0FFF: Number mask
fold_parent
: The parent line of indexed (child) line. (Read-only)h_scroll_bar
: Flag indicating whether or not the horizontal scroll bar is visible.highlight_guide
: The highlighted indentation guide column.hotspot_active_underline
: Flag indicating whether or not active hotspots are underlined.hotspot_single_line
: Flag indicating whether or not hotspots are limited to a single line so hotspots on two lines do not merge.indent
: The indentation size.indentation_guides
: Flag indicating whether or not indentation guides are visible.indic_fore
: The foreground color of an indexed indicator.indic_style
: The style of an indexed indicator.
- 0: Plain
- 1: Squiggle
- 2: TT
- 3: Diagonal
- 4: Strike
- 5: Hidden
- 6: Box
- 7: Roundbox.
indic_under
: Flag indicating whether or not an indexed indicator is drawn over text. Default istrue
.indicator_current
: The indicator used forindicator_fill_range
andindicator_clear_range
.indicator_value
: The value used forindicator_fill_range
.key_words
: Unused.layout_cache
: The degree of caching of layout information.length
: The number of characters in the document. (Read-only).lexer
: The (integer) lexing language of the document.line_count
: The number of lines in the document (>= 1). (Read-only).line_end_position
: The position after the last visible character on an index line. (Read-only)line_indent_position
: The position before the first non-indentation character on an indexed line. (Read-only)line_indentation
: The number of columns an indexed line is indented.line_state
: Extra styling information of an indexed line.line_visible
: Flag indicating whether or not the indexed line is visible. (Read-only)lines_on_screen
: The number of lines completely visible. (Read-only)margin_left
: The size in pixels of the left margin.margin_mask_n
: The marker mask of an indexed margin.margin_right
: The size in pixels of the right margin.margin_sensitive_n
: Flag indicating whether or not the indexed margin is sensitive to mouse clicks.margin_type_n
: The type of an indexed margin.
- 0: Symbolic
- 1: Numeric
margin_width_n
: The width of an indexed margin in pixels.max_line_state
: The last line number that has a line state. (Read-only).mod_event_mask
: Mask of modification events sent to the container.modify
: Flag indicating whether or not the document is different from when it was last saved.mouse_down_captures
: Flag indicating whether or not the mouse is captured when its button is pressed.mouse_dwell_time
: The time in milliseconds the mouse must sit still to generate a mouse dwell event.overtype
: Flag indicating whether or not overtype mode is active.paste_convert_endings
: Flag indicating whether or not line endings are converted when pasting text.position_cache
: The number of entries in the position cache.print_colour_mode
: The print color mode.
- 0: Normal
- 1: Invert the light value of each style
- 2: Force black on white
- 3: Force background to be white
- 4: Only default background is forced to be white
print_magnification
: The print magnification added to the point size.print_wrap_mode
: Wrap mode.
- 0: None
- 1: Word
property
: The (string) value for a given (string) key index.property_int
: The (integer) value for a given (string) key index. (Read-only)read_only
: Flag indicating whether or not the document is read-only.scroll_width
: The document width assumed for scrolling.scroll_width_tracking
: Flag indicating whether or not the maximum width line displayed is used to set the scroll width.search_flags
: The search flags used bysearch_in_target
.sel_alpha
: The alpha of the selection.sel_eol_filled
: Flag indicating whether or not the selection end of line is filled.selection_end
: The position that ends the selection. (current_pos)selection_is_rectangle
: Flag indicating whether or not the selection is rectangular. (Read-only)selection_mode
: The mode of the current selection.
- 0: Stream
- 1: Rectangle
- 2: Lines
selection_start
: The position that starts the selection. (anchor)status
: error status. 0: OK.style_at
: The style byte at the index position. (Read-only)style_back
: The background color of an indexed style.style_bits
: The number of bits in style bytes.style_bits_needed
: The number of bits the current lexer needs for styling. (Read-only)style_bold
: Flag indicating whether or not the indexed style is bold.style_case
: The case of an indexed style.
- 0: Mixed
- 1: Upper
- 2: Lower
style_changeable
: Flag indicating whether or not the indexed style is changeable.style_character_set
: The character set of the font in the indexed style.style_eol_filled
: Flag indicating whether or not the indexed style's end of line is filled.style_font
: The font of the indexed style.style_fore
: The foreground color of the indexed style.style_hot_spot
: Flag indicating whether or not the indexed style is a hotspot.style_italic
: Flag indicating whether or not the indexed style is italic.style_size
: The font size of the indexed style.style_underline
: Flag indicating whether or not the indexed style is underlined.style_visible
: Flag indicating whether or not the indexed style is visible.tab_indents
: Flag indicating whether or not a tab press when the caret is within indentation indents.tab_width
: The visible size of a tab in multiples of the width of a space character.target_end
: The position that ends the target which is used for updating the document without affecting the scroll position.target_start
: The position that starts the target which is used for updating the document without affecting the scroll position.text_length
: The number of characters in the document. (Read-only)two_phase_draw
: Flag indicating whether or not drawing is performed in two phases: background and then foreground.undo_collection
: Flag indicating whether or not an undo history is being collected.use_palette
: Flag indicating whether or not Scintilla uses the env's palette calls to display more colors.use_tabs
: Flag indicating whether or not indentation uses tabs and spaces or just spaces.v_scroll_bar
: Flag indicating whether or not the vertical scroll bar is visible.view_eol
: Flag indicating whether or not end of line characters are visible.view_ws
: Flag indicating whether or not whitespace characters are visible.whitespace_chars
: The set of characters making up whitespace when moving or selecting by word. Should be called after setting word_chars. (Write-only)word_chars
: The set of characters making up words when moving or selecting by word. (Write-only)wrap_mode
: Flag indicating whether or not text is word wrapped.wrap_start_indent
: The start indent for wrapped lines.wrap_visual_flags
: The display mode of visual flags for wrapped lines.
- 0: None
- 1: End
- 2: Start
wrap_visual_flags_location
: The location of visual flags for wrapped lines.
- 0: Default
- 1: End by text
- 2: Start by text
x_offset
: The horizontal scroll position.zoom
: The zoom level added to all font sizes. +: magnify, -: reduce.
Fields
doc_pointer
: The pointer to the document associated with this buffer. (Used internally; read-only)dirty
: Flag indicating whether or not the buffer has been modified since it was last saved.filename
: The absolute path to the file associated with this buffer. It is encoded in UTF-8. Usetextadept.iconv()
for charset conversions.encoding
: The encoding of the file on the hard disk. It will be nil if the file is a binary file.encoding_bom
: The byte-order mark of the file encoding (if any).anchor
: The position of the opposite end of the selection to the caret.auto_c_auto_hide
: Flag indicating whether or not autocompletion is hidden automatically when nothing matches.auto_c_cancel_at_start
: Flag indicating whether or not autocompletion should be cancelled if the user backspaces to a position before where it was created.auto_c_choose_single
: Flag indicating whether or not a single item in autocompletion should be chosen automatically.auto_c_drop_rest_of_word
: Flag indicating whether or not autocompletion deletes any word characters after the inserted text upon completion.auto_c_fill_ups
: A string of characters that when typed will cause the autocompletion to choose the selected item.auto_c_ignore_case
: Flag indicating whether or not case is significant when performing autocompletion searches.auto_c_max_height
: The maximum height in rows of autocompletion and user lists. Default is 5.auto_c_max_width
: The maximum width in characters of autocompletion and user lists.auto_c_type_separator
: The (integer) type separator character in the string setting up an autocompletion list.back_space_un_indents
: Flag indicating whether or not a backspace press when the caret is within indentation unindents.buffered_draw
: Flag indicating whether or not text is drawn into a buffer first or directly onto the screen.call_tip_back
: The background color for the call tip. (Write-only)call_tip_fore
: The foreground color for the call tip. (Write-only)call_tip_fore_hlt
: The foreground color for the highlighted part of the call tip.call_tip_use_style
: Call tip tab size in pixels. (EnablesSTYLE_CALLTIP
.)caret_fore
: The foreground color of the caret.caret_line_back
: The color of the background of the line containing the caret.caret_line_back_alpha
: The background alpha of the caret line.caret_line_visible
: Flag indicating whether or not the background of the line containing the caret is a different color.caret_period
: The time in milliseconds that the caret is on and off. 0 is a steady on.caret_sticky
: Flag indicating whether or not the caret preferred x position can only be changed by explicit movement commands.caret_style
: The style of the caret to be drawn.
- 0: invisible
- 1: line
- 2: block
caret_width
: The width of the insert mode caret in pixels.char_at
: The character byte at given index position. (Read-only)code_page
: The code page used to interpret the bytes of the document as characters.column
: The column number of an index position, taking tab width into account.control_char_symbol
: The character used to display control characters. (< 32 uses that control character)current_pos
: The position of the caret.cursor
: The cursor type.
- -1: normal
- 4: wait.
direct_function
: The pointer to a function that processes messages for this Scintilla. (Read-only)direct_pointer
: The pointer value to use as the first function argument when calling the function returned by direct_function.eol_mode
: The end of line mode.
- 0:
CRLF
- 1:
CR
- 2:
LF
- 0:
edge_colour
: The color used in edge indication.edge_column
: The column number which text should be kept within.edge_mode
: The edge highlight mode.
- 0: None
- 1: Line
- 2: Background
end_at_last_line
: Flag indicating whether or not the maximum scroll position has the last line at the bottom of the view. Default is true.end_styled
: The position of the last correctly styled character. (Read-only)first_visible_line
: The display line at the top of the display. (Read-only)focus
: The internal focus flag.fold_expanded
: Flag indicating whether or not an indexed (header) line has been expanded.fold_level
: The fold level of an indexed line.
- 0x400: Base
- 0x1000: White
- 0x2000: Header
- 0x0FFF: Number mask
fold_parent
: The parent line of indexed (child) line. (Read-only)h_scroll_bar
: Flag indicating whether or not the horizontal scroll bar is visible.highlight_guide
: The highlighted indentation guide column.hotspot_active_underline
: Flag indicating whether or not active hotspots are underlined.hotspot_single_line
: Flag indicating whether or not hotspots are limited to a single line so hotspots on two lines do not merge.indent
: The indentation size.indentation_guides
: Flag indicating whether or not indentation guides are visible.indic_fore
: The foreground color of an indexed indicator.indic_style
: The style of an indexed indicator.
- 0: Plain
- 1: Squiggle
- 2: TT
- 3: Diagonal
- 4: Strike
- 5: Hidden
- 6: Box
- 7: Roundbox.
indic_under
: Flag indicating whether or not an indexed indicator is drawn over text. Default istrue
.indicator_current
: The indicator used forindicator_fill_range
andindicator_clear_range
.indicator_value
: The value used forindicator_fill_range
.key_words
: Unused.layout_cache
: The degree of caching of layout information.length
: The number of characters in the document. (Read-only).lexer
: The (integer) lexing language of the document.line_count
: The number of lines in the document (>= 1). (Read-only).line_end_position
: The position after the last visible character on an index line. (Read-only)line_indent_position
: The position before the first non-indentation character on an indexed line. (Read-only)line_indentation
: The number of columns an indexed line is indented.line_state
: Extra styling information of an indexed line.line_visible
: Flag indicating whether or not the indexed line is visible. (Read-only)lines_on_screen
: The number of lines completely visible. (Read-only)margin_left
: The size in pixels of the left margin.margin_mask_n
: The marker mask of an indexed margin.margin_right
: The size in pixels of the right margin.margin_sensitive_n
: Flag indicating whether or not the indexed margin is sensitive to mouse clicks.margin_type_n
: The type of an indexed margin.
- 0: Symbolic
- 1: Numeric
margin_width_n
: The width of an indexed margin in pixels.max_line_state
: The last line number that has a line state. (Read-only).mod_event_mask
: Mask of modification events sent to the container.modify
: Flag indicating whether or not the document is different from when it was last saved.mouse_down_captures
: Flag indicating whether or not the mouse is captured when its button is pressed.mouse_dwell_time
: The time in milliseconds the mouse must sit still to generate a mouse dwell event.overtype
: Flag indicating whether or not overtype mode is active.paste_convert_endings
: Flag indicating whether or not line endings are converted when pasting text.position_cache
: The number of entries in the position cache.print_colour_mode
: The print color mode.
- 0: Normal
- 1: Invert the light value of each style
- 2: Force black on white
- 3: Force background to be white
- 4: Only default background is forced to be white
print_magnification
: The print magnification added to the point size.print_wrap_mode
: Wrap mode.
- 0: None
- 1: Word
property
: The (string) value for a given (string) key index.property_int
: The (integer) value for a given (string) key index. (Read-only)read_only
: Flag indicating whether or not the document is read-only.scroll_width
: The document width assumed for scrolling.scroll_width_tracking
: Flag indicating whether or not the maximum width line displayed is used to set the scroll width.search_flags
: The search flags used bysearch_in_target
.sel_alpha
: The alpha of the selection.sel_eol_filled
: Flag indicating whether or not the selection end of line is filled.selection_end
: The position that ends the selection. (current_pos)selection_is_rectangle
: Flag indicating whether or not the selection is rectangular. (Read-only)selection_mode
: The mode of the current selection.
- 0: Stream
- 1: Rectangle
- 2: Lines
selection_start
: The position that starts the selection. (anchor)status
: error status. 0: OK.style_at
: The style byte at the index position. (Read-only)style_back
: The background color of an indexed style.style_bits
: The number of bits in style bytes.style_bits_needed
: The number of bits the current lexer needs for styling. (Read-only)style_bold
: Flag indicating whether or not the indexed style is bold.style_case
: The case of an indexed style.
- 0: Mixed
- 1: Upper
- 2: Lower
style_changeable
: Flag indicating whether or not the indexed style is changeable.style_character_set
: The character set of the font in the indexed style.style_eol_filled
: Flag indicating whether or not the indexed style's end of line is filled.style_font
: The font of the indexed style.style_fore
: The foreground color of the indexed style.style_hot_spot
: Flag indicating whether or not the indexed style is a hotspot.style_italic
: Flag indicating whether or not the indexed style is italic.style_size
: The font size of the indexed style.style_underline
: Flag indicating whether or not the indexed style is underlined.style_visible
: Flag indicating whether or not the indexed style is visible.tab_indents
: Flag indicating whether or not a tab press when the caret is within indentation indents.tab_width
: The visible size of a tab in multiples of the width of a space character.target_end
: The position that ends the target which is used for updating the document without affecting the scroll position.target_start
: The position that starts the target which is used for updating the document without affecting the scroll position.text_length
: The number of characters in the document. (Read-only)two_phase_draw
: Flag indicating whether or not drawing is performed in two phases: background and then foreground.undo_collection
: Flag indicating whether or not an undo history is being collected.use_palette
: Flag indicating whether or not Scintilla uses the env's palette calls to display more colors.use_tabs
: Flag indicating whether or not indentation uses tabs and spaces or just spaces.v_scroll_bar
: Flag indicating whether or not the vertical scroll bar is visible.view_eol
: Flag indicating whether or not end of line characters are visible.view_ws
: Flag indicating whether or not whitespace characters are visible.whitespace_chars
: The set of characters making up whitespace when moving or selecting by word. Should be called after setting word_chars. (Write-only)word_chars
: The set of characters making up words when moving or selecting by word. (Write-only)wrap_mode
: Flag indicating whether or not text is word wrapped.wrap_start_indent
: The start indent for wrapped lines.wrap_visual_flags
: The display mode of visual flags for wrapped lines.
- 0: None
- 1: End
- 2: Start
wrap_visual_flags_location
: The location of visual flags for wrapped lines.
- 0: Default
- 1: End by text
- 2: Start by text
x_offset
: The horizontal scroll position.zoom
: The zoom level added to all font sizes. +: magnify, -: reduce.
Functions
buffer:add_text (text) | Adds text to the document at the current position. |
buffer:allocate (bytes) | Enlarges the document to a particular size of text bytes |
buffer:append_text (text) | Appends a string to the end of the document without changing the selection. |
buffer:auto_c_active () | Returns a flag indicating whether or not an autocompletion list is visible. |
buffer:auto_c_cancel () | Removes the autocompletion list from the screen. |
buffer:auto_c_complete () | Item selected; removes the list and insert the selection. |
buffer:auto_c_get_current () | Returns the currently selected item position in the autocompletion list. |
buffer:auto_c_pos_start () | Returns the position of the caret when the autocompletion list was shown. |
buffer:auto_c_select (string) | Selects the item in the autocompletion list that starts with a string. |
buffer:auto_c_show (len_entered, item_list) | Displays an autocompletion list. |
buffer:auto_c_stops (chars) | Defines a set of characters that why typed cancel the autocompletion list. |
buffer:back_tab () | Dedents selected lines. |
buffer:begin_undo_action () | Starts a sequence of actions that are undone/redone as a unit. |
buffer:brace_bad_light (pos) | Highlights the character at a position indicating there's no matching brace. |
buffer:brace_highlight (pos1, pos2) | Highlights the characters at two positions as matching braces. |
buffer:brace_match (pos) | Returns the position of a matching brace at a position or -1. |
buffer:call_tip_active () | Returns a flag indicating whether or not a call tip is active. |
buffer:call_tip_cancel () | Removes the call tip from the screen. |
buffer:call_tip_pos_start () | Returns the position where the caret was before showing the call tip. |
buffer:call_tip_set_hlt (start_pos, end_pos) | Highlights a segment of a call tip. |
buffer:call_tip_show (pos, text) | Shows a call tip containing text at or near a position. |
buffer:can_paste () | Returns a flag indicating whether or not a paste will succeed. |
buffer:can_redo () | Returns a flag indicating whether or not there are redoable actions in the undo history. |
buffer:can_undo () | Returns a flag indicating whether or not there are redoable actions in the undo history. |
buffer:cancel () | Cancels any modes such as call tip or autocompletion list display. |
buffer:char_left () | Moves the caret left one character. |
buffer:char_left_extend () | Moves the caret left one character, extending the selection. |
buffer:char_left_rect_extend () | Moves the caret left one character, extending the rectangular selection. |
buffer:char_right () | Moves the caret right one character. |
buffer:char_right_extend () | Moves the caret right one character, extending the selection. |
buffer:char_right_rect_extend () | Moves the caret right one character, extending the rectangular selection. |
buffer:choose_caret_x () | Sets the last x chosen value to be the caret x position. |
buffer:clear () | Clears the selection. |
buffer:clear_all () | Deletes all text in the document. |
buffer:clear_all_cmd_keys () | Drops all key mappings. |
buffer:clear_document_style () | Sets all style bytes to 0, remove all folding information. |
buffer:clear_registered_images () | Clears all the registered XPM images. |
buffer:close () | |
buffer:colourise (start_pos, end_pos) | Colorizes a segment of the document using the current lexing language. |
buffer:convert_eo_ls (mode) | Converts all line endings in the document to one mode. |
buffer:copy () | Copies the selection to the clipboard. |
buffer:copy_range (start_pos, end_pos) | Copies a range of text to the clipboard. |
buffer:copy_text (text) | Copies argument text to the clipboard. |
buffer:cut () | Cuts the selection to the clipboard. |
buffer:del_line_left () | Deletes back from the current position to the start of the line. |
buffer:del_line_right () | Deletes forwards from the current position to the end of the line. |
buffer:del_word_left () | Deletes the word to the left of the caret. |
buffer:del_word_right () | Deletes the word to the right of the caret. |
buffer:delete () | Deletes the current buffer. |
buffer:delete_back () | Deletes the selection or the character before the caret. |
buffer:delete_back_not_line () | Deletes the selection or the character before the caret. |
buffer:doc_line_from_visible () | Returns the document line of a display line taking hidden lines into account. |
buffer:document_end () | Moves the caret to the last position in the document. |
buffer:document_end_extend () | Moves the caret to the last position in the document, extending the selection. |
buffer:document_start () | Moves the caret to the first position in the document. |
buffer:document_start_extend () | Moves the caret to the first position in the document, extending the selection. |
buffer:edit_toggle_overtype () | Switches from insert to overtype mode or the reverse. |
buffer:empty_undo_buffer () | Deletes the undo history. |
buffer:encoded_from_utf8 (string) | Translates a UTF8 string into the document encoding and returns its length. |
buffer:end_undo_action () | Ends a sequence of actions that is undone/redone as a unit. |
buffer:ensure_visible (line) | Ensures a particular line is visible by expanding any header line hiding it. |
buffer:ensure_visible_enforce_policy (line) | Ensures a particular line is visible by expanding any header line hiding it. |
buffer:find_column (line, column) | Returns the position of the column on a line taking into account tabs and multi-byte characters or the line end position. |
buffer:form_feed () | Inserts a form feed character. |
buffer:get_cur_line () | Returns the text of the line containing the caret and the index of the caret on the line. |
buffer:get_hotspot_active_back () | Returns the background color for active hotspots. |
buffer:get_hotspot_active_fore () | Returns the foreground color for active hotspots. |
buffer:get_last_child (header_line, level) | Returns the last child line of a header line. |
buffer:get_lexer_language () | Returns the name of the lexing language used by the document. |
buffer:get_line (line) | Returns the contents of a line. |
buffer:get_line_sel_end_position (line) | Returns the position of the end of the selection at the given line or -1. |
buffer:get_line_sel_start_position (line) | Returns the position of the start of the selection at the given line or -1. |
buffer:get_property (property) | Returns the value of a property. |
buffer:get_property_expanded () | Returns the value of a property with "$()" variable replacement. |
buffer:get_sel_text () | Returns the selected text. |
buffer:get_style_name (style_num) | Returns the name of the style associated with a style number. |
buffer:get_text () | Returns all text in the document and its length. |
buffer:goto_line (line) | Sets the caret to the start of a line and ensure it is visible. |
buffer:goto_pos (pos) | Sets the caret to a position and ensure it is visible. |
buffer:grab_focus () | Sets the focus to this Scintilla widget. |
buffer:hide_lines (start_line, end_line) | Makes a range of lines invisible. |
buffer:hide_selection (normal) | Draws the selection in normal style or with the selection highlighted. |
buffer:home () | Moves the caret to the first position on the current line. |
buffer:home_display () | Moves the caret to the first position on the display line. |
buffer:home_display_extend () | Moves the caret to the first position on the display line, extending the selection. |
buffer:home_extend () | Moves the caret to the first position on the current line, extending the selection. |
buffer:home_rect_extend () | Moves the caret to the first position on the current line, extending the rectangular selection. |
buffer:home_wrap () | Moves the caret to the start of the current display line and then the document line. |
buffer:home_wrap_extend () | Moves the caret to the start of the current display line and then the document line, extending the selection. |
buffer:indicator_all_on_for (pos) | Returns a flag indicating whether or not any indicators are present at the specified position. |
buffer:indicator_clear_range (pos, clear_length) | Turns an indicator off over a range. |
buffer:indicator_end (indicator, pos) | Returns the position where a particular indicator ends. |
buffer:indicator_fill_range (pos, fill_length) | Turns an indicator on over a range. |
buffer:indicator_start (indicator, pos) | Returns the position where a particular indicator starts. |
buffer:indicator_value_at (indicator, pos) | Returns the value of a particular indicator at the specified position. |
buffer:insert_text (pos, text) | Inserts text at a position. |
buffer:line_copy () | Copies the line containing the caret. |
buffer:line_cut () | Cuts the line containing the caret. |
buffer:line_delete () | Deletes the line containing the caret. |
buffer:line_down () | Moves the caret down one line. |
buffer:line_down_extend () | Moves the caret down one line, extending the selection. |
buffer:line_down_rect_extend () | Moves the caret down one line, extending the rectangular selection. |
buffer:line_duplicate () | Duplicates the current line. |
buffer:line_end () | Moves the caret to the last position on the current line. |
buffer:line_end_display () | Moves the caret to the last position on the display line. |
buffer:line_end_display_extend () | Moves the caret to the last position on the display line, extending the selection. |
buffer:line_end_extend () | Moves the caret to the last position on the current line, extending the selection. |
buffer:line_end_rect_extend () | Moves the caret to the last position on the current line, extending the rectangular selection. |
buffer:line_end_wrap () | Moves the caret to the last position on the current display line and then the document line. |
buffer:line_end_wrap_extend () | Moves the caret to the last position on the current display line and then the document line, extending the selection. |
buffer:line_from_position (pos) | Returns the line containing the position. |
buffer:line_length (line) | Returns the length of the specified line including EOL characters. |
buffer:line_scroll (columns, lines) | Scrolls horizontally and vertically the number of columns and lines. |
buffer:line_scroll_down () | Scrolls the document down, keeping the caret visible. |
buffer:line_scroll_up () | Scrolls the document up, keeping the caret visible. |
buffer:line_transpose () | Switches the current line with the previous. |
buffer:line_up () | Moves the caret up one line. |
buffer:line_up_extend () | Moves the caret up one line, extending the selection. |
buffer:line_up_rect_extend () | Moves the caret up one line, extending the rectangular selection. |
buffer:lines_join () | Joins the lines in the target. |
buffer:lines_split (pixel_width) | Splits lines in the target into lines that are less wide that pixel_width where possible. |
buffer:load_lexer_library (path) | Loads a lexer library (dll/so) |
buffer:lower_case () | Transforms the selection to lower case. |
buffer:marker_add (line, marker_num) | Adds a marker to a line, returning an ID which can be used to find or delete the marker. |
buffer:marker_add_set (line, set) | Adds a set of markers to a line. |
buffer:marker_define (marker_num, marker_symbol) | Sets the symbol used for a particular marker number. |
buffer:marker_define_pixmap (marker_num, pixmap) | Defines a marker from a pixmap. |
buffer:marker_delete (line, marker_num) | Deletes a marker from a line. |
buffer:marker_delete_all (marker_num) | Deletes all markers with a particular number from all lines. |
buffer:marker_delete_handle (handle) | Deletes a marker. |
buffer:marker_get (line) | Gets a bit mask of all the markers set on a line. |
buffer:marker_line_from_handle (handle) | Returns the line number at which a particular marker is located. |
buffer:marker_next (start_line, marker_mask) | Finds the next line after start_line that includes a marker in marker_mask. |
buffer:marker_previous (start_line, marker_mask) | Finds the previous line after start_line that includes a marker in marker_mask. |
buffer:marker_set_alpha (marker_num, alpha) | Sets the alpha used for a marker that is drawn in the text area, not the margin. |
buffer:marker_set_back (marker_num, color) | Sets the background color used for a particular marker number. |
buffer:marker_set_fore (marker_num, color) | Sets the foreground color used for a particular marker number. |
buffer:move_caret_inside_view () | Moves the caret inside the current view if it's not there already. |
buffer:new_line () | Inserts a new line depending on EOL mode. |
buffer:null () | Null operation |
buffer:page_down () | Moves the caret one page down. |
buffer:page_down_extend () | Moves the caret one page down, extending the selection. |
buffer:page_down_rect_extend () | Moves the caret one page down, extending the rectangular selection. |
buffer:page_up () | Moves the caret one page up. |
buffer:page_up_extend () | Moves the caret one page up, extending the selection. |
buffer:page_up_rect_extend () | Moves the caret one page up, extending the rectangular selection. |
buffer:para_down () | Moves the caret one paragraph down (delimited by empty lines). |
buffer:para_down_extend () | Moves the caret one paragraph down (delimited by empty lines), extending the selection. |
buffer:para_up () | Moves the caret one paragraph up (delimited by empty lines). |
buffer:para_up_extend () | Moves the caret one paragraph up (delimited by empty lines), extending the selection. |
buffer:paste () | Pastes the contents of the clipboard into the document replacing the selection. |
buffer:point_x_from_position (pos) | Returns the x value of the point in the window where a position is shown. |
buffer:point_y_from_position (pos) | Returns the y value of the point in the window where a position is shown. |
buffer:position_after (pos) | Returns the next position in the document taking code page into account. |
buffer:position_before (pos) | Returns the previous position in the document taking code page into account. |
buffer:position_from_line (line) | Returns the position at the start of the specified line. |
buffer:position_from_point (x, y) | Returns the position from a point within the window. |
buffer:position_from_point_close (x, y) | Returns the position from a point within the window, but return -1 if not close to text. |
buffer:redo () | Redoes the next action in the undo history. |
buffer:register_image (type, xmp_data) | Registers and XPM image for use in autocompletion lists. |
buffer:reload () | |
buffer:replace_sel (text) | Replaces the selected text with the argument text. |
buffer:replace_target (text) | Replaces the target text with the argument text. |
buffer:replace_target_re (text) | Replaces the target text with the argument text after \d processing. |
buffer:save () | |
buffer:save_as () | |
buffer:scroll_caret () | Ensures the caret is visible. |
buffer:search_anchor () | Sets the current caret position to be the search anchor. |
buffer:search_in_target (text) | Searches for a string in the target and sets the target to the found range, returning the length of the range or -1. |
buffer:search_next (flags, text) | Finds some text starting at the search anchor. |
buffer:search_prev (flags, text) | Finds some text starting at the search anchor and moving backwards. |
buffer:select_all () | Selects all the text in the document. |
buffer:selection_duplicate () | Duplicates the selection or the line containing the caret. |
buffer:set_chars_default () | Resets the set of characters for whitespace and word characters to the defaults. |
buffer:set_encoding () | |
buffer:set_fold_flags (flags) | Sets some style options for folding. |
buffer:set_fold_margin_colour (use_setting, color) | Sets the background color used as a checkerboard pattern in the fold margin. |
buffer:set_fold_margin_hi_colour (use_setting, color) | Sets the foreground color used as a checkerboard pattern in the fold margin. |
buffer:set_hotspot_active_back (use_setting, color) | Sets a background color for active hotspots. |
buffer:set_hotspot_active_fore (use_setting, color) | Sets a foreground color for active hotspots. |
buffer:set_length_for_encode (bytes) | Sets the length of the utf8 argument for calling encoded_from_utf8. |
buffer:set_lexer_language (language_name) | Sets the lexer language to the specified name. |
buffer:set_save_point () | Remembers the current position in the undo history as the position at which the document was saved. |
buffer:set_sel (start_pos, end_pos) | Selects a range of text. |
buffer:set_sel_back (use_setting, color) | Sets the background color of the selection and whether to use this setting. |
buffer:set_sel_fore (use_setting, color) | Sets the foreground color of the selection and whether to use this setting. |
buffer:set_styling (length, style) | Changes the style from the current styling position for a length of characters to a style and move the current styling position to after this newly styled segment. |
buffer:set_styling_ex (length, styles) | Sets the styles for a segment of the document. |
buffer:set_text (text) | Replaces the contents of the document with the argument text. |
buffer:set_visible_policy (visible_policy, visible_slop) | Sets the way the display area is determined when a particular line is to be moved to by find, find_next, goto_line, etc. |
buffer:set_whitespace_back (use_setting, color) | Sets the background color of all whitespace and whether to use this setting. |
buffer:set_whitespace_fore (use_setting, color) | Sets the foreground color of all whitespace and whether to use this setting. |
buffer:set_x_caret_policy (caret_policy, caret_slop) | Sets the way the caret is kept visible when going side-ways. |
buffer:set_y_caret_policy (caret_policy, caret_slop) | Sets the way the line the caret is visible on is kept visible. |
buffer:show_lines (start_line, end_line) | Makes a range of lines visible. |
buffer:start_record () | Starts notifying the container of all key presses and commands. |
buffer:start_styling (position, mask) | Sets the current styling position to pos and the styling mask to mask. |
buffer:stop_record () | Stops notifying the container of all key presses and commands. |
buffer:stuttered_page_down () | Moves caret to the bottom of the page, or one page down if already there. |
buffer:stuttered_page_down_extend () | Moves caret to the bottom of the page, or one page down if already there, extending the selection. |
buffer:stuttered_page_up () | Moves caret to the top of the page, or one page up if already there. |
buffer:stuttered_page_up_extend () | Moves caret to the top of the page, or one page up if already there, extending the selection. |
buffer:style_clear_all () | Resets all styles to the global default style. |
buffer:style_get_font (style_num) | Returns the font name of a given style. |
buffer:style_reset_default () | Resets the default style to its state at startup. |
buffer:tab () | Inserts a tab character or indent multiple lines. |
buffer:target_as_utf8 () | Returns the target converted to utf8. |
buffer:target_from_selection () | Makes the target range the same as the selection range. |
buffer:text_height (line) | Returns the height of a particular line of text in pixels. |
buffer:text_range (start_pos, end_pos) | Gets a range of text from the current buffer. |
buffer:text_width (style_num, text) | Returns the pixel width of some text in a particular style. |
buffer:toggle_caret_sticky () | Switches the caret between sticky and non-sticky. |
buffer:toggle_fold () | Switches a header line between expanded and contracted. |
buffer:undo () | Undoes one action in the undo history. |
buffer:upper_case () | Transforms the selection to upper case. |
buffer:use_pop_up (allow_popup) | Sets whether a pop up menu is displayed automatically when the user presses the right mouse button. |
buffer:user_list_show (list_type, item_list_string) | Displays a list of strings and sends a notification when one is chosen. |
buffer:vc_home () | Moves the caret to before the first visible character on the current line or the first character on the line if already there. |
buffer:vc_home_extend () | Moves the caret to before the first visible character on the current line or the first character on the line if already there, extending the selection. |
buffer:vc_home_rect_extend () | Moves the caret to before the first visible character on the current line or the first character on the line if already there, extending the rectangular selection. |
buffer:vc_home_wrap () | Moves the caret to the first visible character on the current display line and then the document line. |
buffer:vc_home_wrap_extend () | Moves the caret to the first visible character on the current display line and then the document line, extending the selection. |
buffer:visible_from_doc_line (line) | Returns the display line of a document line taking hidden lines into account. |
buffer:word_end_position (pos, only_word_chars) | Returns the position of the end of a word. |
buffer:word_left () | Moves the caret left one word. |
buffer:word_left_end () | Moves the caret left one word, positioning the caret at the end of the word. |
buffer:word_left_end_extend () | Moves the caret left one word, positioning the caret at the end of the word, extending the selection. |
buffer:word_left_extend () | Moves the caret left one word, extending the selection. |
buffer:word_part_left () | Moves the caret to the previous change in capitalization or underscore. |
buffer:word_part_left_extend () | Moves the caret to the previous change in capitalization or underscore, extending the selection. |
buffer:word_part_right () | Moves the caret to the next change in capitalization or underscore. |
buffer:word_part_right_extend () | Moves the caret to the next change in capitalization or underscore, extending the selection. |
buffer:word_right () | Moves the caret right one word. |
buffer:word_right_end () | Moves the caret right one word, positioning the caret at the end of the word. |
buffer:word_right_end_extend () | Moves the caret right one word, positioning the caret at the end of the word, extending the selection. |
buffer:word_right_extend () | Moves the caret right one word, extending the selection. |
buffer:word_start_position (pos, only_word_chars) | Returns the position of a start of a word. |
buffer:wrap_count (line) | Returns the number of display lines needed to wrap a document line. |
buffer:zoom_in () | Magnifies the displayed text by increasing the font sizes by 1 point. |
buffer:zoom_out () | Makes the displayed text smaller by decreasing the font sizes by 1 point. |
Functions
- buffer:add_text (text)
-
Adds text to the document at the current position.
Parameters
- text:
- buffer:allocate (bytes)
-
Enlarges the document to a particular size of text bytes
Parameters
- bytes:
- buffer:append_text (text)
-
Appends a string to the end of the document without changing the selection.
Parameters
- text:
- buffer:auto_c_active ()
- Returns a flag indicating whether or not an autocompletion list is visible.
- buffer:auto_c_cancel ()
- Removes the autocompletion list from the screen.
- buffer:auto_c_complete ()
- Item selected; removes the list and insert the selection.
- buffer:auto_c_get_current ()
- Returns the currently selected item position in the autocompletion list.
- buffer:auto_c_pos_start ()
- Returns the position of the caret when the autocompletion list was shown.
- buffer:auto_c_select (string)
-
Selects the item in the autocompletion list that starts with a string.
Parameters
- string:
- buffer:auto_c_show (len_entered, item_list)
-
Displays an autocompletion list.
Parameters
- len_entered: The number of characters before the caret used to provide the context.
- item_list: String if completion items separated by spaces.
- buffer:auto_c_stops (chars)
-
Defines a set of characters that why typed cancel the autocompletion list.
Parameters
- chars:
- buffer:back_tab ()
- Dedents selected lines.
- buffer:begin_undo_action ()
- Starts a sequence of actions that are undone/redone as a unit.
- buffer:brace_bad_light (pos)
-
Highlights the character at a position indicating there's no matching brace.
Parameters
- pos:
- buffer:brace_highlight (pos1, pos2)
-
Highlights the characters at two positions as matching braces.
Parameters
- pos1:
- pos2:
- buffer:brace_match (pos)
-
Returns the position of a matching brace at a position or -1.
Parameters
- pos:
- buffer:call_tip_active ()
- Returns a flag indicating whether or not a call tip is active.
- buffer:call_tip_cancel ()
- Removes the call tip from the screen.
- buffer:call_tip_pos_start ()
- Returns the position where the caret was before showing the call tip.
- buffer:call_tip_set_hlt (start_pos, end_pos)
-
Highlights a segment of a call tip.
Parameters
- start_pos:
- end_pos:
- buffer:call_tip_show (pos, text)
-
Shows a call tip containing text at or near a position.
Parameters
- pos:
- text:
- buffer:can_paste ()
- Returns a flag indicating whether or not a paste will succeed.
- buffer:can_redo ()
- Returns a flag indicating whether or not there are redoable actions in the undo history.
- buffer:can_undo ()
- Returns a flag indicating whether or not there are redoable actions in the undo history.
- buffer:cancel ()
- Cancels any modes such as call tip or autocompletion list display.
- buffer:char_left ()
- Moves the caret left one character.
- buffer:char_left_extend ()
- Moves the caret left one character, extending the selection.
- buffer:char_left_rect_extend ()
- Moves the caret left one character, extending the rectangular selection.
- buffer:char_right ()
- Moves the caret right one character.
- buffer:char_right_extend ()
- Moves the caret right one character, extending the selection.
- buffer:char_right_rect_extend ()
- Moves the caret right one character, extending the rectangular selection.
- buffer:choose_caret_x ()
- Sets the last x chosen value to be the caret x position.
- buffer:clear ()
- Clears the selection.
- buffer:clear_all ()
- Deletes all text in the document.
- buffer:clear_all_cmd_keys ()
- Drops all key mappings.
- buffer:clear_document_style ()
- Sets all style bytes to 0, remove all folding information.
- buffer:clear_registered_images ()
- Clears all the registered XPM images.
- buffer:close ()
-
See also:
- buffer:colourise (start_pos, end_pos)
-
Colorizes a segment of the document using the current lexing language.
Parameters
- start_pos:
- end_pos:
- buffer:convert_eo_ls (mode)
-
Converts all line endings in the document to one mode.
Parameters
- mode: The line ending mode. 0: CRLF, 1: CR, 2: LF.
- buffer:copy ()
- Copies the selection to the clipboard.
- buffer:copy_range (start_pos, end_pos)
-
Copies a range of text to the clipboard.
Parameters
- start_pos:
- end_pos:
- buffer:copy_text (text)
-
Copies argument text to the clipboard.
Parameters
- text:
- buffer:cut ()
- Cuts the selection to the clipboard.
- buffer:del_line_left ()
- Deletes back from the current position to the start of the line.
- buffer:del_line_right ()
- Deletes forwards from the current position to the end of the line.
- buffer:del_word_left ()
- Deletes the word to the left of the caret.
- buffer:del_word_right ()
- Deletes the word to the right of the caret.
- buffer:delete ()
- Deletes the current buffer. The indexed buffer must be the currently focused one. WARNING: this function should NOT be called via scripts. textadept.io provides a close() function for buffers to prompt for confirmation if necessary; this function does not. Activates the 'buffer_deleted' signal.
- buffer:delete_back ()
- Deletes the selection or the character before the caret.
- buffer:delete_back_not_line ()
- Deletes the selection or the character before the caret. Will not delete the character before at the start of a lone.
- buffer:doc_line_from_visible ()
- Returns the document line of a display line taking hidden lines into account.
- buffer:document_end ()
- Moves the caret to the last position in the document.
- buffer:document_end_extend ()
- Moves the caret to the last position in the document, extending the selection.
- buffer:document_start ()
- Moves the caret to the first position in the document.
- buffer:document_start_extend ()
- Moves the caret to the first position in the document, extending the selection.
- buffer:edit_toggle_overtype ()
- Switches from insert to overtype mode or the reverse.
- buffer:empty_undo_buffer ()
- Deletes the undo history.
- buffer:encoded_from_utf8 (string)
-
Translates a UTF8 string into the document encoding and returns its length.
Parameters
- string:
- buffer:end_undo_action ()
- Ends a sequence of actions that is undone/redone as a unit.
- buffer:ensure_visible (line)
-
Ensures a particular line is visible by expanding any header line hiding it.
Parameters
- line:
- buffer:ensure_visible_enforce_policy (line)
-
Ensures a particular line is visible by expanding any header line hiding it. Uses the currently set visible policy to determine which range to display.
Parameters
- line:
- buffer:find_column (line, column)
-
Returns the position of the column on a line taking into account tabs and multi-byte characters or the line end position.
Parameters
- line:
- column:
- buffer:form_feed ()
- Inserts a form feed character.
- buffer:get_cur_line ()
- Returns the text of the line containing the caret and the index of the caret on the line.
- buffer:get_hotspot_active_back ()
- Returns the background color for active hotspots.
- buffer:get_hotspot_active_fore ()
- Returns the foreground color for active hotspots.
- buffer:get_last_child (header_line, level)
-
Returns the last child line of a header line.
Parameters
- header_line:
- level:
- buffer:get_lexer_language ()
- Returns the name of the lexing language used by the document.
- buffer:get_line (line)
-
Returns the contents of a line.
Parameters
- line:
- buffer:get_line_sel_end_position (line)
-
Returns the position of the end of the selection at the given line or -1.
Parameters
- line:
- buffer:get_line_sel_start_position (line)
-
Returns the position of the start of the selection at the given line or -1.
Parameters
- line:
- buffer:get_property (property)
-
Returns the value of a property.
Parameters
- property:
- buffer:get_property_expanded ()
- Returns the value of a property with "$()" variable replacement.
- buffer:get_sel_text ()
- Returns the selected text.
- buffer:get_style_name (style_num)
-
Returns the name of the style associated with a style number.
Parameters
- style_num:
- buffer:get_text ()
- Returns all text in the document and its length.
- buffer:goto_line (line)
-
Sets the caret to the start of a line and ensure it is visible.
Parameters
- line:
- buffer:goto_pos (pos)
-
Sets the caret to a position and ensure it is visible.
Parameters
- pos:
- buffer:grab_focus ()
- Sets the focus to this Scintilla widget.
- buffer:hide_lines (start_line, end_line)
-
Makes a range of lines invisible.
Parameters
- start_line:
- end_line:
- buffer:hide_selection (normal)
-
Draws the selection in normal style or with the selection highlighted.
Parameters
- normal:
- buffer:home ()
- Moves the caret to the first position on the current line.
- buffer:home_display ()
- Moves the caret to the first position on the display line.
- buffer:home_display_extend ()
- Moves the caret to the first position on the display line, extending the selection.
- buffer:home_extend ()
- Moves the caret to the first position on the current line, extending the selection.
- buffer:home_rect_extend ()
- Moves the caret to the first position on the current line, extending the rectangular selection.
- buffer:home_wrap ()
- Moves the caret to the start of the current display line and then the document line. (If word wrap is enabled)
- buffer:home_wrap_extend ()
- Moves the caret to the start of the current display line and then the document line, extending the selection. (If word wrap is enabled)
- buffer:indicator_all_on_for (pos)
-
Returns a flag indicating whether or not any indicators are present at the specified position.
Parameters
- pos:
- buffer:indicator_clear_range (pos, clear_length)
-
Turns an indicator off over a range.
Parameters
- pos:
- clear_length:
- buffer:indicator_end (indicator, pos)
-
Returns the position where a particular indicator ends.
Parameters
- indicator:
- pos:
- buffer:indicator_fill_range (pos, fill_length)
-
Turns an indicator on over a range.
Parameters
- pos:
- fill_length:
- buffer:indicator_start (indicator, pos)
-
Returns the position where a particular indicator starts.
Parameters
- indicator:
- pos:
- buffer:indicator_value_at (indicator, pos)
-
Returns the value of a particular indicator at the specified position.
Parameters
- indicator:
- pos:
- buffer:insert_text (pos, text)
-
Inserts text at a position. -1 is the document's length.
Parameters
- pos:
- text:
- buffer:line_copy ()
- Copies the line containing the caret.
- buffer:line_cut ()
- Cuts the line containing the caret.
- buffer:line_delete ()
- Deletes the line containing the caret.
- buffer:line_down ()
- Moves the caret down one line.
- buffer:line_down_extend ()
- Moves the caret down one line, extending the selection.
- buffer:line_down_rect_extend ()
- Moves the caret down one line, extending the rectangular selection.
- buffer:line_duplicate ()
- Duplicates the current line.
- buffer:line_end ()
- Moves the caret to the last position on the current line.
- buffer:line_end_display ()
- Moves the caret to the last position on the display line.
- buffer:line_end_display_extend ()
- Moves the caret to the last position on the display line, extending the selection.
- buffer:line_end_extend ()
- Moves the caret to the last position on the current line, extending the selection.
- buffer:line_end_rect_extend ()
- Moves the caret to the last position on the current line, extending the rectangular selection.
- buffer:line_end_wrap ()
- Moves the caret to the last position on the current display line and then the document line. (If wrap mode is enabled)
- buffer:line_end_wrap_extend ()
- Moves the caret to the last position on the current display line and then the document line, extending the selection. (If wrap mode is enabled)
- buffer:line_from_position (pos)
-
Returns the line containing the position.
Parameters
- pos:
- buffer:line_length (line)
-
Returns the length of the specified line including EOL characters.
Parameters
- line:
- buffer:line_scroll (columns, lines)
-
Scrolls horizontally and vertically the number of columns and lines.
Parameters
- columns:
- lines:
- buffer:line_scroll_down ()
- Scrolls the document down, keeping the caret visible.
- buffer:line_scroll_up ()
- Scrolls the document up, keeping the caret visible.
- buffer:line_transpose ()
- Switches the current line with the previous.
- buffer:line_up ()
- Moves the caret up one line.
- buffer:line_up_extend ()
- Moves the caret up one line, extending the selection.
- buffer:line_up_rect_extend ()
- Moves the caret up one line, extending the rectangular selection.
- buffer:lines_join ()
- Joins the lines in the target.
- buffer:lines_split (pixel_width)
-
Splits lines in the target into lines that are less wide that pixel_width where possible.
Parameters
- pixel_width:
- buffer:load_lexer_library (path)
-
Loads a lexer library (dll/so)
Parameters
- path:
- buffer:lower_case ()
- Transforms the selection to lower case.
- buffer:marker_add (line, marker_num)
-
Adds a marker to a line, returning an ID which can be used to find or delete the marker.
Parameters
- line:
- marker_num:
- buffer:marker_add_set (line, set)
-
Adds a set of markers to a line.
Parameters
- line:
- set:
- buffer:marker_define (marker_num, marker_symbol)
-
Sets the symbol used for a particular marker number.
Parameters
- marker_num:
- marker_symbol:
- buffer:marker_define_pixmap (marker_num, pixmap)
-
Defines a marker from a pixmap.
Parameters
- marker_num:
- pixmap:
- buffer:marker_delete (line, marker_num)
-
Deletes a marker from a line.
Parameters
- line:
- marker_num:
- buffer:marker_delete_all (marker_num)
-
Deletes all markers with a particular number from all lines.
Parameters
- marker_num:
- buffer:marker_delete_handle (handle)
-
Deletes a marker.
Parameters
- handle:
- buffer:marker_get (line)
-
Gets a bit mask of all the markers set on a line.
Parameters
- line:
- buffer:marker_line_from_handle (handle)
-
Returns the line number at which a particular marker is located.
Parameters
- handle:
- buffer:marker_next (start_line, marker_mask)
-
Finds the next line after start_line that includes a marker in marker_mask.
Parameters
- start_line:
- marker_mask:
- buffer:marker_previous (start_line, marker_mask)
-
Finds the previous line after start_line that includes a marker in marker_mask.
Parameters
- start_line:
- marker_mask:
- buffer:marker_set_alpha (marker_num, alpha)
-
Sets the alpha used for a marker that is drawn in the text area, not the margin.
Parameters
- marker_num:
- alpha:
- buffer:marker_set_back (marker_num, color)
-
Sets the background color used for a particular marker number.
Parameters
- marker_num:
- color:
- buffer:marker_set_fore (marker_num, color)
-
Sets the foreground color used for a particular marker number.
Parameters
- marker_num:
- color:
- buffer:move_caret_inside_view ()
- Moves the caret inside the current view if it's not there already.
- buffer:new_line ()
- Inserts a new line depending on EOL mode.
- buffer:null ()
- Null operation
- buffer:page_down ()
- Moves the caret one page down.
- buffer:page_down_extend ()
- Moves the caret one page down, extending the selection.
- buffer:page_down_rect_extend ()
- Moves the caret one page down, extending the rectangular selection.
- buffer:page_up ()
- Moves the caret one page up.
- buffer:page_up_extend ()
- Moves the caret one page up, extending the selection.
- buffer:page_up_rect_extend ()
- Moves the caret one page up, extending the rectangular selection.
- buffer:para_down ()
- Moves the caret one paragraph down (delimited by empty lines).
- buffer:para_down_extend ()
- Moves the caret one paragraph down (delimited by empty lines), extending the selection.
- buffer:para_up ()
- Moves the caret one paragraph up (delimited by empty lines).
- buffer:para_up_extend ()
- Moves the caret one paragraph up (delimited by empty lines), extending the selection.
- buffer:paste ()
- Pastes the contents of the clipboard into the document replacing the selection.
- buffer:point_x_from_position (pos)
-
Returns the x value of the point in the window where a position is shown.
Parameters
- pos:
- buffer:point_y_from_position (pos)
-
Returns the y value of the point in the window where a position is shown.
Parameters
- pos:
- buffer:position_after (pos)
-
Returns the next position in the document taking code page into account.
Parameters
- pos:
- buffer:position_before (pos)
-
Returns the previous position in the document taking code page into account.
Parameters
- pos:
- buffer:position_from_line (line)
-
Returns the position at the start of the specified line.
Parameters
- line:
- buffer:position_from_point (x, y)
-
Returns the position from a point within the window.
Parameters
- x:
- y:
- buffer:position_from_point_close (x, y)
-
Returns the position from a point within the window, but return -1 if not close to text.
Parameters
- x:
- y:
- buffer:redo ()
- Redoes the next action in the undo history.
- buffer:register_image (type, xmp_data)
-
Registers and XPM image for use in autocompletion lists.
Parameters
- type:
- xmp_data:
- buffer:reload ()
-
See also:
- buffer:replace_sel (text)
-
Replaces the selected text with the argument text.
Parameters
- text:
- buffer:replace_target (text)
-
Replaces the target text with the argument text.
Parameters
- text:
- buffer:replace_target_re (text)
-
Replaces the target text with the argument text after \d processing. Looks for \d where d is 1-9 and replaces it with the strings captured by a previous RE search.
Parameters
- text:
- buffer:save ()
-
See also:
- buffer:save_as ()
-
See also:
- buffer:scroll_caret ()
- Ensures the caret is visible.
- buffer:search_anchor ()
- Sets the current caret position to be the search anchor.
- buffer:search_in_target (text)
-
Searches for a string in the target and sets the target to the found range, returning the length of the range or -1.
Parameters
- text:
- buffer:search_next (flags, text)
-
Finds some text starting at the search anchor. (Does not scroll selection)
Parameters
- flags: Mask of search flags. 2: whole word, 4: match case, 0x00100000: word start, 0x00200000 regexp, 0x00400000: posix.
- text:
- buffer:search_prev (flags, text)
-
Finds some text starting at the search anchor and moving backwards. (Does not scroll the selection)
Parameters
- flags: Mask of search flags. 2: whole word, 4: match case, 0x00100000: word start, 0x00200000 regexp, 0x00400000: posix.
- text:
- buffer:select_all ()
- Selects all the text in the document.
- buffer:selection_duplicate ()
- Duplicates the selection or the line containing the caret.
- buffer:set_chars_default ()
- Resets the set of characters for whitespace and word characters to the defaults.
- buffer:set_encoding ()
-
See also:
- buffer:set_fold_flags (flags)
-
Sets some style options for folding.
Parameters
- flags: Mask of fold flags. 0x0002: line before expanded, 0x0004: line before contracted, 0x0008: line after expanded, 0x0010: line after contracted, 0x0040: level numbers, 0x0001: box.
- buffer:set_fold_margin_colour (use_setting, color)
-
Sets the background color used as a checkerboard pattern in the fold margin.
Parameters
- use_setting:
- color:
- buffer:set_fold_margin_hi_colour (use_setting, color)
-
Sets the foreground color used as a checkerboard pattern in the fold margin.
Parameters
- use_setting:
- color:
- buffer:set_hotspot_active_back (use_setting, color)
-
Sets a background color for active hotspots.
Parameters
- use_setting:
- color:
- buffer:set_hotspot_active_fore (use_setting, color)
-
Sets a foreground color for active hotspots.
Parameters
- use_setting:
- color:
- buffer:set_length_for_encode (bytes)
-
Sets the length of the utf8 argument for calling encoded_from_utf8.
Parameters
- bytes:
- buffer:set_lexer_language (language_name)
-
Sets the lexer language to the specified name.
Parameters
- language_name:
- buffer:set_save_point ()
- Remembers the current position in the undo history as the position at which the document was saved.
- buffer:set_sel (start_pos, end_pos)
-
Selects a range of text.
Parameters
- start_pos:
- end_pos:
- buffer:set_sel_back (use_setting, color)
-
Sets the background color of the selection and whether to use this setting.
Parameters
- use_setting:
- color:
- buffer:set_sel_fore (use_setting, color)
-
Sets the foreground color of the selection and whether to use this setting.
Parameters
- use_setting:
- color:
- buffer:set_styling (length, style)
-
Changes the style from the current styling position for a length of characters to a style and move the current styling position to after this newly styled segment.
Parameters
- length:
- style:
- buffer:set_styling_ex (length, styles)
-
Sets the styles for a segment of the document.
Parameters
- length:
- styles:
- buffer:set_text (text)
-
Replaces the contents of the document with the argument text.
Parameters
- text:
- buffer:set_visible_policy (visible_policy, visible_slop)
-
Sets the way the display area is determined when a particular line is to be moved to by find, find_next, goto_line, etc.
Parameters
- visible_policy: 0x01: slop, 0x04: strict.
- visible_slop: 0x01: slop, 0x04: strict.
- buffer:set_whitespace_back (use_setting, color)
-
Sets the background color of all whitespace and whether to use this setting.
Parameters
- use_setting:
- color:
- buffer:set_whitespace_fore (use_setting, color)
-
Sets the foreground color of all whitespace and whether to use this setting.
Parameters
- use_setting:
- color:
- buffer:set_x_caret_policy (caret_policy, caret_slop)
-
Sets the way the caret is kept visible when going side-ways.
Parameters
- caret_policy: 0x01: slop, 0x04: strict, 0x10: jumps, 0x08: even.
- caret_slop:
- buffer:set_y_caret_policy (caret_policy, caret_slop)
-
Sets the way the line the caret is visible on is kept visible.
Parameters
- caret_policy: 0x01: slop, 0x04: strict, 0x10: jumps, 0x08: even.
- caret_slop:
- buffer:show_lines (start_line, end_line)
-
Makes a range of lines visible.
Parameters
- start_line:
- end_line:
- buffer:start_record ()
- Starts notifying the container of all key presses and commands.
- buffer:start_styling (position, mask)
-
Sets the current styling position to pos and the styling mask to mask.
Parameters
- position:
- mask:
- buffer:stop_record ()
- Stops notifying the container of all key presses and commands.
- buffer:stuttered_page_down ()
- Moves caret to the bottom of the page, or one page down if already there.
- buffer:stuttered_page_down_extend ()
- Moves caret to the bottom of the page, or one page down if already there, extending the selection.
- buffer:stuttered_page_up ()
- Moves caret to the top of the page, or one page up if already there.
- buffer:stuttered_page_up_extend ()
- Moves caret to the top of the page, or one page up if already there, extending the selection.
- buffer:style_clear_all ()
- Resets all styles to the global default style.
- buffer:style_get_font (style_num)
-
Returns the font name of a given style.
Parameters
- style_num:
- buffer:style_reset_default ()
- Resets the default style to its state at startup.
- buffer:tab ()
- Inserts a tab character or indent multiple lines.
- buffer:target_as_utf8 ()
- Returns the target converted to utf8.
- buffer:target_from_selection ()
- Makes the target range the same as the selection range.
- buffer:text_height (line)
-
Returns the height of a particular line of text in pixels.
Parameters
- line:
- buffer:text_range (start_pos, end_pos)
-
Gets a range of text from the current buffer. The indexed buffer must be the currently focused one.
Parameters
- start_pos: The beginning position of the range of text to get.
- end_pos: The end position of the range of text to get.
- buffer:text_width (style_num, text)
-
Returns the pixel width of some text in a particular style.
Parameters
- style_num:
- text:
- buffer:toggle_caret_sticky ()
- Switches the caret between sticky and non-sticky.
- buffer:toggle_fold ()
- Switches a header line between expanded and contracted.
- buffer:undo ()
- Undoes one action in the undo history.
- buffer:upper_case ()
- Transforms the selection to upper case.
- buffer:use_pop_up (allow_popup)
-
Sets whether a pop up menu is displayed automatically when the user presses the right mouse button.
Parameters
- allow_popup:
- buffer:user_list_show (list_type, item_list_string)
-
Displays a list of strings and sends a notification when one is chosen.
Parameters
- list_type:
- item_list_string:
- buffer:vc_home ()
- Moves the caret to before the first visible character on the current line or the first character on the line if already there.
- buffer:vc_home_extend ()
- Moves the caret to before the first visible character on the current line or the first character on the line if already there, extending the selection.
- buffer:vc_home_rect_extend ()
- Moves the caret to before the first visible character on the current line or the first character on the line if already there, extending the rectangular selection.
- buffer:vc_home_wrap ()
- Moves the caret to the first visible character on the current display line and then the document line. (If wrap mode is enabled)
- buffer:vc_home_wrap_extend ()
- Moves the caret to the first visible character on the current display line and then the document line, extending the selection. (If wrap mode is enabled)
- buffer:visible_from_doc_line (line)
-
Returns the display line of a document line taking hidden lines into account.
Parameters
- line:
- buffer:word_end_position (pos, only_word_chars)
-
Returns the position of the end of a word.
Parameters
- pos:
- only_word_chars:
- buffer:word_left ()
- Moves the caret left one word.
- buffer:word_left_end ()
- Moves the caret left one word, positioning the caret at the end of the word.
- buffer:word_left_end_extend ()
- Moves the caret left one word, positioning the caret at the end of the word, extending the selection.
- buffer:word_left_extend ()
- Moves the caret left one word, extending the selection.
- buffer:word_part_left ()
- Moves the caret to the previous change in capitalization or underscore.
- buffer:word_part_left_extend ()
- Moves the caret to the previous change in capitalization or underscore, extending the selection.
- buffer:word_part_right ()
- Moves the caret to the next change in capitalization or underscore.
- buffer:word_part_right_extend ()
- Moves the caret to the next change in capitalization or underscore, extending the selection.
- buffer:word_right ()
- Moves the caret right one word.
- buffer:word_right_end ()
- Moves the caret right one word, positioning the caret at the end of the word.
- buffer:word_right_end_extend ()
- Moves the caret right one word, positioning the caret at the end of the word, extending the selection.
- buffer:word_right_extend ()
- Moves the caret right one word, extending the selection.
- buffer:word_start_position (pos, only_word_chars)
-
Returns the position of a start of a word.
Parameters
- pos:
- only_word_chars:
- buffer:wrap_count (line)
-
Returns the number of display lines needed to wrap a document line.
Parameters
- line:
- buffer:zoom_in ()
- Magnifies the displayed text by increasing the font sizes by 1 point.
- buffer:zoom_out ()
- Makes the displayed text smaller by decreasing the font sizes by 1 point.