TextEdit

Успадковує: Control < CanvasItem < Node < Object

Успадковано від: CodeEdit

Багатоканальний текстовий редактор.

Опис

Багаторядковий текстовий редактор. Він також має обмежені можливості редагування коду, такі як підтримка підсвічування синтаксису. Щоб дізнатися більше про розширені можливості редагування коду, див. CodeEdit.

Під час введення тексту можна вставляти спеціальні символи за допомогою кодів Unicode, OEM або Windows alt:

  • Щоб ввести коди Unicode, утримуйте Alt та введіть код на цифровій клавіатурі. Наприклад, щоб ввести символ á (U+00E1), утримуйте Alt та введіть +E1 на цифровій клавіатурі (початкові нулі можна пропускати).

  • Щоб ввести коди OEM, утримуйте Alt та введіть код на цифровій клавіатурі. Наприклад, щоб ввести символ á (OEM 160), утримуйте Alt та введіть 160 на цифровій клавіатурі.

  • Щоб ввести кодові точки Windows, утримуйте Alt та введіть код на цифровій клавіатурі. Наприклад, щоб ввести символ á (Windows 0225), утримуйте Alt та введіть 0, 2, 2, 5 на цифровій клавіатурі. Початковий нуль тут не можна пропускати, оскільки саме так кодові точки Windows відрізняються від кодових точок OEM.

Примітка: Більшість методів перегляду, каретки та редагування містять аргумент caret_index для підтримки caret_multiple. Аргумент має бути одним із наступних значень: -1 для всіх кареток, 0 для головної каретки або більше ніж 0 для вторинних кареток у порядку їх створення.

Примітка: Якщо утримувати клавішу Alt, вертикальне колесо прокручування прокручуватиметься у 5 разів швидше, ніж зазвичай. Це також працює в редакторі скриптів Godot.

Властивості

AutowrapMode

autowrap_mode

3

bool

backspace_deletes_composite_character_enabled

false

bool

caret_blink

false

float

caret_blink_interval

0.65

bool

caret_draw_when_editable_disabled

false

bool

caret_mid_grapheme

false

bool

caret_move_on_right_click

true

bool

caret_multiple

true

CaretType

caret_type

0

bool

clip_contents

true (overrides Control)

bool

context_menu_enabled

true

String

custom_word_separators

""

bool

deselect_on_focus_loss_enabled

true

bool

drag_and_drop_selection_enabled

true

bool

draw_control_chars

false

bool

draw_spaces

false

bool

draw_tabs

false

bool

editable

true

bool

emoji_menu_enabled

true

bool

empty_selection_clipboard_enabled

true

FocusMode

focus_mode

2 (overrides Control)

bool

highlight_all_occurrences

false

bool

highlight_current_line

false

bool

indent_wrapped_lines

false

String

language

""

bool

middle_mouse_paste_enabled

true

bool

minimap_draw

false

int

minimap_width

80

CursorShape

mouse_default_cursor_shape

1 (overrides Control)

String

placeholder_text

""

bool

scroll_fit_content_height

false

bool

scroll_fit_content_width

false

int

scroll_horizontal

0

bool

scroll_past_end_of_file

false

bool

scroll_smooth

false

float

scroll_v_scroll_speed

80.0

float

scroll_vertical

0.0

bool

selecting_enabled

true

bool

shortcut_keys_enabled

true

StructuredTextParser

structured_text_bidi_override

0

Array

structured_text_bidi_override_options

[]

SyntaxHighlighter

syntax_highlighter

bool

tab_input_mode

true

String

text

""

TextDirection

text_direction

0

bool

use_custom_word_separators

false

bool

use_default_word_separators

true

bool

virtual_keyboard_enabled

true

bool

virtual_keyboard_show_on_focus

true

LineWrappingMode

wrap_mode

0

Методи

void

_backspace(caret_index: int) virtual

void

_copy(caret_index: int) virtual

void

_cut(caret_index: int) virtual

void

_handle_unicode_input(unicode_char: int, caret_index: int) virtual

void

_paste(caret_index: int) virtual

void

_paste_primary_clipboard(caret_index: int) virtual

int

add_caret(line: int, column: int)

void

add_caret_at_carets(below: bool)

void

add_gutter(at: int = -1)

void

add_selection_for_next_occurrence()

void

adjust_carets_after_edit(caret: int, from_line: int, from_col: int, to_line: int, to_col: int)

void

adjust_viewport_to_caret(caret_index: int = 0)

void

apply_ime()

void

backspace(caret_index: int = -1)

void

begin_complex_operation()

void

begin_multicaret_edit()

void

cancel_ime()

void

center_viewport_to_caret(caret_index: int = 0)

void

clear()

void

clear_undo_history()

void

collapse_carets(from_line: int, from_column: int, to_line: int, to_column: int, inclusive: bool = false)

void

copy(caret_index: int = -1)

void

cut(caret_index: int = -1)

void

delete_selection(caret_index: int = -1)

void

deselect(caret_index: int = -1)

void

end_action()

void

end_complex_operation()

void

end_multicaret_edit()

int

get_caret_column(caret_index: int = 0) const

int

get_caret_count() const

Vector2

get_caret_draw_pos(caret_index: int = 0) const

PackedInt32Array

get_caret_index_edit_order()

int

get_caret_line(caret_index: int = 0) const

int

get_caret_wrap_index(caret_index: int = 0) const

int

get_first_non_whitespace_column(line: int) const

int

get_first_visible_line() const

int

get_gutter_count() const

String

get_gutter_name(gutter: int) const

GutterType

get_gutter_type(gutter: int) const

int

get_gutter_width(gutter: int) const

HScrollBar

get_h_scroll_bar() const

int

get_indent_level(line: int) const

int

get_last_full_visible_line() const

int

get_last_full_visible_line_wrap_index() const

int

get_last_unhidden_line() const

String

get_line(line: int) const

Color

get_line_background_color(line: int) const

Vector2i

get_line_column_at_pos(position: Vector2i, clamp_line: bool = true, clamp_column: bool = true) const

int

get_line_count() const

Texture2D

get_line_gutter_icon(line: int, gutter: int) const

Color

get_line_gutter_item_color(line: int, gutter: int) const

Variant

get_line_gutter_metadata(line: int, gutter: int) const

String

get_line_gutter_text(line: int, gutter: int) const

int

get_line_height() const

Array[Vector2i]

get_line_ranges_from_carets(only_selections: bool = false, merge_adjacent: bool = true) const

int

get_line_width(line: int, wrap_index: int = -1) const

String

get_line_with_ime(line: int) const

int

get_line_wrap_count(line: int) const

int

get_line_wrap_index_at_column(line: int, column: int) const

PackedStringArray

get_line_wrapped_text(line: int) const

Vector2

get_local_mouse_pos() const

PopupMenu

get_menu() const

int

get_minimap_line_at_pos(position: Vector2i) const

int

get_minimap_visible_lines() const

int

get_next_composite_character_column(line: int, column: int) const

Vector2i

get_next_visible_line_index_offset_from(line: int, wrap_index: int, visible_amount: int) const

int

get_next_visible_line_offset_from(line: int, visible_amount: int) const

Vector2i

get_pos_at_line_column(line: int, column: int) const

int

get_previous_composite_character_column(line: int, column: int) const

Rect2i

get_rect_at_line_column(line: int, column: int) const

int

get_saved_version() const

float

get_scroll_pos_for_line(line: int, wrap_index: int = 0) const

String

get_selected_text(caret_index: int = -1)

int

get_selection_at_line_column(line: int, column: int, include_edges: bool = true, only_selections: bool = true) const

int

get_selection_column(caret_index: int = 0) const

int

get_selection_from_column(caret_index: int = 0) const

int

get_selection_from_line(caret_index: int = 0) const

int

get_selection_line(caret_index: int = 0) const

SelectionMode

get_selection_mode() const

int

get_selection_origin_column(caret_index: int = 0) const

int

get_selection_origin_line(caret_index: int = 0) const

int

get_selection_to_column(caret_index: int = 0) const

int

get_selection_to_line(caret_index: int = 0) const

PackedInt32Array

get_sorted_carets(include_ignored_carets: bool = false) const

int

get_tab_size() const

int

get_total_gutter_width() const

int

get_total_visible_line_count() const

VScrollBar

get_v_scroll_bar() const

int

get_version() const

int

get_visible_line_count() const

int

get_visible_line_count_in_range(from_line: int, to_line: int) const

String

get_word_at_pos(position: Vector2) const

