TextEdit¶

继承¶

Control

简要描述¶

多行文字编辑控件。

描述¶

TextEdit用于编辑多行文本，它也有编辑码功能，如语法高亮支持和撤销/重做的多个级别。

成员¶

方法¶

信号¶

• breakpoint_toggled

通过断点槽放置断点时发出。

• cursor_changed

光标更改时发出。

• info_clicked

单击信息图标时发出。

• request_completion

• symbol_lookup

• text_changed

文本更改时发出。

枚举¶

enum SearchFlags: - SEARCH_MATCH_CASE = 1

搜索时区分大小写。

• SEARCH_WHOLE_WORDS = 2

搜索时匹配整个单词。

• SEARCH_BACKWARDS = 4

从头到尾搜索。

enum SearchResult: - SEARCH_RESULT_COLUMN = 0

用于从[方法搜索]中访问结果列。

• SEARCH_RESULT_LINE = 1

用于从[方法搜索]访问结果行。

enum MenuItems: - MENU_CUT = 0

剪切（复制并清除）所选文本。

• MENU_COPY = 1

复制所选文本。

• MENU_PASTE = 2

将剪贴板上的文本粘贴到选定的文本上（或光标的位置）。

• MENU_CLEAR = 3

擦除整个TextEdit文本。

• MENU_SELECT_ALL = 4

选择整个TextEdit文本。

• MENU_UNDO = 5

撤消上一个动作。

• MENU_REDO = 6

重做上一个动作。

• MENU_MAX = 7

表示MenuItems枚举的大小。

常量¶

成员说明¶

• bool breakpoint_gutter

• bool caret_blink

• float caret_blink_speed

• bool caret_block_mode

• bool caret_moving_by_right_click

• bool context_menu_enabled

• bool draw_spaces

• bool draw_tabs

• int focus_mode

• bool fold_gutter

• bool hiding_enabled

• bool highlight_all_occurrences

• bool highlight_current_line

• bool minimap_draw

• int minimap_width

• int mouse_default_cursor_shape

• bool override_selected_font_color

• bool readonly

• int scroll_horizontal

• float scroll_vertical

• bool selecting_enabled

• bool shortcut_keys_enabled

• bool show_line_numbers

• bool smooth_scrolling

• bool syntax_highlighting

• String text

• float v_scroll_speed

• bool wrap_enabled

方法说明¶

• add_color_region add_color_region(begin_key: String, end_key: String, color: Color, line_only: bool = false)

添加颜色区域（给定分隔符）及其颜色。

• add_keyword_color add_keyword_color(keyword: String, color: Color)

添加关键字及其Color。

• can_fold can_fold(line: int) const

如果给定的行是可折叠的，则返回该行。即在它的正下方有缩进的行。

• center_viewport_to_cursor center_viewport_to_cursor()

• clear_colors clear_colors()

清除以前通过add_color_region或add_keyword_color添加的所有自定义语法着色信息。

• clear_undo_history clear_undo_history()

清除撤消历史记录。

• copy copy()

复制当前的文本选择。

• cursor_get_column cursor_get_column() const

返回编辑光标所在的列。

• cursor_get_line cursor_get_line() const

返回编辑光标所在的行。

• cursor_set_column cursor_set_column(column: int, adjust_viewport: bool = true)

将光标移动到指定的列索引处。

如果将adjust_viewport设置为true，则视口将在发生移动后居中于光标位置。

• cursor_set_line cursor_set_line(line: int, adjust_viewport: bool = true, can_be_hidden: bool = true, wrap_index: int = 0)

将光标移动到指定的line索引处。

如果将adjust_viewport设置为true，则视口将在发生移动后居中于光标位置。

如果can_be_hidden设置为true，则可以使用set_line_as_hidden隐藏指定的line。

• cut cut()

剪切为当前选择。

• deselect deselect()

取消选择当前选择。

• fold_all_lines fold_all_lines()

折叠所有可能折叠的行（请参见can_fold）。

• fold_line fold_line(line: int)

如果可能的话，折叠给定的行（请参见can_fold）。

• get_breakpoints get_breakpoints() const

返回一个包含每个断点行号的数组。

• get_keyword_color get_keyword_color(keyword: String) const

返回指定的关键字的Color。

• get_line get_line(line: int) const

返回特定行的文本。

• get_line_count get_line_count() const

返回文本中的总行数。

• get_menu get_menu() const

返回此TextEdit的PopupMenu。

• get_selection_from_column get_selection_from_column() const

返回选择开始列。

• get_selection_from_line get_selection_from_line() const

返回选择开始行。

• get_selection_text get_selection_text() const

返回所选内容内的文本。

• get_selection_to_column get_selection_to_column() const

返回选择结束列。

• get_selection_to_line get_selection_to_line() const

返回选择结束行。

• get_word_under_cursor get_word_under_cursor() const

返回String文本，其单词在鼠标光标位置下。

• has_keyword_color has_keyword_color(keyword: String) const

返回指定的keyword是否设置了颜色。

• insert_text_at_cursor insert_text_at_cursor(text: String)

在光标位置插入指定的文本。

• is_folded is_folded(line: int) const

返回指定索引处的行是否折叠。

• is_line_hidden is_line_hidden(line: int) const

返回指定索引处的行是否隐藏。

• is_selection_active is_selection_active() const

如果选择处于活动状态，则返回true。

• menu_option menu_option(option: int)

通过指定的索引触发右键单击菜单动作。

• paste paste()

粘贴当前选择。

• redo redo()

执行重做操作。

• remove_breakpoints remove_breakpoints()

删除所有断点。

• search search(key: String, flags: int, from_line: int, from_column: int) const

在文本内执行搜索。

如果未找到结果，则返回一个空的PoolIntArray。

var result = search(key, flags, line, column)
if result.size() > 0:
    # Result found.
    var res_line = result[TextEdit.SEARCH_RESULT_LINE]
    var res_column = result[TextEdit.SEARCH_RESULT_COLUMN]

• select select(from_line: int, from_column: int, to_line: int, to_column: int)

从行/列到行/列执行选择。

• select_all select_all()

选择所有文本。

• set_line_as_hidden set_line_as_hidden(line: int, enable: bool)

如果true，则隐藏指定索引的行。

• toggle_fold_line toggle_fold_line(line: int)

在给定的行上切换代码块的折叠。

• undo undo()

执行撤消操作。

• unfold_line unfold_line(line: int)

如果给定的行折叠，则展开。

• unhide_all_lines unhide_all_lines()

取消隐藏先前由set_line_as_hidden设置为隐藏的所有行。