sublime模塊
| 方法 |
返回值 |
描述 |
| setTimeout(callback, delay) |
none |
在給定的延時(shí)delay（毫秒為單位）之后，調(diào)用給定的回調(diào)callback。具有相同延時(shí)值的Callbacks，會(huì)根據(jù)它們被加入的順序來(lái)運(yùn)行。從多線(xiàn)程中調(diào)用setTimeout方法是安全的. |
| statusMessage(string) |
none |
設(shè)置在狀態(tài)欄上顯示的信息。 |
| errorMessage(string) |
none |
顯示給用戶(hù)一個(gè)錯(cuò)誤對(duì)話(huà)框。 |
| messageBox(string) |
none |
給用戶(hù)顯示一個(gè)消息盒子。 |
| questionBox(string) |
bool |
顯示給用戶(hù)一個(gè)yes / no消息盒子，如果用戶(hù)選擇yes則返回True. |
| options() |
Options |
返回指向應(yīng)用選項(xiàng)的參考。 |
| windows() |
[Window] |
返回所有打開(kāi)窗口的列表。 |
| activeWindow() |
Window |
返回最近使用過(guò)的窗口。 |
| runCommand(string, <args>) |
none |
使用給定的參數(shù)（參數(shù)可選）運(yùn)行已經(jīng)命名的ApplicationCommand。 |
| canRunCommand(string, <args>) |
none |
如果帶有參數(shù)（參數(shù)可選）的命令是可用的，則返回True。 |
| makeCommand(string, <args>) |
String |
從一個(gè)命令名字和參數(shù)中簡(jiǎn)歷一個(gè)命令字符串。這個(gè)字符串適合作為showCompletions()的參數(shù)使用。 |
| packagesPath() |
String |
返回包的路徑。 |
| installedPackagesPath() |
String |
返回所用用戶(hù)*.sublime-package文件的路徑。 |
| getClipboard() |
String |
返回剪切板的內(nèi)容。 |
| setClipboard(string) |
none |
設(shè)置剪切板的內(nèi)容。 |
| getMacro() |
[String] |
返回當(dāng)前宏。宏表示要運(yùn)行的命令列表。 |
| setMacro([string]) |
none |
設(shè)置當(dāng)前宏。 |
sublime.View類(lèi)
表示一個(gè)文本緩沖的一個(gè)視圖。注意到多視圖可能指向相同的緩沖，但是它們有各自獨(dú)一無(wú)二的選項(xiàng)和布局。
| 方法 |
返回值 |
描述 |
| id() |
int |
返回唯一指定此視圖的一個(gè)值。 |
| bufferId() |
int |
返回唯一指定此視圖下的緩沖的一個(gè)值。 |
| fileName() |
String |
和緩沖關(guān)聯(lián)的文件全名，如果在硬盤(pán)中不存在，則返回none. |
| name() |
String |
分配給緩沖器的名字。 |
| setName(name) |
none |
給緩沖器指派一個(gè)名字。 |
| isLoading() |
bool |
如果緩沖器還在從硬盤(pán)中加載數(shù)據(jù)或者還沒(méi)有準(zhǔn)備好使用，則返回ture. |
| isDirty() |
bool |
如果緩沖器有任何沒(méi)有保存的修改，則返回真。 |
| isReadOnly() |
bool |
如果緩沖器不能被修改，則返回真。 |
| setReadOnly(value) |
none |
設(shè)置緩沖器的只讀屬性。 |
| isScratch() |
bool |
如果緩沖器是暫存緩沖器，則返回true。暫存緩沖器不會(huì)報(bào)告為dirty。 |
| setScratch(value) |
none |
設(shè)置緩沖器的暫存屬性 |
| options() |
Options |
返回視圖文件類(lèi)型選項(xiàng)的一個(gè)引用。 |
| window() |
Window |
返回包含視圖的窗口的一個(gè)引用。 |
| runCommand(string, <args>) |
none |
使用給定的參數(shù)（參數(shù)可選），運(yùn)行指定的TextCommand。 |
| canRunCommand(string, <args>) |
none |
如果帶有指定參數(shù)（參數(shù)可選）的命令是可用的，則返回ture。 |
| size() |
int |
返回文件中字符數(shù)量。 |
| substr(region) |
String |
以字符串形式，返回指定region的內(nèi)容。 |
| substr(point) |
String |
返回字符到point的左邊。 |
| insert(point, string) |
int |
插入緩沖器中給定字符串到point。返回插入字符的數(shù)量：如果tab建被轉(zhuǎn)換到當(dāng)前緩沖器空間中，可能很難實(shí)現(xiàn)此功能。 |
| erase(region) |
none |
從緩沖器中清除當(dāng)前region的內(nèi)容。 |
| replace(region, string) |
none |
使用給定的字符替換當(dāng)前region內(nèi)容。 |
| sel() |
RegionSet |
返回選區(qū)的一個(gè)指引。 |
| line(point) |
Region |
返回包含此point的行。 |
| line(region) |
Region |
返回region的一個(gè)修改過(guò)的拷貝，以便它開(kāi)始于一行的去起點(diǎn)。注意到它可能會(huì)跨過(guò)幾行。 |
| fullLine(point) |
Region |
和line()類(lèi)似,但是這個(gè)region包括尾部換行符。 |
| fullLine(region) |
Region |
和line()類(lèi)似,但是這個(gè)region包括尾部換行符。 |
| lines(region) |
[Region] |
返回region中的一個(gè)行列表（排序過(guò)的）。 |
| splitByNewlines(region) |
[Region] |
拆分region，以便每個(gè)region已一行返回。 |
| word(point) |
Region |
返回包含point的單詞。 |
| word(region) |
Region |
返回region的一個(gè)修改的拷貝，開(kāi)始于一個(gè)單詞的開(kāi)頭，結(jié)束于一個(gè)單詞的結(jié)尾。注意到這可能會(huì)跨過(guò)幾個(gè)單詞。 |
| find(pattern, fromPosition, <flags>) |
Region |
返回匹配正則模式的第一個(gè)Region，從給定的point開(kāi)始，如果沒(méi)有找到則沒(méi)有?？蛇x的flags參數(shù)可能為sublime.LITERAL，sublime.IGNORECASE或則兩者一起或的形式。 |
| findAll(pattern, <flags>, <format>, <extractions>) |
[Region] |
返回所有匹配正則模式的（非重疊）regions。可選的flags參數(shù)可能為sublime.LITERAL，sublime.IGNORECASE或者兩者或的形式，然后所有匹配將會(huì)以格式化字符串被格式化，并放入取出的列表中。 |
| rowcol(point) |
(int, int) |
計(jì)算關(guān)于point的，基于0的行和列的數(shù)量。 |
| textPoint(row, col) |
int |
計(jì)算給定的，基于0的行和列的偏移字符。注意到'col'表示從一行開(kāi)始的字符的數(shù)量。 |
| extractScope(point) |
Region |
返回給定point位置字符語(yǔ)法名稱(chēng)的范圍。. |
| syntaxName(point) |
String |
返回給定point位置字符的語(yǔ)法名稱(chēng)。 |
| matchSelector(point, selector) |
bool |
如果選擇器匹配給定point位置字符的語(yǔ)法名稱(chēng)，則返回true。 |
| show(point, <showSurrounds>) |
none |
滾動(dòng)視圖以顯示給定point。 |
| show(region, <showSurrounds>) |
none |
滾動(dòng)視圖以顯示給定 region。 |
| show(regionSet, <showSurrounds>) |
none |
滾動(dòng)視圖以顯示給定regionSet。 |
| visibleRegion() |
Region |
返回視圖的當(dāng)前可視區(qū)域。 |
| extractCompletions(prefix, <point>) |
[String] |
基于緩沖器中的內(nèi)容，返回給定prefix的自動(dòng)補(bǔ)全。補(bǔ)全會(huì)根據(jù)使用頻率來(lái)排序，并且如果支持的話(huà)，遠(yuǎn)離給定的point。 |
| showCompletions(point, prefix, [completions]) |
none |
在給定的point，帶著給定的補(bǔ)全方式，顯示自動(dòng)補(bǔ)全菜單。如果選擇輸入，給定的prefix就會(huì)被選定的補(bǔ)全方式替代。每個(gè)補(bǔ)全方式，可能是一個(gè)字符串，或者包含一個(gè)表述的元組，或者要運(yùn)行的命令。 |
| addRegions(key, [regions], scope, <flags>) |
none |
向視圖中添加一個(gè)region的集合。如果帶著給定key的region集合已經(jīng)存在，它們會(huì)被復(fù)寫(xiě)。scope被用于獲取顏色寫(xiě)入這個(gè)region，它的名字為"comment"或者"string"。如果為空，則regions不會(huì)被寫(xiě)入。 可選flags參數(shù)是關(guān)于以下的，一個(gè)位邏輯的組合：
- sublime.DRAW_EMPTY. 寫(xiě)入帶有垂直條的空region。默認(rèn)地，它們不會(huì)被寫(xiě)入。
- sublime.HIDE_ON_MINIMAP. 不要再minimap中顯示regions。
- sublime.DRAW_EMPTY_AS_OVERWRITE. 寫(xiě)入帶有水平條的空regions，而不是一個(gè)垂直條。
- sublime.DRAW_OUTLINED. 繪制外框而不是填充。
- sublime.PERSISTENT. 在session中保存regions。
|
| getRegions(key) |
[regions] |
返回所有key關(guān)聯(lián)的regions。 |
| eraseRegions(key) |
none |
移除指定regions。 |
| setStatus(key, value) |
none |
添加狀態(tài)key到視圖中。值會(huì)在狀態(tài)條中顯示，通過(guò)key排序，所有狀態(tài)為一個(gè)逗號(hào)分離的列表。設(shè)置值為空字符串將會(huì)清除狀態(tài)。 |
| getStatus(key) |
String |
返回先前所有和key關(guān)聯(lián)的值。 |
| eraseStatus(key) |
none |
清除是定狀態(tài)。 |
sublime.Window類(lèi)
| 方法 |
返回值 |
描述 |
| id() |
int |
返回窗口的唯一標(biāo)識(shí)值。 |
| newFile() |
View |
創(chuàng)建一個(gè)新文件。返回視圖為空，并且它的isLoaded方法返回true。 |
| openFile(filename, <row>, <col>) |
View |
打開(kāi)指定文件，返回相對(duì)應(yīng)的視圖。行和列都是可選的，并且可以被省略。如果文件已經(jīng)被打開(kāi)，它會(huì)在前端顯示。注意到由于加載文件是異步的，在返回的視圖上操作是不可能的，知道它的isLoading方法返回為false。 |
| activeView() |
View |
返回當(dāng)前編輯的視圖。 |
| activeViewInGroup(groupIdx) |
View |
返回給定group中活動(dòng)的視圖。 |
| views() |
[View] |
返回當(dāng)前窗口中的視圖列表。 |
| viewsInGroup(groupIdx) |
[View] |
返回給定group中的視圖列表。 |
| focusView(view) |
none |
聚焦給定視圖。 |
| numGroups() |
int |
返回窗口中視圖groups 的數(shù)量。 |
| activeGroup() |
int |
返回當(dāng)前選中g(shù)roup。 |
| getViewPosition(view) |
groupIdx, viewIdx |
返回給定視圖的group，以及group的索引。 |
| setViewPosition(view, groupIdx, viewIdx) |
none |
移動(dòng)視圖到給定group和包含在group內(nèi)的索引。 |
| runCommand(string, <args>) |
none |
使用給定的參數(shù)（參數(shù)可選）運(yùn)行指定的WindowCommand。 |
| canRunCommand(string, <args>) |
none |
如果使用給定參數(shù)（參數(shù)可選）的命令是可用的，則返回true。 |
| isFullScreen() |
bool |
如果窗口當(dāng)前為全屏模式，則返回true。 |
| showQuickPanel(key, command, args, <displayArgs>, <flags>) |
none |
使用displayArgs參數(shù)，顯示快速面板。當(dāng)鍵入entry的時(shí)候，帶有相應(yīng)選擇的顯示參數(shù)的命令開(kāi)始運(yùn)行。如果異步地升級(jí)列表，則需要使用key，否則使其為空。displayArgs是可選參數(shù)，并且默認(rèn)地為參數(shù)的列表?？蛇x參數(shù)flags是一個(gè)位邏輯的組合:
- sublime.QUICK_PANEL_FILES. 指明參數(shù)相對(duì)應(yīng)的文件名字，這會(huì)改變它們?nèi)绾伪焕L制。
- sublime.QUICK_PANEL_MULTI_SELECT. 使得Ctrl+Enter選擇快速面板上所有顯示的條目，最大值為16。
- sublime.QUICK_PANEL_NO_MULTI_SELECT_SAFETY_CHECK. 和上面聯(lián)合使用，可以移除16條的限制。
- sublime.QUICK_PANEL_UPDATE_ONLY. 當(dāng)異步地升級(jí)面板的時(shí)候，如果面板已經(jīng)被關(guān)閉，忽略升級(jí)調(diào)用。
- sublime.QUICK_PANEL_MONOSPACE_FONT. 使用一個(gè)等寬字體去繪制快速面板。
|
| showSelectPanel(displayArgs, onSelect, onCancel, flags, <key>, <selectedIndex>) |
none |
使用displayArgs參數(shù)顯示快速面板。onSelect會(huì)運(yùn)行于每一個(gè)被選擇的條目，條目的索引作為一個(gè)參數(shù)被傳入。如果面板沒(méi)有選擇任何條目而關(guān)閉，onCancel將會(huì)運(yùn)行。 可選參數(shù)flags是一個(gè)位邏輯的組合:
- sublime.SELECT_PANEL_FILES. 指明對(duì)應(yīng)于文件名字的參數(shù)，這個(gè)參數(shù)改變它們?nèi)绾卫L制。
- sublime.SELECT_PANEL_MULTI_SELECT.使得Ctrl+Enter選擇快速面板上所有顯示的條目，最大值為16。
- sublime.SELECT_PANEL_NO_MULTI_SELECT_SAFETY_CHECK. 和上面聯(lián)合使用，可以移除16條的限制。
- sublime.SELECT_PANEL_UPDATE_ONLY. 當(dāng)異步地升級(jí)面板的時(shí)候，如果面板已經(jīng)被關(guān)閉，忽略升級(jí)調(diào)用。
- sublime.SELECT_PANEL_MONOSPACE_FONT. 使用一個(gè)等寬字體去繪制快速面板。
如果異步地升級(jí)列表，則需要使用key，否則使其為空。 selectedIndex應(yīng)當(dāng)為最初選擇條目的索引，或者省略。 |
| showInputPanel(caption, initialText, onDone, onChange, onCancel) |
View |
顯示輸入面板，從用戶(hù)收集一行輸入。如果none，onDone和onChange應(yīng)該是單字符串參數(shù)的函數(shù)。onCancel應(yīng)當(dāng)是一個(gè)無(wú)參數(shù)的函數(shù)。用于輸入框架的視圖被返回。 |
| renderer() |
String |
返回活動(dòng)Renderer的名字，"DirectX"或者"OpenGL"。 |
| hwnd() |
HWND |
返回window的win32窗口手柄。 |
sublime.Options類(lèi)
| 方法 |
返回值 |
描述 |
| getString(name) |
String |
返回指定選項(xiàng)的字符串值。 |
| get(name) |
value |
作為合適的類(lèi)型返回指定選項(xiàng)。 |
| get(name, default) |
value |
作為合適的類(lèi)型返回指定選項(xiàng)，或者如果沒(méi)有定義，則使用默認(rèn)值。 |
| set(name, value) |
none |
設(shè)置指定選項(xiàng)。僅僅接受原始的類(lèi)型。 |
| erase(name) |
none |
移除指定的選項(xiàng)。不要將它從任何父類(lèi)選項(xiàng)移除。 |
| has(name) |
bool |
如果指定選項(xiàng)存在于Options集合或者它的父類(lèi)中一個(gè)，返回true。 |
sublime.RegionSet 類(lèi)
保存一組選區(qū)，并確保它們沒(méi)有交疊，并按順序排列：
| 方法 |
返回值 |
描述 |
| clear() |
none |
去除所有選區(qū)。 |
| add(region) |
none |
添加指定選區(qū)。若在選區(qū)組里已存在與之相交的選區(qū)，二者會(huì)合而為一。 |
| addAll(regionSet) |
none |
添加指定選區(qū)組中所有選區(qū)到當(dāng)前選區(qū)組中。 |
| subtract(region) |
none |
從選區(qū)組中去除指定的選區(qū)。 |
| contains(region) |
bool |
判斷指定選區(qū)是否包含在此選區(qū)組中。當(dāng)包含時(shí)，返回true。 |
sublime.Region 類(lèi)
表示緩沖的一個(gè)區(qū)域。當(dāng)界定區(qū)域兩個(gè)端點(diǎn)的a和b相等時(shí)，表示一個(gè)空選區(qū)。
| 構(gòu)造函數(shù) |
描述 |
| Region(a, b) |
用初始值a和b創(chuàng)建一個(gè)選區(qū). |
| 屬性 |
類(lèi)型 |
描述 |
| a |
int |
選區(qū)第一個(gè)端點(diǎn)。 |
| b |
int |
選區(qū)第二個(gè)端點(diǎn)?？梢员?a 小，形成一個(gè)逆向選區(qū)。 |
| 方法 |
返回值 |
描述 |
| begin() |
int |
返回a和b的最小值。 |
| end() |
int |
返回a和b的最大值。 |
| size() |
int |
返回選區(qū)包含的字符數(shù)量。始終 >= 0。 |
| empty() |
bool |
當(dāng)begin() == end()時(shí)為true，表示空選區(qū)。 |
| cover(region) |
Region |
返回一個(gè)跨越指定選區(qū)和當(dāng)前選區(qū)的新選區(qū)。 |
| intersection(region) |
Region |
返回本選區(qū)與指定選區(qū)的交疊部分（作為一個(gè)新選區(qū)）。 |
| intersects(region) |
bool |
判斷指定選區(qū)與本選區(qū)是否相交，當(dāng)它們完全相同或者有部分相交時(shí)，返回true。 |
| contains(region) |
bool |
判斷指定選區(qū)是否包含于本選區(qū)。 |
| contains(point) |
bool |
返回指定的位置是否處于本選區(qū)，即begin() <= point <= end()。 |
sublimeplugin 模塊
sublimeplugin.Plugin 類(lèi)
注意到這些時(shí)間中的大多數(shù)，都是在視圖之下的緩沖器觸發(fā)的，并且這個(gè)方法僅僅被調(diào)用一次，并且將第一個(gè)視圖作為參數(shù)。
| Methods |
Return Value |
Description |
| onNew(view) |
none |
當(dāng)一個(gè)新的緩沖器創(chuàng)建的時(shí)候調(diào)用。 |
| onClone(view) |
none |
當(dāng)從一個(gè)存在的視圖克隆的時(shí)候調(diào)用。 |
| onLoad(view) |
none |
當(dāng)文件完成加載的時(shí)候調(diào)用。 |
| onClose(view) |
none |
當(dāng)一個(gè)視圖關(guān)閉（注意，在相同緩沖器中可能存在其他視圖）。 |
| onPreSave(view) |
none |
僅僅在一個(gè)視圖被保存的時(shí)候調(diào)用。 |
| onPostSave(view) |
none |
一個(gè)視圖已經(jīng)被保存之后調(diào)用。 |
| onModified(view) |
none |
對(duì)一個(gè)視圖做出改變之后調(diào)用 |
| onSelectionModified(view) |
none |
在一個(gè)視圖中，片區(qū)被修改之后調(diào)用。 |
| onActivated(view) |
none |
當(dāng)一個(gè)視圖獲得輸入聚焦的時(shí)候調(diào)用。 |
| onProjectLoad(window) |
none |
一個(gè)工程被加載之后調(diào)用 |
| onProjectClose(window) |
none |
一個(gè)工程被關(guān)閉之后調(diào)用 |
| onQueryContext(view, key, value) |
bool or none |
當(dāng)決定去觸發(fā)一個(gè)和給定上下文key關(guān)聯(lián)的key的時(shí)候調(diào)用。如果插件知道如何響應(yīng)上下文，它應(yīng)該返回True或False。如果這個(gè)上下文是未知的，它應(yīng)當(dāng)返回None。 |
sublimeplugin.ApplicationCommand(插件) 類(lèi)
| 方法 |
返回值 |
描述 |
| run(args) |
none |
運(yùn)行命令時(shí)將調(diào)用此方法。 |
| isEnabled(args) |
bool |
當(dāng)此時(shí)環(huán)境允許命令可以被調(diào)用，返回 true。默認(rèn)返回true。 |
sublimeplugin.WindowCommand(Plugin) 類(lèi)
| 方法 |
返回值 |
描述 |
| run(window, args) |
none |
運(yùn)行命令時(shí)將調(diào)用此方法。 |
| isEnabled(window, args) |
bool |
當(dāng)此時(shí)環(huán)境允許命令可以被調(diào)用，返回 true。默認(rèn)返回true。 |
sublimeplugin.TextCommand(Plugin) 類(lèi)
| 方法 |
返回值 |
描述 |
| run(view, args) |
none |
運(yùn)行命令時(shí)將調(diào)用此方法。 |
| isEnabled(view, args) |
bool |
當(dāng)此時(shí)環(huán)境允許命令可以被調(diào)用，返回 true。默認(rèn)返回true。 |
|