String

get_word_under_caret(caret_index: int = -1) const

bool

has_ime_text() const

bool

has_redo() const

bool

has_selection(caret_index: int = -1) const

bool

has_undo() const

void

insert_line_at(line: int, text: String)

void

insert_text(text: String, line: int, column: int, before_selection_begin: bool = true, before_selection_end: bool = false)

void

insert_text_at_caret(text: String, caret_index: int = -1)

bool

is_caret_after_selection_origin(caret_index: int = 0) const

bool

is_caret_visible(caret_index: int = 0) const

bool

is_dragging_cursor() const

bool

is_gutter_clickable(gutter: int) const

bool

is_gutter_drawn(gutter: int) const

bool

is_gutter_overwritable(gutter: int) const

bool

is_in_mulitcaret_edit() const

bool

is_line_gutter_clickable(line: int, gutter: int) const

bool

is_line_wrapped(line: int) const

bool

is_menu_visible() const

bool

is_mouse_over_selection(edges: bool, caret_index: int = -1) const

bool

is_overtype_mode_enabled() const

void

menu_option(option: int)

void

merge_gutters(from_line: int, to_line: int)

void

merge_overlapping_carets()

bool

multicaret_edit_ignore_caret(caret_index: int) const

void

paste(caret_index: int = -1)

void

paste_primary_clipboard(caret_index: int = -1)

void

redo()

void

remove_caret(caret: int)

void

remove_gutter(gutter: int)

void

remove_line_at(line: int, move_carets_down: bool = true)

void

remove_secondary_carets()

void

remove_text(from_line: int, from_column: int, to_line: int, to_column: int)

Vector2i

search(text: String, flags: int, from_line: int, from_column: int) const

void

select(origin_line: int, origin_column: int, caret_line: int, caret_column: int, caret_index: int = 0)

void

select_all()

void

select_word_under_caret(caret_index: int = -1)

void

set_caret_column(column: int, adjust_viewport: bool = true, caret_index: int = 0)

void

set_caret_line(line: int, adjust_viewport: bool = true, can_be_hidden: bool = true, wrap_index: int = 0, caret_index: int = 0)

void

set_gutter_clickable(gutter: int, clickable: bool)

void

set_gutter_custom_draw(column: int, draw_callback: Callable)

void

set_gutter_draw(gutter: int, draw: bool)

void

set_gutter_name(gutter: int, name: String)

void

set_gutter_overwritable(gutter: int, overwritable: bool)

void

set_gutter_type(gutter: int, type: GutterType)

void

set_gutter_width(gutter: int, width: int)

void

set_line(line: int, new_text: String)

void

set_line_as_center_visible(line: int, wrap_index: int = 0)

void

set_line_as_first_visible(line: int, wrap_index: int = 0)

void

set_line_as_last_visible(line: int, wrap_index: int = 0)

void

set_line_background_color(line: int, color: Color)

void

set_line_gutter_clickable(line: int, gutter: int, clickable: bool)

void

set_line_gutter_icon(line: int, gutter: int, icon: Texture2D)

void

set_line_gutter_item_color(line: int, gutter: int, color: Color)

void

set_line_gutter_metadata(line: int, gutter: int, metadata: Variant)

void

set_line_gutter_text(line: int, gutter: int, text: String)

void

set_overtype_mode_enabled(enabled: bool)

void

set_search_flags(flags: int)

void

set_search_text(search_text: String)

void

set_selection_mode(mode: SelectionMode)

void

set_selection_origin_column(column: int, caret_index: int = 0)

void

set_selection_origin_line(line: int, can_be_hidden: bool = true, wrap_index: int = -1, caret_index: int = 0)

void

set_tab_size(size: int)

void

set_tooltip_request_func(callback: Callable)

void

skip_selection_for_next_occurrence()

void

start_action(action: EditAction)

void

swap_lines(from_line: int, to_line: int)

void

tag_saved_version()

void

undo()

Властивості теми

Color

background_color

Color(0, 0, 0, 0)

Color

caret_background_color

Color(0, 0, 0, 1)

Color

caret_color

Color(0.875, 0.875, 0.875, 1)

Color

current_line_color

Color(0.25, 0.25, 0.26, 0.8)

Color

font_color

Color(0.875, 0.875, 0.875, 1)

Color

font_outline_color

Color(0, 0, 0, 1)

Color

font_placeholder_color

Color(0.875, 0.875, 0.875, 0.6)

Color

font_readonly_color

Color(0.875, 0.875, 0.875, 0.5)

Color

font_selected_color

Color(0, 0, 0, 0)

Color

search_result_border_color

Color(0.3, 0.3, 0.3, 0.4)

Color

search_result_color

Color(0.3, 0.3, 0.3, 1)

Color

selection_color

Color(0.5, 0.5, 0.5, 1)

Color

word_highlighted_color

Color(0.5, 0.5, 0.5, 0.25)

int

caret_width

1

int

line_spacing

4

int

outline_size

0

Font

font

int

font_size

Texture2D

space

Texture2D

tab

StyleBox

focus

StyleBox

normal

StyleBox

read_only


Сигнали

caret_changed() 🔗

Випробувано, коли будь-яка позиція змін.


gutter_added() 🔗

При додаванні жолобу.


gutter_clicked(line: int, gutter: int) 🔗

Увімкніть, коли натискається жолоб.


gutter_removed() 🔗

Випробувано при видаленні жолобу.


lines_edited_from(from_line: int, to_line: int) 🔗

Відправляється відразу при зміні тексту.

Коли текст додано from_line буде менше to_line. При видаленні to_line буде менше from_line.


text_changed() 🔗

Випробувано при зміні тексту.


text_set() 🔗

Викликається, коли викликається метод clear() або встановлюється текст члена text.


Переліки

enum MenuItems: 🔗

MenuItems MENU_CUT = 0

Вирізи (копії та очищення) вибраного тексту.

MenuItems MENU_COPY = 1

Скопіює вибраний текст.

MenuItems MENU_PASTE = 2

Вставте текст буфера над вибраним текстом (або на позицію курсора).

MenuItems MENU_CLEAR = 3

Видаляє весь текст TextEdit.

MenuItems MENU_SELECT_ALL = 4

Виберіть текст TextEdit.

MenuItems MENU_UNDO = 5

Не додає попередньої дії.

MenuItems MENU_REDO = 6

Почервоні дії.

MenuItems MENU_SUBMENU_TEXT_DIR = 7

Ідентифікатор субменю «Текстна записка».

MenuItems MENU_DIR_INHERITED = 8

Налаштовує текстовий напрямок у спадок.

MenuItems MENU_DIR_AUTO = 9

Налаштування текстового напрямку до автоматичного.

MenuItems MENU_DIR_LTR = 10

Встановлює напрямок тексту на ліву сторону.

MenuItems MENU_DIR_RTL = 11

Налаштовує текстовий напрямок до правого вліво.

MenuItems MENU_DISPLAY_UCC = 12

Вмикає/вимикає відображення керівних символів.

MenuItems MENU_SUBMENU_INSERT_UCC = 13

Ідентифікатор підменю «Вставити керуючий символ».

MenuItems MENU_INSERT_LRM = 14

Вставте ліву позначку (LRM).

MenuItems MENU_INSERT_RLM = 15

Вставки правого вліво позначки (RLM) характер.

MenuItems MENU_INSERT_LRE = 16

Вставки старту ліворучного тиснення (LRE) символу.

MenuItems MENU_INSERT_RLE = 17

Вставки стартують право-лівий тиснення (RLE) символу.

MenuItems MENU_INSERT_LRO = 18

Вставки старту ліворучного наднаряддя (LRO) персонажа.

MenuItems MENU_INSERT_RLO = 19

Вставки стартують право-лівий надряддя (RLO) символ.

MenuItems MENU_INSERT_PDF = 20

Вставки форматування поштового напрямку (PDF) символ.

MenuItems MENU_INSERT_ALM = 21

Вставки арабської марки літери (ALM).

MenuItems MENU_INSERT_LRI = 22

Вставки ліворучного ізоляту (LRI).

MenuItems MENU_INSERT_RLI = 23

Вставте правий-лівий ізолят (RLI) символ.

MenuItems MENU_INSERT_FSI = 24

Вставляє перший символ строгого ізоляту (FSI).

MenuItems MENU_INSERT_PDI = 25

Вставляє символ ізоляції напрямку виштовхування (PDI).

MenuItems MENU_INSERT_ZWJ = 26

Вставте нульову ширину стикувача (ZWJ) характер.

