Sublime Text 3 API參考

分類點，返回這些標(biāo)志中的零個或多個的按位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

向視圖中添加一組區(qū)域。 如果給定鍵已存在一組區(qū)域，它們將被覆蓋。 范圍用于提供顏色來繪制區(qū)域，應(yīng)該是范圍的名稱，例如＆quot; comment＆quot; 或“string”。 如果 scope 為空，則不會繪制 regions 。

可選的圖標(biāo)名稱（如果給出）將在每個區(qū)域旁邊的水槽中繪制命名的圖標(biāo)。 圖標(biāo)將使用與范圍相關(guān)聯(lián)的顏色進(jìn)行著色。 有效的圖標(biāo)名稱為 dot ，圓形，書簽和交叉。 圖標(biāo)名稱也可以是完整包相對路徑，例如 Packages/Theme-Default/dot.png 。

可選的 flags 參數(shù)是以下各項的按位組合：

• sublime.DRAW EMPTY ：使用豎線繪制空白區(qū)域。 默認(rèn)情況下，它們不會繪制。
• sublime.HIDE_ON_MINIMAP:不要在小地圖上顯示區(qū)域。
• sublime.DRAW_EMPTY_AS_OVERWRITE: 使用水平條而不是垂直條繪制空白區(qū)域。
• sublime.DRAW_NO_FILL:禁用填充區(qū)域，只留下輪廓。
• sublime.DRAW_NO_OUTLINE:禁用繪制區(qū)域的輪廓。
• sublime.DRAW_SOLID_UNDERLINE: 在區(qū)域下面繪制一個實線下劃線。
• sublime.DRAW_STIPPLED_UNDERLINE: 在區(qū)域下方繪制點狀下劃線。
• sublime.DRAW_SQUIGGLY_UNDERLINE: 以下地區(qū)波浪下劃線。
• sublime.PERSISTENT: 在會話中保存區(qū)域。
• sublime.HIDDEN: 不要繪制區(qū)域。

下劃線樣式是獨占的，應(yīng)該給出零個或一個。 如果使用下劃線，則通常應(yīng)傳入 sublime.DRAW_NO_FILL 和 sublime.DRAW_NO_OUTLINE 。

返回存儲在undo/redo堆棧中的給定歷史記錄條目的命令名稱，命令參數(shù)和重復(fù)計數(shù)。

索引 0 對應(yīng)于最近的命令， -1 之前的命令，等等。 索引的正值表示在重做堆棧中查找命令。 如果撤消/重做歷史記錄不足夠延伸，則將返回（None，None，0）。

將 modifying_only 設(shè)置為 True （默認(rèn)值為 False ）將只返回修改緩沖區(qū)的條目。

在插入符處顯示彈出式菜單，以選擇列表中的項目。 on_done 將使用所選項目的索引調(diào)用一次。 如果彈出式菜單已取消，將使用參數(shù) -1 調(diào)用 on_done 。

items is a list of strings.

flags it currently unused.

顯示顯示HTML內(nèi)容的彈出窗口。

標(biāo)志是以下各項的按位組合：

• sublime.COOPERATE_WITH_AUTO_COMPLETE. 導(dǎo)致彈出式窗口顯示在自動完成菜單旁邊
• sublime.HIDE_ON_MOUSE_MOVE. 當(dāng)鼠標(biāo)移動，點擊或滾動時，導(dǎo)致彈出窗口隱藏
• sublime.HIDE_ON_MOUSE_MOVE_AWAY.當(dāng)鼠標(biāo)移動（除非朝向彈出窗口），或單擊或滾動時，導(dǎo)致彈出窗口隱藏

-1 的默認(rèn)位置將在光標(biāo)處顯示彈出窗口，否則應(yīng)傳遞文本點。

最大寬度和最大高度設(shè)置彈出窗口的最大尺寸，之后將顯示滾動條。

on_navigate 是一個回調(diào)，應(yīng)該接受用戶點擊的鏈接上的 href 屬性的字符串內(nèi)容。

on_hide 在隱藏彈出式窗口時調(diào)用。

創(chuàng)建附加到區(qū)域的幻像</ tt>。 內(nèi)容</ 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
  )