Документация #247

2025-09-16 09:06:17 +02:00 · 2021-11-18 09:43:21 +03:00
parent def0eaa98a
commit a0da56ad84
9 changed files with 81 additions and 60 deletions
--- a/README.md
+++ b/README.md
@@ -81,12 +81,12 @@
 | `switchLang`                   | Переключает язык подсказок с английского на русский и обратно                                 |
 | `enableQuickSuggestions`       | Включает/выключает режим быстрых подсказок                                                    |
 | `minimap`  				     | Включает/выключает отображение карты кода                                                     |
-| [`enableModificationEvent`](docs/modification_event.md) | Включает/выключает генерацию события, возникающего при изменении содержимого редактора|
-| [`enableSuggestActivationEvent`](docs/activation_event.md) | Включает/выключает генерацию события, возникающего активации пункта в списке подсказок|
-| [`enableBeforeShowSuggestEvent`](docs/before_suggest_event.md) | Включает/выключает генерацию события, возникающего перед появлением списка подсказок|
-| [`enableSelectSuggestEvent`](docs/select_suggest_event.md) | Включает/выключает генерацию события, возникающего при выборе пункта из списка подсказок|
-| [`enableBeforeHoverEvent`](docs/before_hover_event.md) | Включает/выключает генерацию события, возникающего перед появлением всплывающей подсказки для слова|
-| [`enableBeforeSignatureEvent`](docs/before_signature_event.md) | Включает/выключает генерацию события, возникающего перед появлением подсказки по вызову процедуры/метода|
+| `enableModificationEvent*`     | Включает/выключает генерацию события, возникающего при изменении содержимого редактора (устарела)|
+| `enableSuggestActivationEvent*`| Включает/выключает генерацию события, возникающего активации пункта в списке подсказок (устарела)|
+| `enableBeforeShowSuggestEvent*`| Включает/выключает генерацию события, возникающего перед появлением списка подсказок (устарела)|
+| `enableSelectSuggestEvent*`    | Включает/выключает генерацию события, возникающего при выборе пункта из списка подсказок (устарела)|
+| `enableBeforeHoverEvent*`      | Включает/выключает генерацию события, возникающего перед появлением всплывающей подсказки для слова (устарела)|
+| `enableBeforeSignatureEvent*`  | Включает/выключает генерацию события, возникающего перед появлением подсказки по вызову процедуры/метода (устарела)|
 | [`switchQueryMode*`](docs/switch_query.md) | Переключение между режимом запроса и режимом редактирования кода (устарела)       |
 | `switchDCSMode*`               | Переключение в режим СКД и обратно  (устарела)                                                |
 | `switchXMLMode*`	     	 	 | Переключение в режим просмотра XML с подсветкой и обратно  (устарела)  				         |
@@ -161,7 +161,7 @@
 | ------------------------------ | --------------------------------------------------------------------------------------------- |
 | `EVENT_QUERY_CONSTRUCT`        | При выборе пункта меню "Конструктор запросов". Возвращает текст и позицию запроса             |
 | `EVENT_FORMAT_CONSTRUCT`       | При выборе пункта меню "Конструктор форматной строки". Возвращает текст и позицию фор.строки  |
-| `EVENT_CONTENT_CHANGED`        | При любом изменении содержимого редактора. Вкл/откл через *enableModificationEvent*           |
+| `EVENT_CONTENT_CHANGED`]       | При любом изменении содержимого редактора [(подробнее)](docs/modification_event.md)           |
 | `EVENT_GET_METADATA`       	 | Генерируется при отсутствии метаданных. В параметрах передается имя запрашиваемых метаданных [(подробнее)](docs/get_metadata_event.md) |
 | `EVENT_XXX`                    | При выборе пользовательского пункта меню. *addContextMenuItem('Мой пункт', 'EVENT_MY')*       |
 | `EVENT_ON_ACTIVATE_SUGGEST_ROW`| При активации пункта в текущем списке подсказок [(подробнее)](docs/activation_event.md)		 |
--- a/docs/activation_event.md
+++ b/docs/activation_event.md
@@ -1,18 +1,17 @@
-# Функция *enableSuggestActivationEvent*
-## Назначение функции
-Функция включает/выключает генерацию события *EVENT_ON_ACTIVATE_SUGGEST_ROW*, которое возникает при активации пункта в текущем списке подсказок.
-При выводе подробного описания (CTRL+Space) пункта подсказки генерируется событие *EVENT_ON_DETAIL_SUGGEST_ROW* с аналогичными параметрами.
+# Событие *EVENT_ON_ACTIVATE_SUGGEST_ROW*
+## Назначение события
+Событие возникает при активации пункта в текущем списке подсказок

-## Параметры функции
-* **enabled** - *boolean*, активность события
+## Управление событием
+За генерацию события отвечает опция [`generateSuggestActivationEvent`](set_option.md)

 ## Пример вызова
 ```javascript
 // Включение генерации события
-enableSuggestActivationEvent(true);
+setOption('generateSuggestActivationEvent', true);

 // Отключение генерации события
-enableSuggestActivationEvent(false);
+setOption('generateSuggestActivationEvent', false);
 ```

 ## Пример параметров генерируемого события
--- a/docs/before_hover_event.md
+++ b/docs/before_hover_event.md
@@ -1,17 +1,17 @@
-# Функция *enableBeforeHoverEvent*
-## Назначение функции
-Функция включает/выключает генерацию события *EVENT_BEFORE_HOVER*, которое возникает перед появлением всплывающей подсказки для слова при наведении мыши
+# Событие *EVENT_BEFORE_HOVER*
+## Назначение события
+Событие возникает перед появлением всплывающей подсказки для слова при наведении мыши

-## Параметры функции
-* **enabled** - *boolean*, активность события
+## Управление событием
+За генерацию события отвечает опция [`generateBeforeHoverEvent`](set_option.md)

 ## Пример вызова
 ```javascript
 // Включение генерации события
-enableBeforeHoverEvent(true);
+setOption('generateBeforeHoverEvent', true);

 // Отключение генерации события
-enableBeforeHoverEvent(false);
+setOption('generateBeforeHoverEvent', false);
 ```

 ## Пример параметров генерируемого события
--- a/docs/before_signature_event.md
+++ b/docs/before_signature_event.md
@@ -1,17 +1,17 @@
-# Функция *enableBeforeSignatureEvent*
-## Назначение функции
-Функция включает/выключает генерацию события *EVENT_BEFORE_SIGNATURE*, которое возникает перед появлением всплывающей подсказки по вызову процедуры/метода
+# Событие *EVENT_BEFORE_SIGNATURE*
+## Назначение события
+Событие возникает перед появлением всплывающей подсказки по вызову процедуры/метода

-## Параметры функции
-* **enabled** - *boolean*, активность события
+## Управление событием
+За генерацию события отвечает опция [`generateBeforeSignatureEvent`](set_option.md)

 ## Пример вызова
 ```javascript
 // Включение генерации события
-enableBeforeSignatureEvent(true);
+setOption('generateBeforeSignatureEvent', true);

 // Отключение генерации события
-enableBeforeSignatureEvent(false);
+setOption('generateBeforeSignatureEvent', false);
 ```

 ## Пример параметров генерируемого события
--- a/docs/before_suggest_event.md
+++ b/docs/before_suggest_event.md
@@ -1,17 +1,17 @@
-# Функция *enableBeforeShowSuggestEvent*
-## Назначение функции
-Функция включает/выключает генерацию события *EVENT_BEFORE_SHOW_SUGGEST*, которое возникает перед появлением списка подсказок
+# Событие *EVENT_BEFORE_SHOW_SUGGEST*
+## Назначение события
+Событие возникает перед появлением списка подсказок

-## Параметры функции
-* **enabled** - *boolean*, активность события
+## Управление событием
+За генерацию события отвечает опция [`generateBeforeShowSuggestEvent`](set_option.md)

 ## Пример вызова
 ```javascript
 // Включение генерации события
-enableBeforeShowSuggestEvent(true);
+setOption('generateBeforeShowSuggestEvent', true);

 // Отключение генерации события
-enableBeforeShowSuggestEvent(false);
+setOption('generateBeforeShowSuggestEvent', false);
 ```

 ## Пример параметров генерируемого события
--- a/docs/get_definition_event.md
+++ b/docs/get_definition_event.md
@@ -5,6 +5,15 @@
 ## Управление событием
 За генерацию события отвечает опция [`generateDefinitionEvent`](set_option.md)

+## Пример вызова
+```javascript
+// Включение генерации события
+setOption('generateDefinitionEvent', true);
+
+// Отключение генерации события
+setOption('generateDefinitionEvent', false);
+```
+
 ## Параметры события
 В параметрах события передается контекст, в котором возникло событие
 Например:
--- a/docs/modification_event.md
+++ b/docs/modification_event.md
@@ -1,15 +1,18 @@
-# Функция *enableModificationEvent*
-## Назначение функции
-Функция включает/выключает генерацию события *EVENT_CONTENT_CHANGED*, которое возникает при любом изменении содержимого редактора
+# Событие *EVENT_CONTENT_CHANGED*
+## Назначение события
+Событие генерируется при любом изменении содержимого редактора