MenuItems MENU_INSERT_ZWNJ = 27

Вставляє символ нульової ширини, що не з'єднує елементи (ZWNJ).

MenuItems MENU_INSERT_WJ = 28

Вставте слово-приєднувач (WJ) символ.

MenuItems MENU_INSERT_SHY = 29

Вставки м'якого фена (ШІ) характеру.

MenuItems MENU_EMOJI_AND_SYMBOL = 30

Відкриває системний засіб вибору смайлів і символів.

MenuItems MENU_MAX = 31

Представляємо розмір MenuItems enum.


enum EditAction: 🔗

EditAction ACTION_NONE = 0

Немає поточного дії.

EditAction ACTION_TYPING = 1

Типова дія.

EditAction ACTION_BACKSPACE = 2

Спинки видалення дії.

EditAction ACTION_DELETE = 3

Видаліть дію.


enum SearchFlags: 🔗

SearchFlags SEARCH_MATCH_CASE = 1

У разі пошуку матчу.

SearchFlags SEARCH_WHOLE_WORDS = 2

Познайомитись з усіма словами при пошуку.

SearchFlags SEARCH_BACKWARDS = 4

Пошук з кінця до початку.


enum CaretType: 🔗

CaretType CARET_TYPE_LINE = 0

Вертикальний догляд за лініями.

CaretType CARET_TYPE_BLOCK = 1

Блок догляду.


enum SelectionMode: 🔗

SelectionMode SELECTION_MODE_NONE = 0

Не вибираючи.

SelectionMode SELECTION_MODE_SHIFT = 1

Виберіть, якщо `` Shift`` притискається.

SelectionMode SELECTION_MODE_POINTER = 2

Виберіть одиничні символи, якщо користувач один клікнув.

SelectionMode SELECTION_MODE_WORD = 3

Виберіть цілі слова, якщо користувач двічі клацнув.

SelectionMode SELECTION_MODE_LINE = 4

Виберіть цілі лінії, якщо користувач потрійний клікнув.


enum LineWrappingMode: 🔗

LineWrappingMode LINE_WRAPPING_NONE = 0

Лінія обгортання вимкнена.

LineWrappingMode LINE_WRAPPING_BOUNDARY = 1

Лінія обгортання відбувається на межі контролю, за яким зазвичай буде видно.


enum GutterType: 🔗

GutterType GUTTER_TYPE_STRING = 0

Після того, як Gutter встановлюється рядок за допомогою set_gutter_type(), він використовується для зберігання тексту за допомогою методу set_line_gutter_text().

GutterType GUTTER_TYPE_ICON = 1

При накладанні іконки за допомогою set_gutter_type() використовується для того, щоб мати іконку, встановлену за допомогою методу set_line_gutter_icon().

GutterType GUTTER_TYPE_CUSTOM = 2

При налаштуванні на замовлення використовується set_gutter_type(), він використовується, щоб містити індивідуальні візуальні зображення, керовані методом зворотного виклику, встановленим методом set_gutter_custom_draw().


Описи властивостей

AutowrapMode autowrap_mode = 3 🔗

Якщо для параметра wrap_mode встановлено значення LINE_WRAPPING_BOUNDARY, встановлюється режим перенесення тексту.


bool backspace_deletes_composite_character_enabled = false 🔗

  • void set_backspace_deletes_composite_character_enabled(value: bool)

  • bool is_backspace_deletes_composite_character_enabled()

Якщо true та caret_mid_grapheme має значення false, клавіша Backspace видаляє цілий складений символ, наприклад ❤️‍🩹, а не частину складеного символу.


  • void set_caret_blink_enabled(value: bool)

  • bool is_caret_blink_enabled()

Якщо true, робить догляд за посиланням.


  • void set_caret_blink_interval(value: float)

  • float get_caret_blink_interval()

Проміжок, в якому доглядаються посилання (в секундах).


bool caret_draw_when_editable_disabled = false 🔗

  • void set_draw_caret_when_editable_disabled(value: bool)

  • bool is_drawing_caret_when_editable_disabled()

Якщо true, догляд буде видно, коли editable вимкнено.


bool caret_mid_grapheme = false 🔗

  • void set_caret_mid_grapheme_enabled(value: bool)

  • bool is_caret_mid_grapheme_enabled()

Дозволити рухомий догляд, вибрати і видалити окремі компоненти композитного характеру.

Примітка: Backspace завжди видаляє окремі компоненти композитного характеру.


bool caret_move_on_right_click = true 🔗

  • void set_move_caret_on_right_click_enabled(value: bool)

  • bool is_move_caret_on_right_click_enabled()

Якщо true, клацніть правою кнопкою миші переходить на позицію мишки перед відображенням контекстного меню.

Якщо false, контекстне меню ігнорує розташування мишки.


bool caret_multiple = true 🔗

  • void set_multiple_carets_enabled(value: bool)

  • bool is_multiple_carets_enabled()

Якщо true, дозволено використовувати кілька кареток. Клацання лівою кнопкою миші з утримуванням клавіші Alt додає нову каретку. Див. add_caret() та get_caret_count().


CaretType caret_type = 0 🔗

Встановити тип догляду за ящиком.


bool context_menu_enabled = true 🔗

  • void set_context_menu_enabled(value: bool)

  • bool is_context_menu_enabled()

Якщо true, клацніть правою кнопкою миші відображає контекстне меню.


String custom_word_separators = "" 🔗

  • void set_custom_word_separators(value: String)

  • String get_custom_word_separators()

Символи, які слід розглядати як роздільники слів, якщо use_custom_word_separators має значення true. Символи слід визначати без роздільників, наприклад, #_!.


bool deselect_on_focus_loss_enabled = true 🔗

  • void set_deselect_on_focus_loss_enabled(value: bool)

  • bool is_deselect_on_focus_loss_enabled()

Якщо true, вибраний текст буде вилучено, коли фокус втрачено.


bool drag_and_drop_selection_enabled = true 🔗

  • void set_drag_and_drop_selection_enabled(value: bool)

  • bool is_drag_and_drop_selection_enabled()

Якщо true, дайте перетягування вибраного тексту. Текст ще можна кинути з інших джерел.


bool draw_control_chars = false 🔗

  • void set_draw_control_chars(value: bool)

  • bool get_draw_control_chars()

Якщо true, відображаються символи керування.


bool draw_spaces = false 🔗

  • void set_draw_spaces(value: bool)

  • bool is_drawing_spaces()

Якщо true, символ «простору» буде мати видиме уявлення.


bool draw_tabs = false 🔗

  • void set_draw_tabs(value: bool)

  • bool is_drawing_tabs()

Якщо true, характер "tab" буде мати видиме уявлення.


bool editable = true 🔗

  • void set_editable(value: bool)

  • bool is_editable()

Якщо false, існуючий текст не може бути змінений і новий текст не можна додавати.


bool emoji_menu_enabled = true 🔗

  • void set_emoji_menu_enabled(value: bool)

  • bool is_emoji_menu_enabled()

Якщо true, меню «Емодзі та символи» ввімкнено.


bool empty_selection_clipboard_enabled = true 🔗

  • void set_empty_selection_clipboard_enabled(value: bool)

  • bool is_empty_selection_clipboard_enabled()

Якщо true, копіювання або вирізання без виділення виконується для всіх рядків із кареткою. В іншому випадку копіювання та вирізання потребують виділення.


bool highlight_all_occurrences = false 🔗

  • void set_highlight_all_occurrences(value: bool)

  • bool is_highlight_all_occurrences_enabled()

Якщо true, всі події вибраного тексту будуть виділені.


bool highlight_current_line = false 🔗

  • void set_highlight_current_line(value: bool)

  • bool is_highlight_current_line_enabled()

Якщо true виділяється лінія, що містить курсор.


bool indent_wrapped_lines = false 🔗

  • void set_indent_wrapped_lines(value: bool)

  • bool is_indent_wrapped_lines()

Якщо true, усі перенесені рядки мають такий самий відступ, як і розгорнутий рядок.


String language = "" 🔗

Код мови, який використовується для розриву рядків і алгоритмів формування тексту, якщо залишити пустим, замість нього використовується поточна мова.


bool middle_mouse_paste_enabled = true 🔗

  • void set_middle_mouse_paste_enabled(value: bool)

  • bool is_middle_mouse_paste_enabled()

Якщо false, використовуючи середню кнопку миші, щоб записувати буфер буде вимкнено.

Примітка: Цей метод реалізується тільки на Linux.


