Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 1.91 KB

File metadata and controls

76 lines (51 loc) · 1.91 KB

:mod:`sublime_lib` API Reference

A utility library for Sublime Text providing a variety of convenience features for other packages to use.

For general documentation, see the README.

Most :mod:`sublime_lib` classes and functions rely on the Sublime Text API. As a result, :mod:`sublime_lib` functionality should not be used at import time. Instead, any initialization should be performed in :func:`plugin_loaded`.

Settings dictionaries

.. autoclass:: sublime_lib.SettingsDict
.. autoclass:: sublime_lib.NamedSettingsDict

Output streams and panels

.. autoclass:: sublime_lib.ViewStream
.. autoclass:: sublime_lib.Panel
.. autoclass:: sublime_lib.OutputPanel

Resource paths

.. autoclass:: sublime_lib.ResourcePath

View utilities

.. autofunction:: sublime_lib.new_view
.. autofunction:: sublime_lib.close_view
.. autoclass:: sublime_lib.LineEnding

Window utilities

.. autofunction:: sublime_lib.new_window
.. autofunction:: sublime_lib.close_window
.. autofunction:: sublime_lib.show_selection_panel

Syntax utilities

.. autofunction:: sublime_lib.list_syntaxes
.. autofunction:: sublime_lib.get_syntax_for_scope

Activity indicator

.. autoclass:: sublime_lib.ActivityIndicator

Region manager

.. autoclass:: sublime_lib.RegionManager

Settings listeners

.. autoclass:: sublime_lib.GlobalSettingsListener
.. autoclass:: sublime_lib.ViewSettingsListener
.. autofunction:: sublime_lib.on_setting_changed

.. automodule:: sublime_lib.encodings

.. automodule:: sublime_lib.flags