sumbline中html插件,Sublime Text 3 中文文档之

方法

返回值

描述

id()

int

返回唯一标识此视图的数字。

buffer_id()

int

返回唯一标识此视图下的缓冲区的数字。

is_primary()

bool

如果视图是文件的主视图。如果用户已在文件中打开多个视图，则仅为False。

file_name()

str

全名文件是与缓冲区关联的文件，如果磁盘上不存在则为None。

name()

str

分配给缓冲区的名称(如果有)

set_name(name)

None

为缓冲区指定名称

is_loading()

bool

如果缓冲区仍在从磁盘加载，并且尚未准备好使用，则

返回True。

is_dirty()

bool

如果对缓冲区有任何未保存的修改，则

返回True。

is_read_only()

bool

如果可能未修改缓冲区，则

返回True。

set_read_only(value)

None

设置缓冲区的只读属性。

is_scratch()

bool

如果缓冲区是临时缓冲区，则

返回True。划痕缓冲区从不报告为脏。

set_scratch(value)

None

设置缓冲区的scratch属性。

settings()

返回对视图的设置对象的引用。对此设置对象的任何更改都将对此视图是私有的。

window()

返回对包含视图的窗口的引用。

run_command(string, )

None

使用(可选)给定的args

运行命名的TextCommand。

size()

int

返回文件中的字符数。

substr(region)

str

以字符串形式

返回region的内容。

substr(point)

str

返回该point右侧的字符。

insert(edit, point, string)

int

将给定string插入指定point的缓冲区中。返回插入的字符数：如果将制表符转换为当前缓冲区中的空格，则可能会有所不同。

erase(edit, region)

None

从缓冲区中

删除该region的内容。

replace(edit, region, string)

None

用给定的string

替换region的内容。

sel()

返回对选择的引用。

line(point)

返回包含该point的行。

line(region)

返回region的修改副本，使其从一行的开头开始，到一行的结尾。请注意，它可能跨越几行。

full_line(point)

作为line()，但该区域包含尾随换行符，如果有的话。

full_line(region)

作为line()，但该区域包含尾随换行符，如果有的话。

lines(region)

返回与region相交的行列表(按排序顺序)。

split_by_newlines(region)

将region拆分为使得返回的每个区域仅存在于一条线上。

word(point)

返回包含该point的单词。

word(region)

返回region的修改副本，使其从单词的开头开始，到单词结尾处结束。请注意，它可能会跨越几个单词。

classify(point)

int

对point进行分类，返回零或多个这些标志的按位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

find_by_class(point, forward, classes, )

查找与给定class匹配的point之后的下一个位置。如果forward为False，则向后搜索而不是向前搜索。classes是sublime.CLASS_XXX标志的按位OR

。可以传入separators，以定义应该考虑哪些字符来分隔单词。

expand_by_class(point, classes, )

将point向左和向右扩展，直到每一侧都落在与class匹配的位置。classes是sublime.CLASS_XXX标志的按位OR

。可以传入分隔符，以定义应该考虑哪些字符来分隔单词。

expand_by_class(region, classes, )

向左和向右

扩展region，直到每一侧都落在与class匹配的位置。classes是sublime.CLASS_XXX标志的按位OR

。可以传入separators，以定义应该考虑哪些字符来分隔单词。

find(pattern, start_point, )

返回匹配正则表达式模式的第一个区域，从start_point开始，如果找不到则返回None。可选的flags参数可以是sublime.LITERAL，sublime.IGNORECASE，也可以是两个ORed在一起。

find_all(pattern, , , )

返回与正则表达式模式匹配的所有(非重叠)区域。可选的flags参数可以是sublime.LITERAL，sublime.IGNORECASE，也可以是两个ORed在一起。如果给出了格式字符串，则所有匹配项将使用格式化字符串进行格式化并放入提取列表中。

rowcol(point)

(int, int)

计算的基于0的行号和列号point。

text_point(row, col)

int

计算给定的基于0的row和col的字符偏移量。请注意，col被解释为超过行开头的字符数。

set_syntax_file(syntax_file)

None

更改视图使用的语法。syntax_file应该是Packages/Python/Python.tmLanguage的名称。要检索当前语法，请使用view.settings().get('syntax')。

extract_scope(point)

返回在给定point分配给字符的语法范围名称的范围。

scope_name(point)

str

返回在给定point分配给字符的语法范围名称。

match_selector(point, selector)

bool

检查selector是否在给定point的范围内，如果匹配则返回bool。

score_selector(point, selector)

int

将selector与给定point的范围匹配，返回分数。得分为0表示不匹配，高于0表示匹配。可以将不同的选择器与相同的范围进行比较：较高的分数意味着选择器是范围的更好匹配。