bool minimap_draw = false 🔗

  • void set_draw_minimap(value: bool)

  • bool is_drawing_minimap()

Якщо true, показано міні-карту, надаючи контур коду джерела. Мінімакс використовує фіксований розмір тексту.


int minimap_width = 80 🔗

  • void set_minimap_width(value: int)

  • int get_minimap_width()

Ширина, в пікселях, з мінікарти.


String placeholder_text = "" 🔗

  • void set_placeholder(value: String)

  • String get_placeholder()

Текст, що відображається, коли TextEdit порожній. Це не значення за замовчуванням TextEdit (див. text).


bool scroll_fit_content_height = false 🔗

  • void set_fit_content_height_enabled(value: bool)

  • bool is_fit_content_height_enabled()

Якщо true, TextEdit вимкне вертикальне прокручування та підбере мінімальну висоту до кількості видимих рядків. Якщо і ця властивість, і scroll_fit_content_width мають значення true, смуги прокручування не відображатимуться.


bool scroll_fit_content_width = false 🔗

  • void set_fit_content_width_enabled(value: bool)

  • bool is_fit_content_width_enabled()

Якщо true, TextEdit вимкне горизонтальне прокручування та підбере мінімальну ширину до найширшого рядка в тексті. Якщо і ця властивість, і scroll_fit_content_height мають значення true, смуги прокручування не відображатимуться.


int scroll_horizontal = 0 🔗

  • void set_h_scroll(value: int)

  • int get_h_scroll()

Якщо є горизонтальна прокрутка, це визначає поточний горизонтальний значення прокрутки у пікселях.


bool scroll_past_end_of_file = false 🔗

  • void set_scroll_past_end_of_file_enabled(value: bool)

  • bool is_scroll_past_end_of_file_enabled()

Дозволити прокручування останнього рядка в «віртуальний» простір.


bool scroll_smooth = false 🔗

  • void set_smooth_scroll_enabled(value: bool)

  • bool is_smooth_scroll_enabled()

Прокрутка плавно над текстом, а не стрибаючи на наступне місце.


float scroll_v_scroll_speed = 80.0 🔗

  • void set_v_scroll_speed(value: float)

  • float get_v_scroll_speed()

Встановлює швидкість прокручування з міні-картою або коли ввімкнено scroll_smooth.


float scroll_vertical = 0.0 🔗

  • void set_v_scroll(value: float)

  • float get_v_scroll()

Якщо є вертикальна прокрутка, це визначає поточний вертикальний значення прокрутки в рядках, починаючи від 0 до верхньої лінії.


bool selecting_enabled = true 🔗

  • void set_selecting_enabled(value: bool)

  • bool is_selecting_enabled()

Якщо true, текст можна вибрати.

Якщо false, текст не може бути вибраний користувачем або методами select() чи select_all().


bool shortcut_keys_enabled = true 🔗

  • void set_shortcut_keys_enabled(value: bool)

  • bool is_shortcut_keys_enabled()

Якщо true, увімкнено комбінації клавіш для контекстного меню, навіть якщо контекстне меню вимкнено.


StructuredTextParser structured_text_bidi_override = 0 🔗

Настроювання алгоритму BiDi для структурованого тексту.


Array structured_text_bidi_override_options = [] 🔗

  • void set_structured_text_bidi_override_options(value: Array)

  • Array get_structured_text_bidi_override_options()

Налаштуйте додаткові параметри для перенади BiDi.


SyntaxHighlighter syntax_highlighter 🔗

Підсвічування синтаксису для використання.

Примітка: Екземпляр SyntaxHighlighter не слід використовувати в кількох вузлах TextEdit.


bool tab_input_mode = true 🔗

  • void set_tab_input_mode(value: bool)

  • bool get_tab_input_mode()

Якщо true, ProjectSettings.input/ui_text_indent вводить символ Tab, інакше фокус клавіатури переміщується на наступний Control у сцені.


String text = "" 🔗

String значення TextEdit.


TextDirection text_direction = 0 🔗

Основний напрямок написання тексту.


bool use_custom_word_separators = false 🔗

  • void set_use_custom_word_separators(value: bool)

  • bool is_custom_word_separators_enabled()

Якщо false, використання прив’язок Ctrl + Left або Ctrl + Right (Cmd + Left або Cmd + Right на macOS) використовуватиме поведінку use_default_word_separators. Якщо true, каретка також зупиниться, якщо буде виявлено символ у межах custom_word_separators. Корисно для переміщення підслів. Ця поведінка також буде застосована до поведінки виділення тексту.


bool use_default_word_separators = true 🔗

  • void set_use_default_word_separators(value: bool)

  • bool is_default_word_separators_enabled()

Якщо false, використовуючи Ctrl + лівий або Ctrl + Право (Cmd + лівий або Cmd + Право на macOS) обов'язки зупиниться на рухомому догляді тільки при виявленні місця або пунктуації. Якщо true, він також зупинить догляд, якщо символ є частиною !"#$%&'()*+,-./:;<=>?@[\]^`{}}}~, Унікод загальний пульсаційний стіл, або Унікод CJK Пунктуація таблиці. Корисно для переміщення під словом. Ця поведінка також буде застосована до поведінки тексту.


bool virtual_keyboard_enabled = true 🔗

  • void set_virtual_keyboard_enabled(value: bool)

  • bool is_virtual_keyboard_enabled()

Якщо значення true, рідна віртуальна клавіатура ввімкнена на платформах, які її підтримують.


bool virtual_keyboard_show_on_focus = true 🔗

  • void set_virtual_keyboard_show_on_focus(value: bool)

  • bool get_virtual_keyboard_show_on_focus()

Якщо значення true, рідна віртуальна клавіатура відображається під час подій focus на платформах, які її підтримують.


LineWrappingMode wrap_mode = 0 🔗

Налаштування режиму обгортання лінії для використання.


Описи методів

void _backspace(caret_index: int) virtual 🔗

Зазначте цей метод, щоб визначити, що відбувається, коли користувач натискає ключ задньої частини.


void _copy(caret_index: int) virtual 🔗

Зазначте цей метод, щоб визначити, що відбувається, коли користувач виконує функцію копіювання.


void _cut(caret_index: int) virtual 🔗

Зазначте цей метод, щоб визначити, що відбувається, коли користувач виконує роботу зрізу.


void _handle_unicode_input(unicode_char: int, caret_index: int) virtual 🔗

Зазначте цей метод, щоб визначити, що відбувається при типах користувача у заданому ключі unicode_char.


void _paste(caret_index: int) virtual 🔗

Зазначте цей метод, щоб визначити, що відбувається, коли користувач виконує роботу паста.


void _paste_primary_clipboard(caret_index: int) virtual 🔗

Визначте цей метод, щоб визначити, що відбувається, коли користувач виконує роботу паста з кнопкою миші.

Примітка: Цей метод реалізований тільки на Linux.


int add_caret(line: int, column: int) 🔗

Додає новий догляд за місцезнаходженням. Повертає індекс нового догляду, або -1, якщо розташування недійсне.


void add_caret_at_carets(below: bool) 🔗

Додайте додатковий догляд над собою або нижче кожного догляду. Якщо below є true новий догляд буде додано нижче і вище.


void add_gutter(at: int = -1) 🔗

Зареєструвати новий Gutter до цього TextEdit. Використовуйте at, щоб мати конкретне замовлення. Вартість -1 додає жолоб праворуч.


void add_selection_for_next_occurrence() 🔗

Додає підбір і догляд за наступним виникненням поточного вибору. Якщо немає активного вибору, вибирає слово під опікою.


void adjust_carets_after_edit(caret: int, from_line: int, from_col: int, to_line: int, to_col: int) 🔗

Застаріло: No longer necessary since methods now adjust carets themselves.

Цей метод нічого не робить.


void adjust_viewport_to_caret(caret_index: int = 0) 🔗

Налаштуйте зовнішній вигляд, щоб догляд був видимим.


void apply_ime() 🔗

Застосувати текст з Input Method Editor (IME) до кожного піклування та закриває IME, якщо він відкритий.


void backspace(caret_index: int = -1) 🔗

Викликається, коли користувач натискає клавішу Backspace. Можна перезаписати за допомогою _backspace().


void begin_complex_operation() 🔗

Стартує багатоканальне редагування. Всі редагування будуть розглядатися як одна дія, доки метод_комплекс_операция.


void begin_multicaret_edit() 🔗

Початок редагування для кількох вставок. Редагування має бути завершено за допомогою end_multicaret_edit(). Редагування з кількома вставками можна використовувати для редагування тексту в кількох вставках і відкладати об’єднання вставок до кінця, тому індекси вставки не впливатимуть негайно. begin_multicaret_edit() і end_multicaret_edit() можуть бути вкладеними, і об’єднання відбудеться в останньому end_multicaret_edit().

begin_complex_operation()
begin_multicaret_edit()
for i in range (get_caret_count()):
    if multicaret_edit_ignore_caret(i):
        continue
    # Тут логіка.
end_multicaret_edit()
end_complex_operation()

void cancel_ime() 🔗

Закрити ` Вхід Редактор метода <https://en.wikipedia.org/wiki/Input_method>`__ (IME) якщо він відкритий. Будь-який текст в IME буде втрачено.