-## Параметры функции
-* **enabled** - *boolean*, активность события
+## Управление событием
+За генерацию события отвечает опция [`generateModificationEvent`](set_option.md)

 ## Пример вызова
 ```javascript
 // Включение генерации события
-enableModificationEvent(true);
+setOption('generateModificationEvent', true);

 // Отключение генерации события
-enableModificationEvent(false);
-```
+setOption('generateModificationEvent', false);
+```
+
+## Пример параметров генерируемого события
+Параметры у события отсутствуют
--- a/docs/select_suggest_event.md
+++ b/docs/select_suggest_event.md
@@ -1,17 +1,17 @@
-# Функция *enableSelectSuggestEvent*
-## Назначение функции
-Функция включает/выключает генерацию события *EVENT_ON_SELECT_SUGGEST_ROW*, которое возникает при выборе пункта из списка подсказок
+# Событие *EVENT_ON_SELECT_SUGGEST_ROW*
+## Назначение события
+Событие возникает при выборе пункта из списка подсказок

-## Параметры функции
-* **enabled** - *boolean*, активность события
+## Управление событием
+За генерацию события отвечает опция [`generateSelectSuggestEvent`](set_option.md)

 ## Пример вызова
 ```javascript
 // Включение генерации события
-enableSelectSuggestEvent(true);
+setOption('generateSelectSuggestEvent', true);

 // Отключение генерации события
-enableSelectSuggestEvent(false);
+setOption('generateSelectSuggestEvent', false);
 ```

 ## Пример параметров генерируемого события
--- a/docs/set_option.md
+++ b/docs/set_option.md
@@ -12,17 +12,27 @@ setOption("skipInsertSuggestionAcceptor", true);
 ```

 ## Список опциональных настроек
+##### Управление событиями
+* `generateModificationEvent` - *boolean*, включает/отключает генерацию [события](modification_event.md) при любом изменении содержимого редактора
+* `generateBeforeShowSuggestEvent` - *boolean*, включает/отключает генерацию [события](before_suggest_event.md) перед появлением списка подсказок
+* `generateSuggestActivationEvent` - *boolean*, включает/отключает генерацию [события](activation_event.md) при активации пункта в текущем списке подсказок
+	* `alwaysDisplaySuggestDetails` - *boolean*, управляет постоянным отображением детальной информации в списке подсказок (работает только при включенной опции `generateSuggestActivationEvent`)
+* `generateSelectSuggestEvent` - *boolean*, включает/отключает генерацию [события](select_suggest_event.md) при выборе пункта из списка подсказок
+* `generateBeforeHoverEvent` - *boolean*, включает/отключает генерацию [события](before_hover_event.md) перед появлением всплывающей подсказки для слова при наведении мыши
+* `generateBeforeSignatureEvent` - *boolean*, включает/отключает генерацию [события](before_signature_event.md) перед появлением всплывающей подсказки по вызову процедуры/метода
+* `generateDefinitionEvent` - *boolean*, включает генерацию [события](get_definition_event.md) при переходе к определению
+
+##### Управление подсказками
+Позволяет оставить только пользовательские подсказки
+* `disableNativeSuggestions` - *boolean*, отключает стандартные подсказки
+* `disableNativeSignatures` - *boolean*, отключает стандартные подсказки по вызову процедуры/функции
+* `disableNativeHovers` - *boolean*, отключает стандартные всплывающие подсказки при наведении курсора мыши на слово
+* `showSnippetsOnCustomSuggestions` - *boolean*, включает показ стандартных сниппетов при выводе пользовательских подсказок через [`showCustomSuggestions`](custom_suggestions.md)
+
+##### Различные настройки редактора
 * `skipInsertSuggestionAcceptor` - *boolean*, позволяет пропустить вставку символа, заданного функцией *setActiveSuggestionAcceptors* и вызвавшего выбор активного пункта подсказки
 * `skipAcceptionSelectedSuggestion` - *boolean*, позволяет пропустить вставку текста активного пункта подсказки при нажатии символа, заданного функцией *setActiveSuggestionAcceptors*
 * `disableContextCommands` - *boolean*, отключает формирование контекстного меню и привязку некоторых горячих клавиш, которые связаны с пунктами меню. Установка значения опции имеет смысл только до вызова функции инициализации `init()`
 * `disableContextQueryConstructor` - *boolean*, отключает формирование кнопки контекстного меню "Конструктор запросов". Установка значения опции имеет смысл только до вызова `init()`
 * `autoResizeEditorLayout` - *boolean*, включает перерисовку редактора при изменении размеров окна
-* `renderQueryDelimiters` - *boolean*, включает выделение цветом разделителей запросов
-* `generateDefinitionEvent` - *boolean*, включает генерацию [события](get_definition_event.md) при переходе к определению
-
-	##### Управление подсказками
-	Позволяет оставить только пользовательские подсказки
-* `disableNativeSuggestions` - *boolean*, отключает стандартные подсказки
-* `disableNativeSignatures` - *boolean*, отключает стандартные подсказки по вызову процедуры/функции
-* `disableNativeHovers` - *boolean*, отключает стандартные всплывающие подсказки при наведении курсора мыши на слово
-* `showSnippetsOnCustomSuggestions` - *boolean*, включает показ стандартных сниппетов при выводе пользовательских подсказок через [`showCustomSuggestions`](custom_suggestions.md)
+* `renderQueryDelimiters` - *boolean*, включает выделение цветом разделителей запросов