find_by_selector(selector)

查找与给定selector匹配的文件中的所有区域，并将它们作为列表返回。

show(location, )

None

滚动视图以显示给定location，该location可以是point，Region或Selection。

show_at_center(location)

None

将视图滚动到中心location，该location可以是point或Selection。

visible_region()

返回视图的当前可见区域。

viewport_position()

返回视口在布局坐标中的偏移量。

set_viewport_position(vector,

None

将视口滚动到给定的布局位置。

viewport_extent()

返回视口的宽度和高度。

layout_extent()

返回布局的宽度和高度。

text_to_layout(point)

将文本点转换为布局位置

text_to_window(point)

将文本点转换为窗口位置

layout_to_text(vector)

将布局位置转换为文本点

layout_to_window(vector)

将布局位置转换为窗口位置

window_to_layout(vector)

将窗口位置转换为布局位置

window_to_text(vector)

将窗口位置转换为文本点

line_height()

返回布局中使用的灯光高度

em_width()

返回布局中使用的典型字符宽度

add_regions(key, [regions], , , )

None

向视图

添加一组region。如果已存在具有给定key的一组region，则它们将被覆盖。的scope被用于源颜色来绘制region中，它应该是一个范围的名称，如"comment"或"string"。如果scope为空，则不会绘制region。

可选的图标名称(如果给定)将在每个区域旁边的装订线中绘制命名图标。该icon将使用与示波器关联的颜色进行着色。有效的图标名称是point，circle和bookmark。图标名称也可以是完整的包相对路径，例如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。

get_regions(key)

返回与给定key关联的区域(如果有)

erase_regions(key)

None

删除了指定的区域

set_status(key, value)

None

将状态key添加到视图。该value将显示在状态栏中，以逗号分隔的所有状态值列表，按键排序。将value设置为空字符串将清除状态。

get_status(key)

str

返回与key关联的先前分配的值(如果有)。

erase_status(key)

None

清除指定的状态。

command_history(index, )

(str, dict, int)

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

索引0对应于最近的命令，-1对应于此之前的命令，依此类推。索引的正值表示在重做堆栈中查找命令。如果撤消/重做历史记录扩展得不够远，则返回(None，None，0)。

将modification_only设置为True(默认值为False)将仅返回修改缓冲区的条目。

change_count()

int

返回当前更改计数。每次修改缓冲区时，更改计数都会递增。更改计数可用于确定缓冲区自上次检查后是否已更改。

fold([regions])

bool

折叠给定region，如果它们已经折叠则

返回False

fold(region)

bool

折叠给定region，如果已经折叠则

返回False

unfold(region)

展现在所有文本region，返回展开区域

unfold([regions])

展现在所有文本region，返回展开区域

encoding()

str

返回当前与文件关联的编码

set_encoding(encoding)

None

对文件应用新编码。下次保存文件时将使用此编码。

line_endings()

str

返回当前文件使用的行结尾。

set_line_endings(line_endings)

None

设置下次保存时将应用的行结尾。

overwrite_status()

bool

返回覆盖状态，用户通常通过插入键切换。

set_overwrite_status(enabled)

None

设置覆盖状态。

symbols()

[(Region, str)]

提取缓冲区中定义的所有符号。

show_popup_menu(items, on_done, )

None

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

items是一个字符串列表。

flags它当前未使用。

show_popup(content, , , , ,

, )

None

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

flags是以下的按位组合：

sublime.COOPERATE_WITH_AUTO_COMPLETE。使弹出窗口显示在自动完成菜单旁边

sublime.HIDE_ON_MOUSE_MOVE。移动，单击或滚动鼠标时弹出窗口隐藏

sublime.HIDE_ON_MOUSE_MOVE_AWAY。移动鼠标时弹出窗口(除非弹出窗口)或单击或滚动时弹出窗口

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

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

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

隐藏弹出窗口时调用on_hide。

update_popup(content)

None

更新当前可见弹出窗口的内容。

is_popup_visible()

bool

如果当前显示弹出窗口，则返回。

hide_popup()

None

隐藏弹出窗口。

is_auto_complete_visible()

bool

如果自动完成菜单当前可见，则返回。

style()

dict

返回视图的全局样式设置的dict。所有颜色都标准化为带有前导散列的六字符十六进制形式，例如＃ff0000。

style_for_scope(scope_name)

dict

接受字符串作用域名称并返回样式信息的dict，包括键foreground，bold，italic，source_line，source_column和source_file。如果范围具有背景颜色集，则将显示关键background。前景色和背景色被标准化为具有前导散列的六字符十六进制形式，例如＃ff0000。