void center_viewport_to_caret(caret_index: int = 0) 🔗

Центри перегляду портів на рядку знаходиться догляд за редагуванням. 0.


void clear() 🔗

Виконує повне скидання TextEdit, в тому числі історії відмови.


void clear_undo_history() 🔗

Прозора історія.


void collapse_carets(from_line: int, from_column: int, to_line: int, to_column: int, inclusive: bool = false) 🔗

Згорнути всі каретки в заданому діапазоні до позицій from_line та from_column.

inclusive застосовується до обох кінців.

Якщо is_in_mulitcaret_edit() має значення true, згорнуті каретки будуть мати значення true для multicaret_edit_ignore_caret().

merge_overlapping_carets() буде викликано, якщо будь-які каретки були згорнуті.


void copy(caret_index: int = -1) 🔗

Копіює поточний вибір тексту. Можна перезаписати за допомогою _copy().


void cut(caret_index: int = -1) 🔗

Вирізати – це поточний вибір. Можна перевизначити за допомогою _cut().


void delete_selection(caret_index: int = -1) 🔗

Видалення вибраного тексту.


void deselect(caret_index: int = -1) 🔗

Віддає поточний вибір.


void end_action() 🔗

Позначає кінець кроків у поточній дії, з якої розпочато start_action().


void end_complex_operation() 🔗

Завершує багаточастинне редагування, розпочате методом begin_complex_operation(). Якщо викликається поза складною операцією, поточна операція поміщається в стек скасування/повторення.


void end_multicaret_edit() 🔗

Завершує редагування кількох кареток, розпочате за допомогою begin_multicaret_edit(). Якщо це був останній виклик методу end_multicaret_edit() і merge_overlapping_carets(), каретки будуть об'єднані.


int get_caret_column(caret_index: int = 0) const 🔗

Повертаємо стовпець, що доглядає за редагуванням.


int get_caret_count() const 🔗

Повертаємо кількість кареток в цьому TextEdit.


Vector2 get_caret_draw_pos(caret_index: int = 0) const 🔗

Повертає позицію на піксельний піксель.


PackedInt32Array get_caret_index_edit_order() 🔗

Застаріло: Carets no longer need to be edited in any specific order. If the carets need to be sorted, use get_sorted_carets() instead.

Повертаємо список індексів догляду за ними в порядку редагування, це зроблено знизу до вершини. Редагування замовлення відноситься до дій, таких як insert_text_at_caret().


int get_caret_line(caret_index: int = 0) const 🔗

Повертаємо лінійку, яка доглядає за редагуванням.


int get_caret_wrap_index(caret_index: int = 0) const 🔗

Повертаємо індекс обгортання, на якому знаходиться догляд за редагування.


int get_first_non_whitespace_column(line: int) const 🔗

Повертає перший стовпець, що містить непробільний символ у заданому рядку. Якщо є лише пробіли, повертає кількість символів.


int get_first_visible_line() const 🔗

Повертаємо перший видимий рядок.


int get_gutter_count() const 🔗

Повертаємо кількість метеликів, зареєстрованих.


String get_gutter_name(gutter: int) const 🔗

Повертає ім'я жолобу на вказаний індекс.


GutterType get_gutter_type(gutter: int) const 🔗

Повертає тип жолоба за заданим індексом. Жолоби можуть містити значки, текст або власні візуальні елементи.


int get_gutter_width(gutter: int) const 🔗

Повертає ширину жолобу на заданому індексі.


HScrollBar get_h_scroll_bar() const 🔗

Повернення HScrollBar, що використовується TextEdit.


int get_indent_level(line: int) const 🔗

Повертає рівень відступу заданого рядка. Це кількість пробілів і знаків табуляції на початку рядка з урахуванням розміру табуляції (див. get_tab_size()).


int get_last_full_visible_line() const 🔗

Повертаємо останню видиму лінію. Використовуйте get_last_full_pic_line_wrap_index() для індексу обгортання.


int get_last_full_visible_line_wrap_index() const 🔗

Повернення останнього видимого індексу обгортання останнього видимого рядка.


int get_last_unhidden_line() const 🔗

Повертає останній неприхований рядок у всьому TextEdit.


String get_line(line: int) const 🔗

Повертає текст конкретної лінії.


Color get_line_background_color(line: int) const 🔗

Повертає настроюваний колір фону заданого рядка. Якщо колір не встановлено, повертає Колір(0, 0, 0, 0).


Vector2i get_line_column_at_pos(position: Vector2i, clamp_line: bool = true, clamp_column: bool = true) const 🔗

Повертає рядок і стовпець у вказаній позиції. У повернутому векторі x — стовпець, а y — рядок.

Якщо clamp_line має значення false і position знаходиться під останнім рядком, повертається Vector2i(-1, -1).

Якщо clamp_column має значення false і position знаходиться за межами діапазону стовпців рядка, повертається Vector2i(-1, -1).


int get_line_count() const 🔗

Повертаємо кількість рядків у тексті.


Texture2D get_line_gutter_icon(line: int, gutter: int) const 🔗

Повертає піктограму, яка наразі знаходиться в gutter за адресою line. Це працює лише тоді, коли тип жолоба — GUTTER_TYPE_ICON (див. set_gutter_type()).


Color get_line_gutter_item_color(line: int, gutter: int) const 🔗

Повертає поточний колір у gutter на line.


Variant get_line_gutter_metadata(line: int, gutter: int) const 🔗

Повертає поточні метадані в gutter на line.


String get_line_gutter_text(line: int, gutter: int) const 🔗

