mirror of
https://github.com/MihailRis/voxelcore.git
synced 2026-10-08 12:31:51 +00:00
Merge 5cfe5d3aac into 00425c4175
This commit is contained in:
boolean-false
GitHub
commit
9a2a227d98
7 changed files with 423 additions and 35 deletions
|
|
@ -84,21 +84,24 @@ Common methods:
|
|||
|
||||
Properties:
|
||||
|
||||
| Name | Type | Read | Write | Description |
|
||||
| ----------- | ------ | ---- | ----- | ------------------------------------------------------------------------------------ |
|
||||
| text | string | yes | yes | entered text or placeholder |
|
||||
| placeholder | string | yes | yes | placeholder (used if nothing has been entered) |
|
||||
| hint | string | yes | yes | text to display when nothing is entered |
|
||||
| caret | int | yes | yes | carriage position. `textbox.caret = -1` will set the position to the end of the text |
|
||||
| editable | bool | yes | yes | text mutability |
|
||||
| edited | bool | yes | yes\* | is text edited since the last set / edited status reset |
|
||||
| multiline | bool | yes | yes | multiline support |
|
||||
| lineNumbers | bool | yes | yes | display line numbers |
|
||||
| textWrap | bool | yes | yes | automatic text wrapping (only with multiline: "true") |
|
||||
| valid | bool | yes | no | is the entered text correct |
|
||||
| textColor | vec4 | yes | yes | text color |
|
||||
| syntax | string | yes | yes | syntax highlighting ("lua" - Lua) |
|
||||
| markup | string | yes | yes | text markup language ("md" - Markdown) |
|
||||
| Name | Type | Read | Write | Description |
|
||||
| ----------------- | ------ | ---- | ----- | ------------------------------------------------------------------------------------ |
|
||||
| text | string | yes | yes | entered text or placeholder |
|
||||
| placeholder | string | yes | yes | placeholder (used if nothing has been entered) |
|
||||
| hint | string | yes | yes | text to display when nothing is entered |
|
||||
| caret | int | yes | yes | carriage position. `textbox.caret = -1` will set the position to the end of the text |
|
||||
| editable | bool | yes | yes | text mutability |
|
||||
| edited | bool | yes | yes\* | is text edited since the last set / edited status reset |
|
||||
| multiline | bool | yes | yes | multiline support |
|
||||
| lineNumbers | bool | yes | yes | display line numbers |
|
||||
| textWrap | bool | yes | yes | automatic text wrapping (only with multiline: "true") |
|
||||
| valid | bool | yes | no | is the entered text correct |
|
||||
| textColor | vec4 | yes | yes | text color |
|
||||
| syntax | string | yes | yes | syntax highlighting ("lua" - Lua) |
|
||||
| markup | string | yes | yes | text markup language ("md" - Markdown) |
|
||||
| selection | ivec2 | yes | yes | selection anchor and caret; see below |
|
||||
| externalRendering | bool | yes | yes | external text rendering (default: false) |
|
||||
| textLayout | table | yes | no | snapshot of visible text layout; see below |
|
||||
|
||||
\* - false only
|
||||
|
||||
|
|
@ -110,6 +113,59 @@ Methods:
|
|||
| lineAt(pos: int) -> int | determines the line number by position in the text |
|
||||
| linePos(line: int) -> int | determines the position of the beginning of the line in the text |
|
||||
|
||||
### Selection and external rendering
|
||||
|
||||
- `selection` (read/write): `{anchor, caret}`, preserving direction. Indices
|
||||
are zero-based native caret character units, not UTF-8 byte offsets. Setters
|
||||
require finite integers, clamp to the text length and reveal the caret,
|
||||
including immediately after replacing text. Setting selection does not
|
||||
edit text or reset undo history.
|
||||
- `externalRendering` (read/write boolean, default `false`): hides native text,
|
||||
caret, selection and current-line highlight. Input, hit testing, layout,
|
||||
scrolling, background, line numbers and scrollbar remain native. Setting it
|
||||
back to `false` restores native rendering without replacing the textbox.
|
||||
Markup and external rendering cannot be combined: either setter rejects it.
|
||||
- `textLayout` (read-only table): a snapshot of the current visible layout.
|
||||
`ready=false` means the font is unavailable or markup is active. Otherwise:
|
||||
- `text`: the value of `textbox.text`, including `placeholder` when input is empty;
|
||||
`font`: font name.
|
||||
- `lineHeight`: row pitch; `textHeight`: height to use for a label displaying a row.
|
||||
- `caretRect`: `{x,y,cellWidth,rowHeight}` at the moving selection endpoint;
|
||||
at end-of-line the cell width is the space advance. This is geometry,
|
||||
independent of focus, editability and blink phase.
|
||||
- `selectionRects`: `{x, y, width, height}` rectangles for visible selected rows,
|
||||
including selected newline cells.
|
||||
- `lines`: visible rows `{start, text, pos={x,y}, advances={...}}`;
|
||||
`start` is a native caret index, text excludes the trailing newline,
|
||||
`advances` contains the native width of each character. Empty input may
|
||||
expose the hint as display rows; it does not replace `text` in the snapshot.
|
||||
|
||||
Coordinates are relative to the textbox, include scrolling and alignment,
|
||||
and may extend outside its bounds. External painters must clip to the field.
|
||||
Snapshots are independent Lua tables; modifying them does not modify the box.
|
||||
Read them again after input, resizing or scrolling. Syntax colors are not
|
||||
exported; the external painter supplies its own colors. Indexing and text input
|
||||
follow the existing textbox behavior.
|
||||
|
||||
```lua
|
||||
local field = document.input
|
||||
field.text = "abcdef"
|
||||
field.selection = {5, 2}
|
||||
local anchor, caret = unpack(field.selection)
|
||||
|
||||
field.externalRendering = true
|
||||
local layout = field.textLayout
|
||||
if layout.ready then
|
||||
for _, line in ipairs(layout.lines) do
|
||||
print(line.start, line.text, line.pos[1], line.pos[2])
|
||||
end
|
||||
end
|
||||
```
|
||||
|
||||
In this example the caret is at position 2 and the selection anchor is at
|
||||
position 5. A negative selection index is clamped to zero; unlike `caret`,
|
||||
it does not address characters from the end of the text.
|
||||
|
||||
## Slider (trackbar)
|
||||
|
||||
Properties:
|
||||
|
|
|
|||
|
|
@ -84,21 +84,24 @@ document["worlds-panel"]:clear()
|
|||
|
||||
Свойства:
|
||||
|
||||
| Название | Тип | Чтение | Запись | Описание |
|
||||
| ----------- | ------ | ------ | ------ | ---------------------------------------------------------------------- |
|
||||
| text | string | да | да | введенный текст или заполнитель |
|
||||
| placeholder | string | да | да | заполнитель (используется если ничего не было введено) |
|
||||
| hint | string | да | да | текст, отображаемый, когда ничего не введено |
|
||||
| caret | int | да | да | позиция каретки. `textbox.caret = -1` установит позицию в конец текста |
|
||||
| editable | bool | да | да | изменяемость текста |
|
||||
| edited | bool | да | да\* | был ли изменён текст с последней установки/сброса свойства |
|
||||
| multiline | bool | да | да | поддержка многострочности |
|
||||
| lineNumbers | bool | да | да | отображение номеров строк |
|
||||
| textWrap | bool | да | да | автоматический перенос текста (только при multiline: "true") |
|
||||
| valid | bool | да | нет | является ли введенный текст корректным |
|
||||
| textColor | vec4 | да | да | цвет текста |
|
||||
| syntax | string | да | да | подсветка синтаксиса ("lua" - Lua) |
|
||||
| markup | string | да | да | язык разметки текста ("md" - Markdown) |
|
||||
| Название | Тип | Чтение | Запись | Описание |
|
||||
| ----------------- | ------ | ------ | ------ | ---------------------------------------------------------------------- |
|
||||
| text | string | да | да | введенный текст или заполнитель |
|
||||
| placeholder | string | да | да | заполнитель (используется если ничего не было введено) |
|
||||
| hint | string | да | да | текст, отображаемый, когда ничего не введено |
|
||||
| caret | int | да | да | позиция каретки. `textbox.caret = -1` установит позицию в конец текста |
|
||||
| editable | bool | да | да | изменяемость текста |
|
||||
| edited | bool | да | да\* | был ли изменён текст с последней установки/сброса свойства |
|
||||
| multiline | bool | да | да | поддержка многострочности |
|
||||
| lineNumbers | bool | да | да | отображение номеров строк |
|
||||
| textWrap | bool | да | да | автоматический перенос текста (только при multiline: "true") |
|
||||
| valid | bool | да | нет | является ли введенный текст корректным |
|
||||
| textColor | vec4 | да | да | цвет текста |
|
||||
| syntax | string | да | да | подсветка синтаксиса ("lua" - Lua) |
|
||||
| markup | string | да | да | язык разметки текста ("md" - Markdown) |
|
||||
| selection | ivec2 | да | да | закреплённый конец выделения и каретка; см. ниже |
|
||||
| externalRendering | bool | да | да | внешняя отрисовка текста (по умолчанию false) |
|
||||
| textLayout | table | да | нет | снимок видимой раскладки текста; см. ниже |
|
||||
|
||||
\* - только false
|
||||
|
||||
|
|
@ -110,6 +113,58 @@ document["worlds-panel"]:clear()
|
|||
| lineAt(pos: int) -> int | определяет номер строки по позиции в тексте |
|
||||
| linePos(line: int) -> int | определяет позицию начала строки в тексте |
|
||||
|
||||
### Выделение и внешняя отрисовка
|
||||
|
||||
- `selection` (чтение/запись): `{anchor, caret}` - направленное выделение.
|
||||
Индексы с нуля в единицах нативного `caret`, не байтах UTF-8. Допускаются
|
||||
только конечные целые числа; значения ограничиваются длиной текста.
|
||||
Установка прокручивает поле к каретке, в том числе сразу после замены текста,
|
||||
не меняет текст и не сбрасывает undo.
|
||||
- `externalRendering` (boolean, чтение/запись, по умолчанию `false`): скрывает
|
||||
текст, каретку, выделение и подсветку текущей строки. Ввод, hit testing,
|
||||
раскладка, прокрутка, фон, номера строк и скроллбар остаются нативными.
|
||||
`false` возвращает нативную отрисовку без пересоздания поля. Совмещение с
|
||||
`markup` запрещено в обоих направлениях и вызывает ошибку.
|
||||
- `textLayout` (таблица, только чтение): снимок видимой раскладки.
|
||||
`ready=false`, если шрифт недоступен либо используется markup. Иначе:
|
||||
- `text` - значение `textbox.text`, включая `placeholder` при пустом вводе;
|
||||
`font` - имя шрифта;
|
||||
- `lineHeight` - шаг строки, `textHeight` - высота label для отрисовки строки;
|
||||
- `caretRect={x,y,cellWidth,rowHeight}` - геометрия каретки, без учёта фокуса,
|
||||
editable и мигания; на конце строки ширина ячейки равна ширине пробела;
|
||||
- `selectionRects` - прямоугольники `{x, y, width, height}` для видимых
|
||||
выделенных строк, включая ячейки переводов строк;
|
||||
- `lines` - видимые строки `{start,text,pos={x,y},advances={...}}`: нативный
|
||||
индекс начала, текст без завершающего перевода строки, позиция и ширины
|
||||
отдельных символов. Для пустого ввода строки могут содержать hint,
|
||||
при этом hint не подменяет поле `text` в снимке.
|
||||
|
||||
Координаты локальны textbox, учитывают выравнивание и прокрутку, могут выходить
|
||||
за его границы. Внешняя отрисовка должна обрезаться областью поля. Снимок -
|
||||
независимая Lua-таблица; её изменение не меняет textbox. После ввода, изменения
|
||||
размеров и прокрутки нужно читать новый снимок. Цвета syntax не экспортируются:
|
||||
внешний рендерер задаёт их самостоятельно. Индексация и ввод текста
|
||||
следуют существующему поведению textbox.
|
||||
|
||||
```lua
|
||||
local field = document.input
|
||||
field.text = "abcdef"
|
||||
field.selection = {5, 2}
|
||||
local anchor, caret = unpack(field.selection)
|
||||
|
||||
field.externalRendering = true
|
||||
local layout = field.textLayout
|
||||
if layout.ready then
|
||||
for _, line in ipairs(layout.lines) do
|
||||
print(line.start, line.text, line.pos[1], line.pos[2])
|
||||
end
|
||||
end
|
||||
```
|
||||
|
||||
В примере каретка находится на позиции 2, закреплённый конец выделения - на
|
||||
позиции 5. Отрицательный индекс выделения ограничивается нулём; в отличие
|
||||
от `caret`, он не задаёт позицию относительно конца текста.
|
||||
|
||||
## Ползунок (trackbar)
|
||||
|
||||
Свойства:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue