1c/bsl_console
1
0
Fork 0
mirror of https://github.com/salexdv/bsl_console.git synced 2024-11-24 08:33:29 +02:00
Code Issues Releases Activity

readme+docs closes #86

Browse Source
This commit is contained in:
salexdv 2021-05-05 10:59:24 +03:00
parent 8aedc640e5
commit 280325cc51
3 changed files with 84 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -74,6 +74,7 @@
| [`enableBeforeShowSuggestEvent`](docs/before_suggest_event.md) | Включает/выключает генерацию события, возникающего перед появлением списка подсказок|
| [`enableSelectSuggestEvent`](docs/select_suggest_event.md) | Включает/выключает генерацию события, возникающего при выборе пункта из списка подсказок|
| [`enableBeforeHoverEvent`](docs/before_hover_event.md) | Включает/выключает генерацию события, возникающего перед появлением всплывающей подсказки для слова|
| [`enableBeforeSignatureEvent`](docs/before_signature_event.md) | Включает/выключает генерацию события, возникающего перед появлением подсказки по вызову процедуры/метода|
| [`switchQueryMode`](docs/switch_query.md) | Переключение между режимом запроса и режимом редактирования кода |
| [`compare`](docs/compare.md) | Включает/выключает режим сравнения текстов |
| `nextDiff` | Переход с следующему изменению в режиме сравнения |
@ -100,7 +101,8 @@
| `clearMetadata` | Очищает структуру метаданных |
| `updateSnippets` | Обновляет пользовательские сниппеты |
| `updateCustomFunctions` | Обновляет пользовательские функции |
| `setCustomHovers ` | Обновляет пользовательские подсказки, показываемые при наведении |
| `setCustomHovers` | Обновляет пользовательские подсказки, показываемые при наведении |
| [`setCustomSignatures`](docs/set_custom_signatures.md) | Обновляет пользовательские подсказки по вызову процедуры/метода |
| [`addContextMenuItem`](docs/add_menu.md) | Регистрирует пользовательский пункт контекстного меню и связанное с ним событие |
| `markError` | Индикация ошибки в указанной строке |
| [`triggerSuggestions`](docs/trigger_suggestions.md) | Принудительный вызов подсказок |
@ -119,7 +121,8 @@
| `EVENT_ON_ACTIVATE_SUGGEST_ROW`| При активации пункта в текущем списке подсказок [(подробнее)](docs/activation_event.md) |
| `EVENT_BEFORE_SHOW_SUGGEST` | Перед появлением списка подсказок [(подробнее)](docs/before_suggest_event.md) |
| `EVENT_ON_SELECT_SUGGEST_ROW` | При выборе пункта из списка подсказок [(подробнее)](docs/select_suggest_event.md) |
| `EVENT_BEFORE_HOVER` | Перед появлением всплывающей подсказки для слова [(подробнее)](docs/before_hover_event.md) |
| `EVENT_BEFORE_HOVER` | Перед появлением всплывающей подсказки для слова [(подробнее)](docs/before_hover_event.md) |
| `EVENT_BEFORE_SIGNATURE` | Перед появлением всплывающей подсказки по вызову процедуры/метода [(подробнее)](docs/before_signature_event.md) |
*Перед началом работы с редактором из 1С Предпрития желательно вызвать функцию инициализации и передать в нее текущую версию платформы.*
Пример:

27
docs/before_signature_event.md Normal file
View File

@ -0,0 +1,27 @@
# Функция *enableBeforeSignatureEvent*
## Назначение функции
Функция включает/выключает генерацию события *EVENT_BEFORE_SIGNATURE*, которое возникает перед появлением всплывающей подсказки по вызову процедуры/метода
## Параметры функции
* **enabled** - *boolean*, активность события
## Пример вызова
```javascript
// Включение генерации события
enableBeforeSignatureEvent(true);
// Отключение генерации события
enableBeforeSignatureEvent(false);
```
## Пример параметров генерируемого события
```json
{
"word": "состояние",
"line": 16,
"column": 13,
"activeParameter": 0,
"activeSignature": 0,
"triggerCharacter": "("
}
```

52
docs/set_custom_signatures.md Normal file
View File

@ -0,0 +1,52 @@
# Функция *setCustomSignatures*
## Назначение функции
Функция позволяет задать пользовательские подсказки по вызову процедуры/метода
## Параметры функции
* **signutures** - *string*, подсказки в виде массив JSON-объектов, содержащих следующие поля:
* [label](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.signatureinformation.html#label) - заголовок, содержащий параметры процедуры/функции
* [documentation](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.signatureinformation.html#documentation) - описание сигнатуры
* [parameters[]](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.signatureinformation.html#parameters) - массив параметров [ParameterInformation](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.parameterinformation.html)
## Особенности
В качестве ключа передается название процедуры/функции, для которой следует показать подсказку, а в качестве значения массив описанных выше объектов.
## Пример вызова
```javascript
setCustomSignatures(`{
"Состояние": [
{
"label": "(ТекстСообщения, Прогресс?)",
"documentation": "Вывод текстового состояния с прогрессом",
"parameters": [
{
"label": "ТекстСообщения",
"documentation": "Строка, предназначенная для вывода в панель состояния. Если параметр не указан, возобновляется вывод системного текста в панель состояния."
},
{
"label": "Прогресс",
"documentation": "Число, Значение индикатора прогресса (от 1 до 100). Если не задан, индикатор прогресса не отображается."
}
]
},
{
"label": "(Прогресс, Картинка?, Пояснение?)",
"documentation": "Вывод индикатора состояния с картинкой",
"parameters": [
{
"label": "Прогресс",
"documentation": "Число, Значение индикатора прогресса (от 1 до 100). Если не задан, индикатор прогресса не отображается."
},
{
"label": "Картинка",
"documentation": "Картинка для отображения в окне состояния"
},
{
"label": "Пояснение",
"documentation": "Строка, Текст пояснения."
}
]
}
]
}`);
```