Повертаємо текст, вказаний в gutter на line. Це тільки працює, коли тип жолобу GUTTER_TYPE_STRING (див. set_gutter_type().


int get_line_height() const 🔗

Повертає максимальне значення висоти лінії серед всіх ліній.

Примітка: Вартість повернення залежить від line_spacing та font_size. І не буде менше 1.


Array[Vector2i] get_line_ranges_from_carets(only_selections: bool = false, merge_adjacent: bool = true) const 🔗

x - перша лінія і y - остання лінія. Всі лінії в цих діапазонах будуть доглядати за ними або бути частиною вибору. Кожна лінія буде тільки частиною одного діапазону ліній, навіть якщо вона має кілька ящиків на ньому.

Якщо кінцевий стовпчик вибору (get_selection_to_column()) знаходиться в колонці 0, що лінія не буде включена. Якщо вибір починається на лінії після чергового вибору закінчується і merge_adjacent є true, або вони починаються і закінчуються на одній лінії, один діапазон лінії буде включати обидва підбори.


int get_line_width(line: int, wrap_index: int = -1) const 🔗

Повертає ширину пікселів wrap_index на line.


String get_line_with_ime(line: int) const 🔗

Повертає текстовий рядок у тому вигляді, у якому він відображається на даний момент, включаючи рядок композиції IME.


int get_line_wrap_count(line: int) const 🔗

Повертаємо кількість разів задана лінія загортається.


int get_line_wrap_index_at_column(line: int, column: int) const 🔗

Повертає індекс обтікання заданого стовпця в заданому рядку. Це коливається від 0 до get_line_wrap_count().


PackedStringArray get_line_wrapped_text(line: int) const 🔗

Повертає масив String, що представляє кожний індекс.


Vector2 get_local_mouse_pos() const 🔗

Повертає положення локальної мишки, що регулюється для текстового напрямку.


PopupMenu get_menu() const 🔗

Повертає PopupMenu цього TextEdit. За замовчуванням це меню відображається, якщо клацнути правою кнопкою миші на TextEdit.

Ви можете додати власні пункти меню або видалити стандартні. Переконайтеся, що ваші ідентифікатори не конфліктують зі стандартними (див. MenuItems). Наприклад:

func _ready():
    var menu = get_menu()
    # Видалити всі елементи після "Повторити".
    menu.item_count = menu.get_item_index(MENU_REDO) + 1
    # Додайте спеціальні елементи.
    menu.add_separator()
    menu.add_item("Вставити дату", MENU_MAX + 1)
    # Підключити зворотній дзвінок.
    menu.id_pressed.connect(_on_item_pressed)

func _on_item_pressed(id):
    if id == MENU_MAX + 1:
        insert_text_at_caret(Time.get_date_string_from_system())

Попередження: Це обов’язковий внутрішній вузол, його видалення та звільнення може призвести до збою. Якщо ви бажаєте приховати його чи будь-який із його дочірніх елементів, скористайтеся властивістю Window.visible.


int get_minimap_line_at_pos(position: Vector2i) const 🔗

Повертає еквівалентний рядок мінікарти за адресою position.


int get_minimap_visible_lines() const 🔗

Повертаємо кількість рядків, які можуть намальовуватися на minimap.


int get_next_composite_character_column(line: int, column: int) const 🔗

Повертає правильний стовпець у кінці складеного символу, наприклад, ❤️‍🩹 (загоєння серця; Unicode: U+2764 U+FE0F U+200D U+1FA79), який складається з більш ніж однієї кодової точки Unicode, якщо каретка знаходиться на початку складеного символу. Також повертає правильний стовпець з кареткою посередині графеми та для нескладених символів.

Примітка: Щоб перевірити розташування каретки, використовуйте get_next_composite_character_column(get_caret_line(), get_caret_column())


Vector2i get_next_visible_line_index_offset_from(line: int, wrap_index: int, visible_amount: int) const 🔗

Подібно до get_next_dis_line_offset_from(), але враховує індекси обгортання рядків. У зворотному векторі x є лінія, y є індексом обгортання.


int get_next_visible_line_offset_from(line: int, visible_amount: int) const 🔗

Повертаємо кількість до наступного видимого рядка з line до line + visible_amount. Також можна відрахувати задні. Наприклад, якщо TextEdit має 5 ліній з лініями 2 і 3 приховані, зателефонувавши до line = 1, видимий_amount = 1 повернеться 3. У.


Vector2i get_pos_at_line_column(line: int, column: int) const 🔗

Повертає локальну позицію на задану line та column. Якщо x або y повернутого вектора рівні -1, позиція поза видимою зоною управління.

Примітка: Позиція Y відповідає нижній стороні лінії. Використовуйте get_rect_at_line_column(), щоб отримати позицію верхньої сторони.


int get_previous_composite_character_column(line: int, column: int) const 🔗

Повертає правильний стовпець на початку складеного символу, наприклад, ❤️‍🩹 (загоєння серця; Unicode: U+2764 U+FE0F U+200D U+1FA79), який складається з більш ніж однієї кодової точки Unicode, якщо каретка знаходиться в кінці складеного символу. Також повертає правильний стовпець з кареткою посередині графеми та для нескладених символів.

Примітка: Щоб перевірити розташування каретки, використовуйте get_previous_composite_character_column(get_caret_line(), get_caret_column())


Rect2i get_rect_at_line_column(line: int, column: int) const 🔗

Повертає локальну позицію та розмір графему на даній line та column. Якщо x або y позиція повернутого пряма -1, позиція поза видимою зоною управління.

Примітка: Позиція повернутого пункту відповідає верхній стороні лінії, на відміну від get_pos_at_line_column(), яка повертає нижній стороні.


int get_saved_version() const 🔗

Повертає останні позначені збережені версії з tag_saved_version().


float get_scroll_pos_for_line(line: int, wrap_index: int = 0) const 🔗

Повертає позицію прокрутки для wrap_index line.


String get_selected_text(caret_index: int = -1) 🔗

Повертаємо текст, що знаходиться в підборі, або всі крити, якщо caret_index є його значення за замовчуванням -1.


int get_selection_at_line_column(line: int, column: int, include_edges: bool = true, only_selections: bool = true) const 🔗

Повернення індексу догляду за наданою line і column, або -1, якщо немає.

Якщо include_edges є false, позиція повинна бути всередині вибору і не в кінці. Якщо only_selections false, carets без вибору також буде розглянуто.


int get_selection_column(caret_index: int = 0) const 🔗

Застаріло: Use get_selection_origin_column() instead.

Повертає оригінальний стартовий стовпчик вибору.


int get_selection_from_column(caret_index: int = 0) const 🔗

Повертаємо вибраний стовпчик. Повертає стовпчик, якщо немає вибору.


int get_selection_from_line(caret_index: int = 0) const 🔗

Повертає рядок вибору. Повернути лінію догляду, якщо немає вибору.


int get_selection_line(caret_index: int = 0) const 🔗

Застаріло: Use get_selection_origin_line() instead.

Повертає початкову лінію вибору.


SelectionMode get_selection_mode() const 🔗

Повертає поточний режим вибору.


int get_selection_origin_column(caret_index: int = 0) const 🔗

Повертає стовпець походження вибору. Це протилежний кінець від турботи.


int get_selection_origin_line(caret_index: int = 0) const 🔗

Повертає лінію походження вибору. Це протилежний кінець від турботи.


int get_selection_to_column(caret_index: int = 0) const 🔗

Повертає кінець вибору стовпця. Повертає стовпчик, якщо немає вибору.


int get_selection_to_line(caret_index: int = 0) const 🔗

Повернути рядок вибору. Повернути лінію догляду, якщо немає вибору.


PackedInt32Array get_sorted_carets(include_ignored_carets: bool = false) const 🔗

Повертаємо карети, що сортуються підбіркою, починаючи з нижньої лінії і стовпця до найвищої (зверху донизу тексту).

Якщо включають_ignored_carets false, карети з multicaret_edit_ignore_caret() будуть ігноруватися.


int get_tab_size() const 🔗

Повертає розмір вкладки TextEdit.


int get_total_gutter_width() const 🔗

Повертаємо загальну ширину всіх жолобів і внутрішніх наповнювачів.


int get_total_visible_line_count() const 🔗

Повертає загальну кількість рядків у тексті. Це включає перенесені рядки та виключає зігнуті. Якщо wrap_mode встановлено на LINE_WRAPPING_NONE і жодні рядки не зігнуті (див. CodeEdit.is_line_folded()), то це еквівалентно get_line_count(). Див. get_visible_line_count_in_range() для обмеженого діапазону рядків.


VScrollBar get_v_scroll_bar() const 🔗

Повернення VScrollBar TextEdit.


int get_version() const 🔗

Повертає поточну версію TextEdit. Редакція - це кількість записаних операцій з андо/червоною історією.


int get_visible_line_count() const 🔗

Повертає кількість рядків, які можна візуально помістити, округлену вниз, на основі висоти цього елемента керування.


int get_visible_line_count_in_range(from_line: int, to_line: int) const 🔗

Повертає загальну кількість рядків між from_line і to_line (включно) у тексті. Сюди входять переплетені лінії та виключаються складені лінії. Якщо діапазон охоплює всі рядки, це еквівалентно get_total_visible_line_count().


String get_word_at_pos(position: Vector2) const 🔗

Повертає слово в position.


String get_word_under_caret(caret_index: int = -1) const 🔗

Повернення тексту String з словом під розташуванням опіки.


bool has_ime_text() const 🔗

Повертає true, якщо користувач має текст у Input Method Editor (IME).


bool has_redo() const 🔗

Повертаємо true, якщо доступна акція "redo".


bool has_selection(caret_index: int = -1) const 🔗

Повертає true, якщо користувач вибрав текст.


bool has_undo() const 🔗

Повертаємо true, якщо доступна акція "undo".


void insert_line_at(line: int, text: String) 🔗

Вставте нову лінію з text в line.


void insert_text(text: String, line: int, column: int, before_selection_begin: bool = true, before_selection_end: bool = false) 🔗

Вставте текст text в line і string.

Якщо before_selection_begin є true, каретки і підбірки, які починаються на line і стовпець перейдуть до кінця вставленого тексту, разом з усіма каретками після нього.

Якщо before_selection_end є true, добірки, які закінчуються line і column будуть продовжені до кінця вставленого тексту. Ці параметри можуть бути використані для вставки тексту всередині або зовні підбірок.


void insert_text_at_caret(text: String, caret_index: int = -1) 🔗

Вставте зазначений текст на позицію догляду.


bool is_caret_after_selection_origin(caret_index: int = 0) const 🔗

Повертає true, якщо догляд за вибором після виходу. Це можна використовувати для визначення напрямку вибору.


bool is_caret_visible(caret_index: int = 0) const 🔗

Повертає true, якщо каретка видима, false інакше. Каретка вважатиметься прихованою, якщо вона знаходиться поза межами прокручуваної області, коли прокручування ввімкнено.

Примітка: is_caret_visible() не враховує те, що введення вказує поза екраном, якщо воно все ще знаходиться в області прокручування. Він поверне true, навіть якщо каретка знаходиться поза екраном, якщо вона відповідає власним умовам TextEdit щодо видимості. Це включає в себе використання scroll_fit_content_width і scroll_fit_content_height, які змушують TextEdit розширюватися за межі вікна перегляду.


bool is_dragging_cursor() const 🔗

Повертаємо true, якщо користувач перетягує мишу для прокручування, вибору або перетягування тексту.


bool is_gutter_clickable(gutter: int) const 🔗

Повертає true, якщо ринву за заданим індексом можна натиснути. Перегляньте set_gutter_clickable().


bool is_gutter_drawn(gutter: int) const 🔗

Повертає true, якщо жолоб за вказаним індексом наразі намальовано. Перегляньте set_gutter_draw().


bool is_gutter_overwritable(gutter: int) const 🔗

Повертає true, якщо порожнеча за вказаним індексом перезаписується. Перегляньте set_gutter_overwritable().


bool is_in_mulitcaret_edit() const 🔗

true if a start_multicaret_edit() був викликаний і end_multicaret_edit() ще не був викликаний.


bool is_line_gutter_clickable(line: int, gutter: int) const 🔗

Повертає true, якщо ліву лінію за вказаним індексом у заданому рядку можна натиснути. Перегляньте set_line_gutter_clickable().


bool is_line_wrapped(line: int) const 🔗

Повертаємо, якщо задана лінія загортається.


bool is_menu_visible() const 🔗

Повертає true, якщо меню видно. Використовуйте це замість get_menu().visible, щоб покращити продуктивність (щоб уникнути створення меню). Перегляньте get_menu().


bool is_mouse_over_selection(edges: bool, caret_index: int = -1) const 🔗

Повертає true, якщо вказівник миші наведено на виділення. Якщо edges має значення true, краї вважаються частиною вибору.


bool is_overtype_mode_enabled() const 🔗

Повертає true, якщо ввімкнено режим перетипу. Перегляньте set_overtype_mode_enabled().


void menu_option(option: int) 🔗

Виконує задану дію, як визначену в MenuItems enum.


void merge_gutters(from_line: int, to_line: int) 🔗

Об’єднайте жолоби від from_line до to_line. Буде скопійовано лише перезаписувані жолоби. Перегляньте set_gutter_overwritable().


void merge_overlapping_carets() 🔗

Злийте будь-які перекриття карети. На користь новітній догляд, або догляд за вибором.

Якщо is_in_mulitcaret_edit() є true, об'єднання буде черги, щоб статися в кінці багатокутного редагування. Подивитися begin_multicaret_edit() і End_multicaret_edit().

Примітка: Це не називається, коли позиція по догляду, але після певних дій, тому можна потрапити в стан, де перекриття карець.


bool multicaret_edit_ignore_caret(caret_index: int) const 🔗

Повертає true, якщо заданий caret_index слід ігнорувати як частину редагування кількох кареток. Див. begin_multicaret_edit() та end_multicaret_edit(). Каретки, які слід ігнорувати, це ті, що були частиною видаленого тексту та, ймовірно, будуть об'єднані в кінці редагування, або каретки, які були додані під час редагування.

Рекомендується продовжувати в межах циклу, що повторюється для кількох кареток, якщо каретку слід ігнорувати.


void paste(caret_index: int = -1) 🔗

Паста на поточному місці. Чи можна переїхати з _paste().


void paste_primary_clipboard(caret_index: int = -1) 🔗

Паста первинна буфера.


void redo() 🔗

Виконувати роботу червоної.


void remove_caret(caret: int) 🔗

Вилучає заданий індекс догляду.

Примітка: Це може призвести до коригування всіх інших показників догляду.


void remove_gutter(gutter: int) 🔗

Знімає жолоб за заданим індексом.


void remove_line_at(line: int, move_carets_down: bool = true) 🔗

Вилучає рядок тексту на line. Картки на цій лінії спробують відповідати їхньому попередньому візуальному положенні x.

Якщо switch_carets_down є true карети перемістяться в наступну лінію вниз, інакше карець буде рухатися вгору.


void remove_secondary_carets() 🔗

Видаліть всі додаткові карети.


void remove_text(from_line: int, from_column: int, to_line: int, to_column: int) 🔗

Видаліть текст між цими положеннями.


Виконайте пошук всередині тексту. Прапори пошуку можна вказати в переліку SearchFlags.

У повернутому векторі x — стовпець, y — рядок. Якщо результатів не знайдено, обидва дорівнюють -1.

var result = search("друк", SEARCH_WHOLE_WORDS, 0, 0)
if result.x != -1:
    # Результат знайдено.
    var line_number = result.y
    var column_number = result.x

void select(origin_line: int, origin_column: int, caret_line: int, caret_column: int, caret_index: int = 0) 🔗

Вибирає текст з origin_line та origin_column до caret_line та caret_column для заданого caret_index. Це переміщує початок координат вибору та каретку. Якщо позиції однакові, вибір буде скасовано.

Якщо selecting_enabled має значення false, вибір не відбудеться.

Примітка: Якщо підтримується кілька кареток, це не перевірятиме наявність перекриття. Див. merge_overlapping_carets().


void select_all() 🔗

Виберіть текст.

false, не відбудеться вибір.


void select_word_under_caret(caret_index: int = -1) 🔗

Вибирає слово під опікою.


void set_caret_column(column: int, adjust_viewport: bool = true, caret_index: int = 0) 🔗

Переміщує каретку до вказаного індексу column.

Якщо adjust_viewport має значення true, область перегляду буде центрована в позиції каретки після переміщення.

Примітка: Якщо підтримується кілька кареток, перевірка на перекриття не виконуватиметься. Див. merge_overlapping_carets().


void set_caret_line(line: int, adjust_viewport: bool = true, can_be_hidden: bool = true, wrap_index: int = 0, caret_index: int = 0) 🔗

Переміщує каретку до вказаного індексу line. Стовпець каретки буде переміщено до тієї ж візуальної позиції, що й під час останнього виклику методу set_caret_column, або затиснуто в кінці рядка.

Якщо adjust_viewport має значення true, область перегляду буде центрована на позиції каретки після переміщення.

Якщо can_be_hidden має значення true, вказаний line можна приховати.

Якщо wrap_index має значення -1, стовпець каретки буде затиснуто до довжини line. Якщо wrap_index більше за -1, стовпець буде переміщено, щоб спробувати зіставити візуальну позицію x на wrap_index рядка з позицією під час останнього виклику методу set_caret_column().

Примітка: Якщо підтримується кілька кареток, перевірка на перекриття не виконуватиметься. Див. merge_overlapping_carets().


void set_gutter_clickable(gutter: int, clickable: bool) 🔗

Якщо true, курсор миші зміниться на вказівну руку (Control.CURSOR_POINTING_HAND) під час наведення вказівника на жолоб у заданому індексі. Перегляньте is_gutter_clickable() і set_line_gutter_clickable().


void set_gutter_custom_draw(column: int, draw_callback: Callable) 🔗

Встановіть настроюваний зворотний виклик для жолоба за заданим індексом. draw_callback має приймати такі аргументи: індекс лінії int, індекс жолоба int і область Rect2. Цей зворотній виклик працює лише тоді, коли тип жолоба GUTTER_TYPE_CUSTOM (див. set_gutter_type()).


void set_gutter_draw(gutter: int, draw: bool) 🔗

Якщо true, то жолоб малюється за заданим індексом. Тип жолоба (set_gutter_type()) визначає, як він малюється. Див. is_gutter_drawn().


void set_gutter_name(gutter: int, name: String) 🔗

Встановлює назву жолоба за вказаним індексом.


void set_gutter_overwritable(gutter: int, overwritable: bool) 🔗

Якщо true, дані лінії жолоба за заданим індексом можна перезаписати при використанні merge_gutters(). Див. is_gutter_overwritable().


void set_gutter_type(gutter: int, type: GutterType) 🔗

Встановлює тип жолоба за заданим індексом. Жолоби можуть містити значки, текст або власні візуальні елементи.


void set_gutter_width(gutter: int, width: int) 🔗

Встановіть ширину жолоба за заданим індексом.


void set_line(line: int, new_text: String) 🔗

Встановлює текст для певного line.

Каретки на рядку намагатимуться зберегти свою візуальну позицію x.


void set_line_as_center_visible(line: int, wrap_index: int = 0) 🔗

Положення про wrap_index line в центрі переглядупорта.


void set_line_as_first_visible(line: int, wrap_index: int = 0) 🔗

Позиції wrap_index line у верхній частині порту.


void set_line_as_last_visible(line: int, wrap_index: int = 0) 🔗

Позиції wrap_index line в нижній частині порту.


void set_line_background_color(line: int, color: Color) 🔗

Встановлює настроюваний колір тла даного рядка. Якщо прозорий, цей колір застосовується поверх стандартного кольору фону (див. background_color). Якщо встановлено значення Color(0, 0, 0, 0), додатковий колір не застосовується.


void set_line_gutter_clickable(line: int, gutter: int, clickable: bool) 🔗

Якщо clickable має значення true, робить gutter на заданому line клікабельним. Це подібно до set_gutter_clickable(), але для одного рядка. Якщо is_gutter_clickable() має значення true, це не матиме жодного ефекту. Див. is_line_gutter_clickable() та gutter_clicked.


void set_line_gutter_icon(line: int, gutter: int, icon: Texture2D) 🔗

Встановлює значок для gutter у line на icon. Це працює лише тоді, коли тип жолоба — GUTTER_TYPE_ICON (див. set_gutter_type()).


void set_line_gutter_item_color(line: int, gutter: int, color: Color) 🔗

Встановлює колір для gutter на line на color.


void set_line_gutter_metadata(line: int, gutter: int, metadata: Variant) 🔗

Встановлює метадані для gutter на line на metadata.


void set_line_gutter_text(line: int, gutter: int, text: String) 🔗

Встановлює текст для gutter на line як text. Це працює лише тоді, коли тип жолоба має значення GUTTER_TYPE_STRING (див. set_gutter_type()).


void set_overtype_mode_enabled(enabled: bool) 🔗

Якщо true, вмикає режим перетипу. У цьому режимі введення замінює наявний текст замість вставки. Дія ProjectSettings.input/ui_text_toggle_insert_mode перемикає режим накладення. Перегляньте is_overtype_mode_enabled().


void set_search_flags(flags: int) 🔗

Встановлює прапорці пошуку flags. Використовується з методом set_search_text для виділення входжень шуканого тексту. Прапорці пошуку можна вказати з переліку SearchFlags.


void set_search_text(search_text: String) 🔗

Встановлює текст пошуку. Див. set_search_flags().


void set_selection_mode(mode: SelectionMode) 🔗

Встановлює поточний режим вибору.


void set_selection_origin_column(column: int, caret_index: int = 0) 🔗

Встановлює стовпець початку виділення на column для заданого caret_index. Якщо початок виділення перемістити на позицію каретки, виділення буде скасовано.


void set_selection_origin_line(line: int, can_be_hidden: bool = true, wrap_index: int = -1, caret_index: int = 0) 🔗

Встановлює лінію початку виділення на line для заданого caret_index. Якщо лінію початку виділення перемістити на позицію каретки, виділення буде скасовано.

Якщо can_be_hidden має значення false, лінію буде встановлено на найближчу неприховану лінію нижче або вище.

Якщо wrap_index має значення -1, стовпець початку виділення буде обмежуватися довжиною line. Якщо wrap_index більше за -1, стовпець буде переміщено, щоб спробувати зіставити візуальну позицію x на лінії wrap_index з позицією з моменту останнього виклику методу set_selection_origin_column() або методу select().


void set_tab_size(size: int) 🔗

Встановлює розмір вкладки для використання TextEdit.


void set_tooltip_request_func(callback: Callable) 🔗

Забезпечити користувальницький інтерфейс. Метод зворотного виклику повинен прийняти такі рядки: hovered_word: String.


void skip_selection_for_next_occurrence() 🔗

Переміщує підбір і догляд за наступним виникненням поточного вибору. Якщо не існує активної підбірки, переходить до наступного залягання слова під опікою.


void start_action(action: EditAction) 🔗

Розпочинає дію, завершує поточну дію, якщо action відрізняється.

Дія також завершиться після виклику методу end_action(), після запуску методу ProjectSettings.gui/timers/text_edit_idle_detect_sec або після нового кроку, який можна скасувати, поза межами викликів методу start_action() та end_action().


void swap_lines(from_line: int, to_line: int) 🔗

Заміна двох ліній. Колеса буде змащена лініями.


void tag_saved_version() 🔗

Позначте поточний варіант, як збережений.


void undo() 🔗

Виконувати операцію без скасування.


Описи тематичної нерухомості

Color background_color = Color(0, 0, 0, 0) 🔗

Налаштовує фон Color цього TextEdit.


Color caret_background_color = Color(0, 0, 0, 1) 🔗

Color тексту за опікою при використанні блоку.


Color caret_color = Color(0.875, 0.875, 0.875, 1) 🔗

Color турботи. Це може бути встановлений для повного прозорого кольору, щоб повністю приховати догляд.


Color current_line_color = Color(0.25, 0.25, 0.26, 0.8) 🔗

Фонтан Color лінії, що містить догляд.


Color font_color = Color(0.875, 0.875, 0.875, 1) 🔗

Встановлює шрифт Color.


Color font_outline_color = Color(0, 0, 0, 1) 🔗

Текст тексту TextEdit.


Color font_placeholder_color = Color(0.875, 0.875, 0.875, 0.6) 🔗

Колір шрифту для placeholder_text.


Color font_readonly_color = Color(0.875, 0.875, 0.875, 0.5) 🔗

Встановлює шрифт Колір, коли параметр editable вимкнено.


Color font_selected_color = Color(0, 0, 0, 0) 🔗

Встановіть Color вибраного тексту. Якщо дорівнює Color(0, 0, 0), він буде ігнорувати.


Color search_result_border_color = Color(0.3, 0.3, 0.3, 0.4) 🔗

Color кордону навколо тексту, який відповідає запиту.


Color search_result_color = Color(0.3, 0.3, 0.3, 1) 🔗

Color за текстом, який відповідає запиту.


Color selection_color = Color(0.5, 0.5, 0.5, 1) 🔗

Встановлює родзинку Color текстових підборів.


Color word_highlighted_color = Color(0.5, 0.5, 0.5, 0.25) 🔗

Налаштовує родзинку Color декількох випадків. highlight_all_occurrences повинен бути включений.


int caret_width = 1 🔗

Ширина догляду в пікселях. Більші значення можуть бути використані для поліпшення доступності шляхом забезпечення догляду легко видно, або забезпечити консистенцію з великим розміром шрифту. Якщо встановити до 0 або нижче, ширина догляда автоматично встановлюється до 1пікселя і багатопліфікованого коефіцієнтом масштабування дисплея.


int line_spacing = 4 🔗

Додатковий вертикальний інтервал між рядками (у пікселях), інтервал додається до рядкового спуску. Це значення може бути негативним.


int outline_size = 0 🔗

Розмір контуру тексту.

Примітка. Якщо використовується шрифт із увімкненим FontFile.multichannel_signed_distance_field, для його FontFile.msdf_pixel_range має бути принаймні вдвічі значення outline_size щоб рендеринг контуру виглядав правильно. Інакше контур може здатися обрізаним раніше, ніж передбачалося.


Font font 🔗

Налаштування за замовчуванням Font.


int font_size 🔗

Встановлює розмір шрифту за замовчуванням.


Texture2D space 🔗

Встановлює користувальницький Texture2D для текстових символів простору.


Texture2D tab 🔗

Встановлює користувацький Texture2D для текстових символів вкладки.


StyleBox focus 🔗

Налаштування StyleBox при фокусі. фокус StyleBox відображається over бази StyleBox, так що частково прозора StyleBox повинна бути використана для забезпечення бази StyleBox. StyleBox, який добре працює для цього. Щоб вимкнути візуальний ефект фокусу, призначте ресурс StyleBoxEmpty. Зверніть увагу, що відключення візуального ефекту фокусу буде завдати шкоди клавіатурі / керованій навігації, тому це не рекомендується для причин доступності.


StyleBox normal 🔗

Налаштовує StyleBox цього TextEdit.


StyleBox read_only 🔗

Налаштовує StyleBox цього TextEdit при вимкненні editable.