Sublime Text 3 API参考

分类点，返回这些标志中的零个或多个的按位OR：

• sublime.CLASS_WORD_START
• sublime.CLASS_WORD_END
• sublime.CLASS_PUNCTUATION_START
• sublime.CLASS_PUNCTUATION_END
• sublime.CLASS_SUB_WORD_START
• sublime.CLASS_SUB_WORD_END
• sublime.CLASS_LINE_START
• sublime.CLASS_LINE_END
• sublime.CLASS_EMPTY_LINE

向视图中添加一组区域。 如果给定键已存在一组区域，它们将被覆盖。 范围用于提供颜色来绘制区域，应该是范围的名称，例如＆quot; comment＆quot; 或“string”。 如果 scope 为空，则不会绘制 regions 。

可选的图标名称（如果给出）将在每个区域旁边的水槽中绘制命名的图标。 图标将使用与范围相关联的颜色进行着色。 有效的图标名称为 dot ，圆形，书签和交叉。 图标名称也可以是完整包相对路径，例如 Packages/Theme-Default/dot.png 。

可选的 flags 参数是以下各项的按位组合：

• sublime.DRAW EMPTY ：使用竖线绘制空白区域。 默认情况下，它们不会绘制。
• sublime.HIDE_ON_MINIMAP:不要在小地图上显示区域。
• sublime.DRAW_EMPTY_AS_OVERWRITE: 使用水平条而不是垂直条绘制空白区域。
• sublime.DRAW_NO_FILL:禁用填充区域，只留下轮廓。
• sublime.DRAW_NO_OUTLINE:禁用绘制区域的轮廓。
• sublime.DRAW_SOLID_UNDERLINE: 在区域下面绘制一个实线下划线。
• sublime.DRAW_STIPPLED_UNDERLINE: 在区域下方绘制点状下划线。
• sublime.DRAW_SQUIGGLY_UNDERLINE: 以下地区波浪下划线。
• sublime.PERSISTENT: 在会话中保存区域。
• sublime.HIDDEN: 不要绘制区域。

下划线样式是独占的，应该给出零个或一个。 如果使用下划线，则通常应传入 sublime.DRAW_NO_FILL 和 sublime.DRAW_NO_OUTLINE 。

返回存储在undo/redo堆栈中的给定历史记录条目的命令名称，命令参数和重复计数。

索引 0 对应于最近的命令， -1 之前的命令，等等。 索引的正值表示在重做堆栈中查找命令。 如果撤消/重做历史记录不足够延伸，则将返回（None，None，0）。

将 modifying_only 设置为 True （默认值为 False ）将只返回修改缓冲区的条目。

在插入符处显示弹出式菜单，以选择列表中的项目。 on_done 将使用所选项目的索引调用一次。 如果弹出式菜单已取消，将使用参数 -1 调用 on_done 。

items is a list of strings.

flags it currently unused.

显示显示HTML内容的弹出窗口。

标志是以下各项的按位组合：

• sublime.COOPERATE_WITH_AUTO_COMPLETE. 导致弹出式窗口显示在自动完成菜单旁边
• sublime.HIDE_ON_MOUSE_MOVE. 当鼠标移动，点击或滚动时，导致弹出窗口隐藏
• sublime.HIDE_ON_MOUSE_MOVE_AWAY.当鼠标移动（除非朝向弹出窗口），或单击或滚动时，导致弹出窗口隐藏

-1 的默认位置将在光标处显示弹出窗口，否则应传递文本点。

最大宽度和最大高度设置弹出窗口的最大尺寸，之后将显示滚动条。

on_navigate 是一个回调，应该接受用户点击的链接上的 href 属性的字符串内容。

on_hide 在隐藏弹出式窗口时调用。

创建附加到区域的幻像</ tt>。 内容</ tt>是要由主html 处理的HTML。

layout must be one of:

• sublime.LAYOUT_INLINE: Display the phantom in between the region and the point following.
• sublime.LAYOUT_BELOW: Display the phantom in space below the current line, left-aligned with the region.
• sublime.LAYOUT_BLOCK: Display the phantom in space below the current line, left-aligned with the beginning of the line.

on_navigate is an optional callback that should accept a single string parameter, that is the href attribute of the link clicked.

phantoms should be a list of phantoms.

The .region attribute of each existing phantom in the set will be updated. New phantoms will be added to the view and phantoms not in phantoms list will be deleted.

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

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 a list of strings, or a list of string lists. In the latter case, each entry in the quick panel will show multiple rows.

flags is a bitwise OR of sublime.MONOSPACE_FONT and sublime.KEEP_OPEN_ON_FOCUS_LOST

on_highlighted, if given, will be called every time the highlighted item in the quick panel is changed.

Returns the view associated with the named output panel, creating 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.

The optional unlisted parameter is a boolean to control if the output panel should be listed in the panel switcher.

Returns a dictionary of strings populated with contextual keys:

packages, platform, file, file_path, file_name, file_base_name, file_extension, folder, project, project_path, project_name, project_base_name, project_extension. This dict is suitable for passing to sublime.expand_variables().

Called when the user's mouse hovers over a view for a short period.

point is the closest point in the view to the mouse location. The mouse may not actually be located adjacent based on the value of hover_zone:

• sublime.HOVER_TEXT: When the mouse is hovered over text.
• sublime.HOVER_GUTTER: When the mouse is hovered over the gutter.
• sublime.HOVER_MARGIN: When the mouse is hovered in whitespace to the right of a line.

Called when determining to trigger a key binding with the given context key. If the plugin knows how to respond to the context, it should return either True of False. If the context is unknown, it should return None.

operator is one of:

• sublime.OP_EQUAL: Is the value of the context equal to the operand?
• sublime.OP_NOT_EQUAL: Is the value of the context not equal to the operand?
• sublime.OP_REGEX_MATCH: Does the value of the context match the regex given in operand?
• sublime.OP_NOT_REGEX_MATCH: Does the value of the context not match the regex given in operand?
• sublime.OP_REGEX_CONTAINS: Does the value of the context contain a substring matching the regex given in operand?
• sublime.OP_NOT_REGEX_CONTAINS: Does the value of the context not contain a substring matching the regex given in operand?

match_all should be used if the context relates to the selections: does every selection have to match (match_all == True), or is at least one matching enough (match_all == False)?

Called whenever completions are to be presented to the user. The prefix is a unicode string of the text to complete.

locations is a list of points. Since this method is called for all completions in every view no matter the syntax, view.match_selector(point, relevant_scope) should be called to determine if the point is relevant.

The return value must be one of the following formats:

• None: no completions are provided

  return None

• A list of 2-element lists/tuples. The first element is a unicode string of the completion trigger, the second is the unicode replacement text.

  return [["me1", "method1()"], ["me2", "method2()"]]

  The trigger may contain a tab character (\t) followed by a hint to display in the right-hand side of the completion box.

  return [
      ["me1\tmethod", "method1()"],
      ["me2\tmethod", "method2()"]
  ]

  The replacement text may contain dollar-numeric fields such as a snippet does, e.g. $0, $1.

  return [
      ["fn", "def ${1:name}($2) { $0 }"],
      ["for", "for ($1; $2; $3) { $0 }"]
  ]

• A 2-element tuple with the first element being the list format documented above, and the second element being bit flags from the following list:

  • sublime.INHIBIT_WORD_COMPLETIONS: prevent Sublime Text from showing completions based on the contents of the view
  • sublime.INHIBIT_EXPLICIT_COMPLETIONS: prevent Sublime Text from showing completions based on .sublime-completions files

  return (
      [
          ["me1", "method1()"],
          ["me2", "method2()"]
      ],
      sublime.INHIBIT_WORD_COMPLETIONS | sublime.INHIBIT_EXPLICIT_COMPLETIONS
  )

Called when the user's mouse hovers over the view for a short period.

point is the closest point in the view to the mouse location. The mouse may not actually be located adjacent based on the value of hover_zone:

• sublime.HOVER_TEXT: When the mouse is hovered over text.
• sublime.HOVER_GUTTER: When the mouse is hovered over the gutter.
• sublime.HOVER_MARGIN: When the mouse is hovered in whitespace to the right of a line.

Called when determining to trigger a key binding with the given context key. If the plugin knows how to respond to the context, it should return either True of False. If the context is unknown, it should return None.

operator is one of:

• sublime.OP_EQUAL: Is the value of the context equal to the operand?
• sublime.OP_NOT_EQUAL: Is the value of the context not equal to the operand?
• sublime.OP_REGEX_MATCH: Does the value of the context match the regex given in operand?
• sublime.OP_NOT_REGEX_MATCH: Does the value of the context not match the regex given in operand?
• sublime.OP_REGEX_CONTAINS: Does the value of the context contain a substring matching the regex given in operand?
• sublime.OP_NOT_REGEX_CONTAINS: Does the value of the context not contain a substring matching the regex given in operand?

match_all should be used if the context relates to the selections: does every selection have to match (match_all == True), or is at least one matching enough (match_all == False)?

Called whenever completions are to be presented to the user. The prefix is a unicode string of the text to complete.

locations is a list of points. Since this method is called for all completions no matter the syntax, self.view.match_selector(point, relevant_scope) should be called to determine if the point is relevant.

The return value must be one of the following formats:

• None: no completions are provided

  return None

• A list of 2-element lists/tuples. The first element is a unicode string of the completion trigger, the second is the unicode replacement text.

  return [["me1", "method1()"], ["me2", "method2()"]]

  The trigger may contain a tab character (\t) followed by a hint to display in the right-hand side of the completion box.

  return [
      ["me1\tmethod", "method1()"],
      ["me2\tmethod", "method2()"]
  ]

  The replacement text may contain dollar-numeric fields such as a snippet does, e.g. $0, $1.

  return [
      ["fn", "def ${1:name}($2) { $0 }"],
      ["for", "for ($1; $2; $3) { $0 }"]
  ]

• A 2-element tuple with the first element being the list format documented above, and the second element being bit flags from the following list:

  • sublime.INHIBIT_WORD_COMPLETIONS: prevent Sublime Text from showing completions based on the contents of the view
  • sublime.INHIBIT_EXPLICIT_COMPLETIONS: prevent Sublime Text from showing completions based on .sublime-completions files

  return (
      [
          ["me1", "method1()"],
          ["me2", "method2()"]
      ],
      sublime.INHIBIT_WORD_COMPLETIONS | sublime.INHIBIT_EXPLICIT_COMPLETIONS
  )