| Methods | Return Value | Description |
|---|
| set_timeout(callback, delay) | None | Calls the given callback after the given delay (in milliseconds). Callbacks with an equal delay will be run in the order they were added. It is safe to call setTimeout from multiple threads. |
| status_message(string) | None | Sets the message that appears in the status bar. |
| error_message(string) | None | Displays an error dialog to the user. |
| message_dialog(string) | None | Displays a message dialog to the user. |
| ok_cancel_dialog(string, <ok_button>) | bool | Displays an ok / cancel question dialog to the user. If ok_button is provided, this may be used as the text on the ok button. Returns True if the user presses the ok button. |
| load_settings(base_name) | Settings | Loads the named settings. The name should include a file name and extension, but not a path. The packages will be searched for files matching the base name, and the results will be collated into the settings object. Subsequent calls to load_settings with the name base_name will return the same object, and not load the settings from disk again. |
| save_settings(base_name) | None | Flushes any in-memory changes to the named settings object to disk. |
| windows() | [Window] | Returns a list of all the open windows. |
| active_window() | Window | Returns the most recently used window. |
| packages_path() | String | Returns the base path to the packages. |
| installed_packages_path() | String | Returns the path where all the user's *.sublime-package files are. |
| get_clipboard() | String | Returns the contents of the clipboard. |
| set_clipboard(string) | None | Sets the contents of the clipboard. |
| score_selector(scope, selector) | Int | Matches the selector against the given scope, returning a score. A score of 0 means no match, above 0 means a match. Different selectors may be compared against the same scope: a higher score means the selector is a better match for the scope. |
| run_command(string, <args>) | None | Runs the named ApplicationCommand with the (optional) given arguments. |
| log_commands(flag) | None | Controls command logging. If enabled, all commands run from key bindings and the menu will be logged to the console. |
| log_input(flag) | None | Controls input logging. If enabled, all key presses will be logged to the console. |
| version() | String | Returns the version number |
| platform() | String | Returns the platform, which may be "osx", "linux" or "windows" |
| arch() | String | Returns the CPU architecture, which may be "x32" or "x64" |
| Methods | Return Value | Description |
|---|
| id() | int | Returns a number that uniquely identifies this view. |
| buffer_id() | int | Returns a number that uniquely identifies the buffer underlying this view. |
| file_name() | String | The full name file the file associated with the buffer, or None if it doesn't exist on disk. |
| name() | String | The name assigned to the buffer, if any |
| set_name(name) | None | Assigns a name to the buffer |
| is_loading() | bool | Returns true if the buffer is still loading from disk, and not ready for use. |
| is_dirty() | bool | Returns true if there are any unsaved modifications to the buffer. |
| is_read_only() | bool | Returns true if the buffer may not be modified. |
| set_read_only(value) | None | Sets the read only property on the buffer. |
| is_scratch() | bool | Returns true if the buffer is a scratch buffer. Scratch buffers never report as being dirty. |
| set_scratch(value) | None | Sets the scratch property on the buffer. |
| settings() | Settings | Returns a reference to the views settings object. Any changes to this settings object will be private to this view. |
| window() | Window | Returns a reference to the window containing the view. |
| run_command(string, <args>) | None | Runs the named TextCommand with the (optional) given arguments. |
| size() | int | Returns the number of character in the file. |
| substr(region) | String | Returns the contents of the region as a string. |
| substr(point) | String | Returns the character to the right of the point. |
| begin_edit(<command>, <args>) | Edit | Creates an edit object, demarcating an undo group. A corresponding call to end_edit() is required. |
| end_edit(edit) | Edit | Finishes the edit. |
| insert(edit, point, string) | int | Inserts the given string in the buffer at the specified point. Returns the number of characters inserted: this may be different if tabs are being translated into spaces in the current buffer. |
| erase(edit, region) | None | Erases the contents of the region from the buffer. |
| replace(edit, region, string) | None | Replaces the contents of the region with the given string. |
| sel() | RegionSet | Returns a reference to the selection. |
| line(point) | Region | Returns the line that contains the point. |
| line(region) | Region | Returns a modified copy of region such that it starts at the beginning of a line, and ends at the end of a line. Note that it may span several lines. |
| full_line(point) | Region | As line(), but the region includes the trailing newline character, if any. |
| full_line(region) | Region | As line(), but the region includes the trailing newline character, if any. |
| lines(region) | [Region] | Returns a list of lines (in sorted order) intersecting the region. |
| split_by_newlines(region) | [Region] | Splits the region up such that each region returned exists on exactly one line. |
| word(point) | Region | Returns the word that contains the point. |
| word(region) | Region | Returns a modified copy of region such that it starts at the beginning of a word, and ends at the end of a word. Note that it may span several words. |
| find(pattern, fromPosition, <flags>) | Region | Returns the first Region matching the regex pattern, starting from the given point, or None if it can't be found. The optional flags parameter may be sublime.LITERAL, sublime.IGNORECASE, or the two ORed together. |
| find_all(pattern, <flags>, <format>, <extractions>) | [Region] | Returns all (non-overlapping) regions matching the regex pattern. The optional flags parameter may be sublime.LITERAL, sublime.IGNORECASE, or the two ORed together. If a format string is given, then all matches will be formatted with the formatted string and placed into the extractions list. |
| rowcol(point) | (int, int) | Calculates the 0 based line and column numbers of the point. |
| text_point(row, col) | int | Calculates the character offset of the given, 0 based, row and column. Note that 'col' is interpreted as the number of characters to advance past the beginning of the row. |
| set_syntax_file(syntax_file) | None | Changes the syntax used by the view. syntax_file should be a name along the lines of Packages/Python/Python.tmLanguage. To retrieve the current syntax, use view.settings().get('syntax'). |
| extract_scope(point) | Region | Returns the extent of the syntax name assigned to the character at the given point. |
| scope_name(point) | String | Returns the syntax name assigned to the character at the given point. |
| score_selector(point, selector) | Int | Matches the selector against the scope at the given location, returning a score. A score of 0 means no match, above 0 means a match. Different selectors may be compared against the same scope: a higher score means the selector is a better match for the scope. |
| find_by_selector(selector) | [Regions] | Finds all regions in the file matching the given selector, returning them as a list. |
| show(point, <show_surrounds>) | None | Scroll the view to show the given point. |
| show(region, <show_surrounds>) | None | Scroll the view to show the given region. |
| show(region_set, <show_surrounds>) | None | Scroll the view to show the given region set. |
| show_at_center(point) | None | Scroll the view to center on the point. |
| show_at_center(region) | None | Scroll the view to center on the region. |
| visible_region() | Region | Returns the currently visible area of the view. |
| viewport_position() | Vector | Returns the offset of the viewport in layout coordinates. |
| set_viewport_position(vector, <animate<) | None | Scrolls the viewport to the given layout position. |
| viewport_extent() | vector | Returns the width and height of the viewport. |
| layout_extent() | vector | Returns the width and height of the layout. |
| text_to_layout(point) | vector | Converts a text position to a layout position |
| layout_to_text(vector) | point | Converts a layout position to a text position |
| line_height() | real | Returns the light height used in the layout |
| em_width() | real | Returns the typical character width used in the layout |
| add_regions(key, [regions], scope, <icon>, <flags>) | None | Add a set of regions to the view. If a set of regions already exists with the given key, they will be overwritten. The scope is used to source a color to draw the regions in, it should be the name of a scope, such as "comment" or "string". If the scope is empty, the regions won't be drawn.
The optional icon name, if given, will draw the named icons in the gutter next to each region. The icon will be tinted using the color associated with the scope. Valid icon names are dot, circle, bookmark and cross.
The optional flags parameter is a bitwise combination of:
- sublime.DRAW_EMPTY. Draw empty regions with a vertical bar. By default, they aren't drawn at all.
- sublime.HIDE_ON_MINIMAP. Don't show the regions on the minimap.
- sublime.DRAW_EMPTY_AS_OVERWRITE. Draw empty regions with a horizontal bar instead of a vertical one.
- sublime.DRAW_OUTLINED. Draw regions as an outline, rather than filled in.
- sublime.PERSISTENT. Save the regions in the session.
- sublime.HIDDEN. Don't draw the regions.
|
| get_regions(key) | [regions] | Return the regions associated with the given key, if any |
| erase_regions(key) | None | Removed the named regions |
| set_status(key, value) | None | Adds the status key to the view. The value will be displayed in the status bar, in a comma separated list of all status values, ordered by key. Setting the value to the empty string will clear the status. |
| get_status(key) | String | Returns the previously assigned value associated with the key, if any. |
| erase_status(key) | None | Clears the named status. |
| command_history(index, <modifying_only>) | (String,Dict,int) | Returns the command name, command arguments, and repeat count for the given history entry, as stored in the undo / redo stack.
Index 0 corresponds to the most recent command, -1 the command before that, and so on. Positive values for index indicate to look in the redo stack for commands. If the undo / redo history doesn't extend far enough, then (None, None, 0) will be returned.
Setting modifying_only to True (the default is False) will only return entries that modified the buffer. |
| fold([regions]) | bool | Folds the given regions, returning False if they were already folded |
| fold(region) | bool | Folds the given region, returning False if it was already folded |
| unfold(region) | [regions] | Unfolds all text in the region, returning the unfolded regions |
| unfold([regions]) | [regions] | Unfolds all text in the regions, returning the unfolded regions |
| encoding() | String | Returns the encoding currently associated with the file |
| set_encoding(encoding) | None | Applies a new encoding to the file. This encoding will be used the next time the file is saved. |
| line_endings() | String | Returns the line endings used by the current file. |
| set_line_endings(line_endings) | None | Sets the line endings that will be applied when next saving. |
They can be created by view.begin_edit(). Every call to view.begin_edit() must have a corresponding call to view.end_edit(), typically wrapped in a try ... finally block.
| Methods | Return Value | Description |
|---|
| id() | int | Returns a number that uniquely identifies this window. |
| new_file() | View | Creates a new file. The returned view will be empty, and its is_loaded method will return True. |
| open_file(file_name, <flags>) | View | Opens the named file, and returns the corresponding view. If the file is already opened, it will be brought to the front. Note that as file loading is asynchronous, operations on the returned view won't be possible until its is_loading() method returns False.
The optional flags parameter is a bitwise combination of:
- sublime.ENCODED_POSITION. Indicates the file_name should be searched for a :row or :row:col suffix
- sublime.TRANSIENT. Open the file as a preview only: it won't have a tab assigned it until modified
|
| active_view() | View | Returns the currently edited view. |
| active_view_in_group(group) | View | Returns the currently edited view in the given group. |
| views() | [View] | Returns all open views in the window. |
| views_in_group(group) | [View] | Returns all open views in the given group. |
| num_groups() | int | Returns the number of view groups in the window. |
| active_group() | int | Returns the index of the currently selected group. |
| focus_group(group) | None | Makes the given group active. |
| focus_view(view) | None | Switches to the given view. |
| get_view_index(view) | (group, index) | Returns the group, and index within the group of the view. Returns -1 if not found. |
| set_view_index(view, group, index) | None | Moves the view to the given group and index. |
| folders() | [String] | Returns a list of the currently open folders. |
| run_command(string, <args>) | None | Runs the named WindowCommand with the (optional) given arguments. |
| show_quick_panel(items, on_done, <flags>) | None | Shows a quick panel, to select an item in a list. on_done will be called once, with the index of the selected item. If the quick panel was cancelled, on_done will be called with an argument of -1.
Items may be an array of strings, or an array of string arrays. In the latter case, each entry in the quick panel will show multiple rows.
Flags currently only has one option, sublime.MONOSPACE_FONT |
| show_input_panel(caption, initial_text, on_done, on_change, on_cancel) | View | Shows the input panel, to collect a line of input from the user. on_done and on_change, if not None, should both be functions that expect a single string argument. on_cancel should be a function that expects no arguments. The view used for the input widget is returned. |
| get_output_panel(name) | View | Returns the view associated with the named output panel, created it if required. The output panel can be shown by running the show_panel window command, with the panel argument set to the name with an "output." prefix.
|