Публичный интерфейс библиотеки autumn
Аннотации
Список аннотаций
Желуди
Детальки
Прилепляемые коллекции
Классы
Модули
Напильники
Приемки
Перечисления
АннотацияЖелудь
ПриСозданииОбъекта
bsl
// Помечает указанный класс как желудь - компонент, жизненным циклом которого управляет фреймворк ОСень.
//
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
// как оно возвращается функцией `ТипЗнч`.
//
// Пример:
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "")АннотацияПластилин
ПриСозданииОбъекта
bsl
// Маркерная аннотация для указания, что прилепляемая частица
// является желудем. Основной способ связывания желудей между собой.
//
// Может быть использована над параметром конструктора/метода завязи желудя, полем класса
// или методом установки значения.
//
// Параметры:
// Значение - Строка - Имя прилепляемого желудя. Если не заполнено, используется имя параметра конструктора/поля
// класса или часть имени метода для установки значения.
// Тип - Строка - Тип прилепляемого желудя. В случае передачи значения "Желудь", будет внедрен желудь как таковой.
// Так же может быть указан тип-коллекция: "Массив", "ТаблицаЗначений" и другие. Полный список
// доступных типов см. в библиотеке
// [autumn-collections](https://github.com/autumn-library/autumn-collections).
// Блестяшка - Произвольный - Повторяемый параметр. Передаваемые в прилепляемый желудь произвольные значения.
//
// Пример:
//
// 1.
// &Желудь
// Процедура ПриСозданииОбъекта(&Пластилин ДругойЖелудь)
//
// 2.
// &Желудь
// Процедура ПриСозданииОбъекта(
// . &Пластилин(Значение = "ДругойЖелудь", Тип = "Массив", Блестяшка = "Парам1", Блестяшка = "Парам2") Зависимость
// )
//
// 3.
// &Пластилин
// Перем ДругойЖелудь;
//
// 4.
// &Завязь
// Функция МойЖелудь(&Пластилин ДругойЖелудь) Экспорт
//
// 5.
// &Пластилин
// Процедура УстановитьДругойЖелудь(Зависимость) Экспорт
//
Процедура ПриСозданииОбъекта(Повторяемый = Блестяшка = Неопределено)АннотацияДуб
ПриСозданииОбъекта
bsl
// Помечает указанный класс как фабрику компонентов - дуб, из которого появляются желуди.
// `&Дуб` сам по себе тоже является желудем, то есть может запрашивать прилепление частиц,
// является объектом для обработки `&Напильник`ом, может иметь `&Спецификация` и так далее.
//
// Дуб обычно содержит методы, помеченные аннотацией `&Завязь`, которые возвращают желуди, но
// может содержать и другие методы, не связанные непосредственно с созданием желудей.
//
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
// как оно возвращается функцией `ТипЗнч`.
// Пример:
// &Дуб
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
// .
// &Завязь
// Функция ПользовательскийЖелудь() Экспорт
// . Возврат Новый ПользовательскийЖелудь();
// КонецФункции
//
Процедура ПриСозданииОбъекта(Значение = "")АннотацияЗавязь
ПриСозданииОбъекта
bsl
// Помечает функцию как функцию, создающую желудь.
//
// Может иметь параметры, каждый из которых должен быть промаркирован как &Пластилин, &Деталька или &Блестяшка.
// В указанные параметры автоматически будут прилеплены соответствующие частицы при создании желудя.
//
// Может размещаться над экспортной функцией в классе, проаннотированном как `&Дуб`, или над методом-лямбдой,
// передаваемой в качестве параметра в `Поделка.ДобавитьЗавязь()`.
//
// Параметры:
// Значение - Строка - Имя создаваемого желудя. По умолчанию будет использовано имя метода.
// Тип - Строка - Тип создаваемого желудя.
// Требуется если по имени желудя не получается однозначного определить его тип.
//
// Пример:
// &Завязь
// Функция ПользовательскийЖелудь(&Пластилин Зависимость, &Деталька ВажнаяНастройка) Экспорт
// . Возврат Новый ПользовательскийЖелудь(Зависимость, ВажнаяНастройка);
// КонецФункции
//
Процедура ПриСозданииОбъекта(Значение = "", Тип = "")АннотацияДеталька
ПриСозданииОбъекта
bsl
// Маркерная аннотация для указания, что прилепляемая частица
// является настройкой приложения.
//
// Может быть использована над параметром конструктора/метода завязи желудя, полем класса
// или методом установки значения.
//
// Параметры:
// Значение - Строка - Ключ настройки. См. библиотеку [configor](https://github.com/oscript-library/configor)
// для полного описания синтаксиса.
// Если не заполнено, используется имя параметра конструктора/поля класса
// или часть имени метода для установки значения.
// ЗначениеПоУмолчанию - Произвольный - Значение, которое принимает деталька, если не задано из-вне.
//
// Пример:
//
// 1.
// &Деталька
// Перем ПутьКФайлу;
//
// 2.
// &Деталька(Значение = "Настройки.ПутьКФайлу", ЗначениеПоУмолчанию = "./file.txt")
// Перем ПутьКФайлу;
//
// 3.
// &Желудь
// Процедура ПриСозданииОбъекта(&Деталька ПутьКФайлу)
//
// 4.
// &Деталька
// Процедура УстановитьПутьКФайлу(Значение) Экспорт
//
// 5.
// &Завязь
// Функция МойЖелудь(&Деталька ПутьКФайлу) Экспорт
//
Процедура ПриСозданииОбъекта(Значение = "", ЗначениеПоУмолчанию = Неопределено)АннотацияБлестяшка
ПриСозданииОбъекта
bsl
// Маркерная аннотация для указания, что прилепляемая частица
// является произвольным значением, передаваемым в конструктор желудя.
//
// Может быть использована только над параметром конструктора/метода завязи желудя.
//
// Пример:
//
// 1.
// &Желудь
// Процедура ПриСозданииОбъекта(&Блестяшка ПроизвольноеЗначение)
//
// 2.
// &Завязь
// Функция МойЖелудь(&Блестяшка ПроизвольноеЗначение) Экспорт
//
Процедура ПриСозданииОбъекта()АннотацияТабакерка
ПриСозданииОбъекта
bsl
// Пометка, что прилепляемая частица прилепляется не непосредственно, а через специальный объект
// типа `Табакерка`, который позволяет получить частицу программно и отложенно.
//
// Может использоваться для внедрения компанейских желудей, внедрения желудя самого в себя,
// для разрыва циклических зависимостей, для передачи дополнительных параметров прилепляемого желудя и т.п.
//
// Используется совместно с аннотациями `&Пластилин` и `&Деталька`.
//
// Пример:
//
// 1.
// &Табакерка
// &Пластилин("ДругойЖелудь")
// Перем ТабакеркаСДругимЖелудем;
// .
// ДругойЖелудь = ТабакеркаСДругимЖелудем.Достать();
// ДругойЖелудь.КакойТоМетод();
// ...
// 2.
// &Табакерка
// &Пластилин("ДругойЖелудь")
// Перем ТабакеркаСДругимЖелудем;
// .
// МассивБлестяшек = Новый Массив;
// МассивБлестяшек.Добавить("Парам1");
// .
// ДругойЖелудь = ТабакеркаСДругимЖелудем.Достать(МассивБлестяшек);
// ДругойЖелудь.КакойТоМетод();
//
Процедура ПриСозданииОбъекта()АннотацияФинальныйШтрих
ПриСозданииОбъекта
bsl
// Процедуры, помеченные аннотацией "ФинальныйШтрих" будут вызваны в конце инициализации желудя,
// после отработки конструктора/метода завязи и всех напильников, применяемых на желуде.
// Во время выполнения процедуры доступны все прилепляемые частицы, прилепленные как через конструктор,
// так и через поля класса и методы-сеттеры.
//
// Желудь может содержать несколько процедур, помеченных аннотацией "ФинальныйШтрих".
// Порядок их вызова не гарантируется.
//
// Процедура должна быть помечена `Экспорт`ная.
//
// Пример:
//
// &ФинальныйШтрих
// Процедура ПостИнициализация() Экспорт
// . Сообщить("Я выполнилась после конструктора объекта");
// КонецПроцедуры
// .
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта()АннотацияНапильник
ПриСозданииОбъекта
bsl
// Специальный тип желудя для дополнительной обработки других желудей в процессе их создания.
//
// Может использоваться для добавления дополнительных действий или свойств создаваемым желудям. Метод `ОбработатьЖелудь`
// **может** возвращать другой объект, который подменит текущий желудь, или обертку-декоратор над текущим желудем.
//
// Каждый `&Напильник` дополнительно имеет `&Прозвище("Напильник")`.
//
// Напильник сам по себе является желудем, однако в силу своей специфики он может запрашивать прилепление только
// &Деталек и Поделки.
//
// Желудь, помеченный аннотацией `&Напильник`, должен реализовать следующий интерфейс:
// * `Функция ОбработатьЖелудь(Желудь, ОпределениеЖелудя) Экспорт`
//
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка - Имя желудя, под которым напильник добавляется в контекст Поделки.
// ПрименяетсяТолькоНа - Строка - Повторяемый параметр. Ограничивает применение напильника только на желудях
// с указанными именами.
//
// Пример:
// &Напильник
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Повторяемый = ПрименяетсяТолькоНа = Неопределено)МожетПрименятьсяНа
bsl
// Проверить, может ли текущий напильник применяться на указанном желуде.
//
// Параметры:
// ОпределениеЖелудя - ОпределениеЖелудя - Определение желудя, для которого проверяется
// применимость текущего напильника.
//
// Возвращаемое значение:
// Булево - Истина, если напильник может применяться на указанном желуде, иначе Ложь.
//
Функция МожетПрименятьсяНа(ОпределениеЖелудя)АннотацияЗаготовка
ПриСозданииОбъекта
bsl
// Специальный тип желудя для выполнения дополнительных действий в момент помещения класса в контекст Поделки.
//
// Может использоваться для добавления динамической загрузки новых классов в систему типов OneScript или
// дополнительных импортов библиотек через директиву `#Использовать`.
//
// Каждая `&Заготовка` дополнительно имеет `&Прозвище("Заготовка")` и &Спецификация("Инициализация").
//
// Желудь, помеченный аннотацией `&Заготовка`, должен реализовать следующий интерфейс:
// * `Процедура ПриИнициализацииПоделки(Поделка) Экспорт`
//
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка - Имя желудя, под которым заготовка добавляется в контекст Поделки.
//
// Пример:
// &Заготовка
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "")АннотацияРогатка
ПриСозданииОбъекта
bsl
// Специальный тип желудя, автоматически выполняемый при запуске приложения (`Поделка.ЗапуститьПриложение()`).
//
// Желудь, помеченный аннотацией `&Рогатка`, должен реализовать следующий интерфейс:
// * `Процедура ПриЗапускеПриложения() Экспорт`
//
// Каждая `&Рогатка` дополнительно имеет `&Прозвище("Рогатка")`.
//
// `&Рогатка` сама по себе тоже является желудем, то есть может запрашивать прилепление частиц,
// является объектом для обработки `&Напильник`ом, может иметь `&Спецификация` и так далее.
//
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка - Имя желудя, под которым рогатка добавляется в контекст Поделки.
// ЗапускатьВФоне - Булево - Если Истина, то рогатка будет запущена в фоновом задании.
// Если Ложь, то рогатка будет запущена в текущем потоке.
// ОжидатьЗавершения - Булево - Если Истина и `ЗапускатьВФоне` = Истина,
// то после запуска рогатки будет ожидаться её завершение.
// Пример:
// Процедура ПриЗапускеПриложения() Экспорт
// . Сообщить("Привет из рогатки!");
// КонецПроцедуры
// .
// &Рогатка
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "", ЗапускатьВФоне = Истина, ОжидатьЗавершения = Истина)ЗапускатьВФоне
bsl
// Флаг необходимости запуска рогатки в фоновом задании.
//
// Возвращаемое значение:
// Булево
//
Функция ЗапускатьВФоне()ОжидатьЗавершения
bsl
// Флаг необходимости ожидания завершения рогатки при ее запуске в фоновом задании.
//
// Возвращаемое значение:
// Булево
//
Функция ОжидатьЗавершения()АннотацияПриемка
ПриСозданииОбъекта
bsl
// Специальный тип желудя для обработки определений желудей.
//
// Аналог &Напильника для `ОпределениеЖелудя`. Срабатывает каждый раз, когда в контекст добавляется новое
// определение желудя. При добавлении самой Приемки в контекст, все ранее добавленные определения желудей
// передаются в Приемку для проверки.
//
// Класс, помеченный аннотацией `&Приемка`, должен реализовать следующий интерфейс:
// * `Процедура ПриДобавленииОпределенияЖелудя(ОпределениеЖелудя) Экспорт`
//
// Каждая `&Приемка` так же имеет `&Характер("Компанейский")`, `&Прозвище("Приемка")` и `&Спецификация("Инициализация")`
//
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка - Имя желудя, под которым приемка добавляется в контекст Поделки.
//
// Пример:
//
// Процедура ПриДобавленииОпределенияЖелудя(ОпределениеЖелудя) Экспорт
// . Сообщить("Определение желудя: " + ОпределениеЖелудя.Имя());
// КонецПроцедуры
// .
// &Приемка
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "")АннотацияПрозвище
ПриСозданииОбъекта
bsl
// Добавляет к желудю дополнительный идентификатор, по которому его можно в последствии доставать из Поделки.
// Желудь может иметь несколько прозвищ. Одно и то же прозвище может использоваться для нескольких желудей.
//
// Может быть использовано, например, для группировки желудей и получении их в виде массива.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// Значение - Строка - Задаваемое прозвище.
//
// Пример:
//
// &Прозвище("ПодписчикНаСобытие")
// &Прозвище("ПользовательскийЖелудь")
// &Желудь("МойЖелудь")
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение)АннотацияВерховный
ПриСозданииОбъекта
bsl
// Помечает желудь как имеющий приоритет среди других желудей с таким же именем или `&Прозвищем`.
// В случае конфликта имен при получении желудей или их регистрации, будет использован желудь с аннотацией `&Верховный`.
//
// При наличии нескольких желудей с одним и тем же прозвищем позволяет определить, какой из них следует возвращать
// при поиске конкретного желудя по его прозвищу.
//
// Если несколько желудей с одним и тем же именем/прозвищем имеют аннотацию `&Верховный`, будет вызвано исключение.
//
// Размещается над определением желудя - конструктором или методом &Завязи.
//
// Пример:
// 1.
// &Верховный
// &Желудь("ПереопределяемыйЖелудь")
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
// .
// 2.
// &Верховный
// &Завязь
// Функция ПереопределяемыйЖелудь() Экспорт
// КонецФункции
//
Процедура ПриСозданииОбъекта()АннотацияПорядок
ПриСозданииОбъекта
bsl
// Управляет порядком инициализации и использования желудя. Не может быть меньше 1 или больше 999998.
//
// Если размещается над обычным `&Желудем` или `&Завязью`, то влияет на порядок сортировки, при получении
// коллекции желудей по прозвищу.
//
// Если размещается над `&Напильником`, влияет на порядок применения напильников к желудям.
//
// Если размещается над `&Рогаткой`, влияет на порядок запуска рогаток при старте приложения.
//
// Параметры:
// Значение - Число - Задаваемый порядок.
//
Процедура ПриСозданииОбъекта(Значение = 1)Значение
bsl
// Порядок, заданный аннотацией.
//
// Возвращаемое значение:
// Число
//
Функция Значение() ЭкспортАннотацияХарактер
ПриСозданииОбъекта
bsl
// Задает способ управления жизненным циклом желудя.
//
// ОСень содержит два базовых характера желудя: "Одиночка" и "Компанейский".
//
// По умолчанию все желуди имеют характер "Одиночка", означающий, что желудь
// инициализируется один раз. При каждом запросе желудя будет возвращаться один и тот же
// экземпляр.
//
// Характер "Компанейский" означает, что каждый раз при запросе желудя будет создаваться
// новый экземпляр.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// Значение - Строка - Характер желудя.
//
// Пример:
// &Характер("Компанейский")
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение)АннотацияОсобоеОбращение
ПриСозданииОбъекта
bsl
// Маркерная аннотация, показывающая, что желудь требует изменений в процессе своего создания.
//
// Параметры аннотации конфликтуют между собой. Если отключаются все напильники, то нельзя задавать ограничения на
// применение конкретных напильников или отключение конкретных напильников. Если задано ограничение на применение только
// конкретных напильников, то нельзя задавать ограничение на отключение конкретных напильников (и наоборот).
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// ОтключитьВсеНапильники - Булево - Не применять на желуде никакие напильники.
// ПрименятьТолькоНапильник - Строка - Повторяемый параметр. Применять на желуде только напильник с указанным именем.
// НеПрименятьНапильник - Строка - Повторяемый параметр. Не применять на желуде напильник с указанным именем.
//
Процедура ПриСозданииОбъекта(Повторяемый = НеПрименятьНапильник = Неопределено)НапильникМожетПрименяться
bsl
// Проверяет, может ли указанный напильник применяться над желудем, помеченным аннотацией `&ОсобоеОбращение`.
//
// Параметры:
// ИмяНапильника - Строка - Имя напильника для проверки применимости.
//
// Возвращаемое значение:
// Булево - Истина, если напильник может применяться на текущем желуде, иначе Ложь.
//
Функция НапильникМожетПрименяться(ИмяНапильника) ЭкспортАннотацияСпецификация
ПриСозданииОбъекта
bsl
// Аннотация для указания жизненного цикла приложения, начиная с которого разрешено создавать желудь.
//
// По умолчанию все желуди имеют спецификацию "Выполнение", означающую, что желудь может быть создан только после вызова
// `Поделка.ЗапуститьПриложение()`.
//
// К желудям со спецификацией "Инициализация" не применяются напильники.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// Значение - Строка - Состояние приложения, на котором разрешено создавать желудь. См. СостоянияПриложения.
//
// Пример:
// &Спецификация("Инициализация")
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение = "Выполнение")Значение
bsl
// Сохраненное значение спецификации.
//
// Возвращаемое значение:
// Строка
//
Функция Значение() ЭкспортINFO
Документация из библиотеки autumn-collections.
INFO
Документация из библиотеки annotations.
АннотацияАннотация
ПриСозданииОбъекта
bsl
// Базовый объект аннотации.
// Все пользовательские аннотации должны иметь аннотацию &Аннотация с передачей имени аннотации в качестве параметра.
//
// Параметры:
// Значение - Строка - Имя аннотации.
//
Процедура ПриСозданииОбъекта(Значение)INFO
Документация из библиотеки annotations.
АннотацияПовторяемый
ПриСозданииОбъекта
bsl
// Аннотация, показывающая что параметр аннотации может быть указан несколько раз.
//
// Применяется к параметрам конструктора аннотации.
//
// Примеры:
//
// &Аннотация("МояАннотация")
// Процедура ПриСозданииОбъекта(Значение, &Повторяемый Параметр)
// КонецПроцедуры
// .
// &МояАннотация(Значение = "Переданное значение", Параметр = "Первый параметр", Параметр = "Второй параметр")
//
Процедура ПриСозданииОбъекта()Поделка
ПриСозданииОбъекта
bsl
Процедура ПриСозданииОбъекта(Знач СоветДругогоМастера = Неопределено)ПолучитьОпределенияЖелудей
bsl
Функция ПолучитьОпределенияЖелудей(Имя = Неопределено) ЭкспортПолучитьОпределенияАннотаций
bsl
Функция ПолучитьОпределенияАннотаций() ЭкспортПолучитьОпределениеЖелудя
bsl
Функция ПолучитьОпределениеЖелудя(Имя) ЭкспортПолучитьОпределениеАннотации
bsl
Функция ПолучитьОпределениеАннотации(Имя) ЭкспортНайтиЖелудь
bsl
Функция НайтиЖелудь(Имя, ПрилепляемыеЧастицы = Неопределено) ЭкспортНайтиЖелуди
bsl
Функция НайтиЖелуди(Имя, ПрилепляемыеЧастицы = Неопределено, ТипЖелудя = "Массив") ЭкспортНайтиДетальку
bsl
Функция НайтиДетальку(ИмяДетальки, ЗначениеПоУмолчанию = Неопределено) ЭкспортДобавитьЖелудь
bsl
Функция ДобавитьЖелудь(Тип, Имя = "") ЭкспортДобавитьДуб
bsl
Функция ДобавитьДуб(Тип) ЭкспортДобавитьНапильник
bsl
Функция ДобавитьНапильник(Тип) ЭкспортДобавитьЗаготовку
bsl
Функция ДобавитьЗаготовку(Тип) ЭкспортДобавитьРогатку
bsl
Функция ДобавитьРогатку(Тип) ЭкспортДобавитьАннотацию
bsl
Функция ДобавитьАннотацию(Тип) ЭкспортПросканироватьКаталог
bsl
Функция ПросканироватьКаталог(Каталог) ЭкспортДобавитьЗавязь
bsl
Функция ДобавитьЗавязь(Лямбда, Контекст = Неопределено) ЭкспортЗапуститьПриложение
bsl
Процедура ЗапуститьПриложение() ЭкспортINFO
Документация из библиотеки annotations.
РазворачивательАннотаций
ПриСозданииОбъекта
bsl
Процедура ПриСозданииОбъекта(КонтейнерАннотаций)РазвернутьАннотацииСвойства
bsl
// Развернуть все аннотации переданного свойства рекурсивно.
// Для разворачивания используются данные из определений аннотаций.
//
// Параметры:
// Свойство - Структура - Описание свойства, метода или параметра метода:
// * Имя - Строка - Имя свойства.
// * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
// ** Имя - Строка - Имя аннотации.
// ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// *** Имя - Строка - Имя параметра аннотации.
// *** Значение - Строка - Значение параметра аннотации.
// ВладелецСвойства - Тип - Тип владельца свойства.
// - Сценарий - Экземпляр владельца свойства.
//
Процедура РазвернутьАннотацииСвойства(Свойство, ВладелецСвойства) ЭкспортРазвернутьАннотацииСвойств
bsl
// Развернуть все аннотации переданного свойства рекурсивно.
// Для разворачивания используются данные из определений аннотаций.
//
// Параметры:
// Свойства - Массив Из Структура - Описания свойств, методов или параметров метода:
// * Имя - Строка - Имя свойства.
// * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства:
// ** Имя - Строка - Имя аннотации.
// ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// *** Имя - Строка - Имя параметра аннотации.
// *** Значение - Строка - Значение параметра аннотации.
// ВладелецСвойства - Тип - Тип владельца свойства.
// - Сценарий - Экземпляр владельца свойства.
//
Процедура РазвернутьАннотацииСвойств(Свойства, ВладелецСвойства) ЭкспортINFO
Документация из библиотеки annotations.
КонтейнерАннотаций
ПриСозданииОбъекта
bsl
// Контейнер аннотаций - объект, который хранит все определения аннотаций.
// При создании контейнера аннотаций в него автоматически добавляется базовая аннотация &Аннотация.
//
Процедура ПриСозданииОбъекта()ПолучитьОпределенияАннотаций
bsl
// Получить все определения аннотаций.
//
// Возвращаемое значение:
// ФиксированноеСоответствие - Соответствие, в котором хранятся все определения аннотаций:
// * Ключ - Строка - имя аннотации.
// * Значение - ОпределениеАннотации - определение аннотации.
//
Функция ПолучитьОпределенияАннотаций() ЭкспортПолучитьОпределениеАннотации
bsl
// Получить определение аннотации по её имени.
//
// Параметры:
// Имя - Строка - Имя аннотации.
//
// Возвращаемое значение:
// ОпределениеАннотации, Неопределено - Найденное определение аннотаций.
// Неопределено, если аннотация с данным именем не зарегистрирована.
//
Функция ПолучитьОпределениеАннотации(Имя) ЭкспортПолучитьРазворачивательАннотаций
bsl
// Получить настроенный разворачиватель аннотаций.
//
// Возвращаемое значение:
// РазворачивательАннотаций - Разворачиватель аннотаций, связанный с данным контейнером аннотаций.
//
Функция ПолучитьРазворачивательАннотаций() ЭкспортДобавитьАннотацию
bsl
// Добавить аннотацию в контейнер аннотаций.
//
// Параметры:
// ТипАннотации - Тип - Тип аннотации.
//
// Возвращаемое значение:
// ОпределениеАннотации - Определение добавленной аннотации.
//
Функция ДобавитьАннотацию(ТипАннотации) ЭкспортПрилепляторЧастиц
ПриСозданииОбъекта
bsl
// @internal
Процедура ПриСозданииОбъекта(пПоделка, пУправляющийПрилепляемымиКоллекциями)ДанныеОПрилепляемойЧастице
bsl
Функция ДанныеОПрилепляемойЧастице(Свойство, Знач ИмяСвойства = Неопределено) ЭкспортНайтиПрилепляемуюЧастицу
bsl
Функция НайтиПрилепляемуюЧастицу(ДанныеОПрилепляемойЧастице, Знач ПрилепляемыеЧастицы = Неопределено) Экспортcore.ЗапускатьРогатки
Тип
Булево
Описание
Определяет следует ли запускать все рогатки при старте приложения.
INFO
Документация из библиотеки autumn-collections.
INFO
Документация из библиотеки autumn-collections.
INFO
Документация из библиотеки autumn-collections.
INFO
Документация из библиотеки autumn-collections.
INFO
Документация из библиотеки autumn-collections.
INFO
Документация из библиотеки autumn-collections.
СоветДругогоМастера
ПриСозданииОбъекта
bsl
// Советы по созданию поделки, упакованные в объект.
//
Процедура ПриСозданииОбъекта()ЗначенияДеталек
bsl
// Установить/получить значения деталек.
//
// Параметры:
// НовоеЗначение - Соответствие - устанавливаемые значения деталек.
//
// Возвращаемое значение:
// Соответствие, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ЗначенияДеталек(НовоеЗначение = Неопределено) ЭкспортПрефиксПеременныхСреды
bsl
// Установить/получить префикс переменных среды, хранящих значения деталек.
//
// Параметры:
// НовоеЗначение - Строка - устанавливаемый префикс переменных среды.
//
// Возвращаемое значение:
// Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ПрефиксПеременныхСреды(НовоеЗначение = Неопределено) ЭкспортИмяФайлаСоЗначениямиДеталек
bsl
// Установить/получить имя файла (без расширения), в котором хранятся значения деталек.
//
// Параметры:
// НовоеЗначение - Строка - устанавливаемое имя файла.
//
// Возвращаемое значение:
// Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ИмяФайлаСоЗначениямиДеталек(НовоеЗначение = Неопределено) ЭкспортДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек
bsl
// Установить/получить относительный путь к каталогу, где хранятся файл со значениями деталек.
//
// Параметры:
// НовоеЗначение - Строка - устанавливаемый путь к каталогу.
//
// Возвращаемое значение:
// Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
//
Функция ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек(НовоеЗначение = Неопределено) ЭкспортТабакерка
ПриСозданииОбъекта
bsl
// Конструктор объекта.
//
// Параметры:
// ПрилепляторЧастиц - ПрилепляторЧастиц - Прилеплятор частиц, который будет использоваться для поиска.
// БазоваяПрилепляемаяЧастица - ПрилепляемаяЧастица - Прилепляемая частица, в которой описано то, что должно
// доставаться из Табакерки.
//
Процедура ПриСозданииОбъекта(ПрилепляторЧастиц, БазоваяПрилепляемаяЧастица)Достать
bsl
// Достать частицу из табакерки
//
// Параметры:
// ПрилепляемыеЧастицы - Массив - массив прилепляемых частиц, которые передадутся как зависимости доставаемой частицы.
//
// Возвращаемое значение:
// Произвольный - Желудь, блестяшка или деталька, хранимая в табакерке.
//
Функция Достать(ПрилепляемыеЧастицы = Неопределено) ЭкспортОпределениеЖелудя
ПриСозданииОбъекта
bsl
Процедура ПриСозданииОбъекта(РазворачивательАннотаций, ТипЖелудя, Имя, Характер, ПрилепляемыеЧастицы, Завязь, Прозвища, Порядок, Верховный, Спецификация, КорневаяАннотация)Имя
bsl
Функция Имя() ЭкспортТипЖелудя
bsl
Функция ТипЖелудя() ЭкспортХарактер
bsl
Функция Характер() ЭкспортПрилепляемыеЧастицы
bsl
Функция ПрилепляемыеЧастицы() ЭкспортЗавязь
bsl
Функция Завязь() ЭкспортПрозвища
bsl
Функция Прозвища() ЭкспортПорядок
bsl
Функция Порядок() ЭкспортВерховный
bsl
Функция Верховный() ЭкспортСпецификация
bsl
Функция Спецификация() ЭкспортКорневаяАннотация
bsl
Функция КорневаяАннотация() ЭкспортСвойства
bsl
Функция Свойства() ЭкспортМетоды
bsl
Функция Методы() ЭкспортРефлекторОбъекта
bsl
Функция РефлекторОбъекта() ЭкспортНайтиМетодыСАннотациями
bsl
Функция НайтиМетодыСАннотациями(АннотацияФильтр) ЭкспортINFO
Документация из библиотеки annotations.
ОпределениеАннотации
ПриСозданииОбъекта
bsl
Процедура ПриСозданииОбъекта(Знач _Имя, Знач _ИмяТипаАннотации, Знач _Параметры, Знач _Аннотации)Имя
bsl
// Имя аннотации.
//
// Возвращаемое значение:
// Строка
//
Функция Имя() ЭкспортИмяТипаАннотации
bsl
// Имя типа, к которому применяется аннотация.
//
// Возвращаемое значение:
// Строка
//
Функция ИмяТипаАннотации() ЭкспортПараметры
bsl
// Параметры аннотации - разобранные параметры конструктора класса аннотации.
// Метод возвращает копию таблицы.
//
// Возвращаемое значение:
// ТаблицаЗначений - таблица параметров аннотации:
// * Имя - Строка - Имя параметра.
// * ПоЗначению - Булево - Признак получения пораметра по значению.
// * ЕстьЗначениеПоУмолчанию - Булево - Признак наличия значения по умолчанию.
// * ЗначениеПоУмолчанию - Произвольный - Значение по умолчанию.
// * Аннотации - ТаблицаЗначений - Таблица аннотаций со следующими колонками:
// ** Имя - Строка - Имя аннотации.
// ** Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// *** Имя - Строка - Имя параметра аннотации.
// *** Значение - Строка - Значение параметра аннотации.
// * Экспорт - Булево - Признак экспорта параметра.
//
Функция Параметры() ЭкспортАннотации
bsl
// Подчиненные аннотации - список аннотаций над конструктором класса-аннотации.
// Метот возвращает глубокую копию таблицы.
//
// Возвращаемое значение:
// ТаблицаЗначений - Таблица аннотаций:
// * Имя - Строка - Имя аннотации.
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// ** Имя - Строка - Имя параметра аннотации.
// ** Значение - Строка - Значение параметра аннотации.
//
Функция Аннотации() ЭкспортПроверить
bsl
// Выполнить проверку корректности аннотации.
//
// Выбрасывает исключение:
// * Когда аннотация не содержит параметр, у которого нет значения по умолчанию.
// * Когда аннотация содержит параметр, которого нет в списке параметров аннотации.
// * Когда аннотация содержит несколько параметров без имени или с именем "Значение".
//
// Параметры:
// Аннотация - СтрокаТаблицыЗначений - Данные аннотации:
// * Имя - Строка - Имя аннотации.
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// ** Имя - Строка - Имя параметра аннотации.
// ** Значение - Строка - Значение параметра аннотации.
// ПредставлениеВладельцаАннотации - Строка - Строковое представление типа или объекта
// к которому применяется аннотация.
//
Процедура Проверить(Аннотация, ПредставлениеВладельцаАннотации) ЭкспортСоздатьОбъектАннотации
bsl
// Создать объект класса аннотации по параметрам аннотации.
//
// Параметры:
// Аннотация - СтрокаТаблицыЗначений - Данные аннотации:
// * Имя - Строка - Имя аннотации.
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// ** Имя - Строка - Имя параметра аннотации.
// ** Значение - Строка - Значение параметра аннотации.
//
// Возвращаемое значение:
// Произвольный - Объект аннотации с заданными параметрами.
//
Функция СоздатьОбъектАннотации(Аннотация) ЭкспортЗавязь
ПриСозданииОбъекта
bsl
// Дата-класс для хранения данных о способе создания жёлудя.
//
// Параметры:
// Родитель - Сценарий - Класс, содержащий указанный метод завязи.
// ИмяМетода - Строка - Имя метода, которым можно создать жёлудь.
// ДанныеМетода - Структура - Данные метода, как из возвращает рефлектор.
// Действие - Действие - Делегат, который можно вызвать, чтобы создать жёлудь.
// ЭтоКонструктор - Булево - Флаг, что делегат ведет на конструктор класса, а не на &Завязь-метод.
//
Процедура ПриСозданииОбъекта(Родитель, ИмяМетода, ДанныеМетода, Действие, ЭтоКонструктор)Родитель
bsl
// Класс, содержащий указанный метод завязи.
//
// Возвращаемое значение:
// Сценарий
//
Функция Родитель() ЭкспортИмяМетода
bsl
// Имя метода, которым можно создать жёлудь.
//
// Возвращаемое значение:
// Строка
//
Функция ИмяМетода() ЭкспортДанныеМетода
bsl
// Данные метода, как из возвращает рефлектор.
//
// Возвращаемое значение:
// Структура
//
Функция ДанныеМетода() ЭкспортДействие
bsl
// Делегат, который можно вызвать, чтобы создать жёлудь.
//
// Возвращаемое значение:
// Действие
//
Функция Действие() ЭкспортЭтоКонструктор
bsl
// Флаг, что делегат ведет на конструктор класса, а не на &Завязь-метод.
//
// Возвращаемое значение:
// Булево
//
Функция ЭтоКонструктор() ЭкспортПрилепляемаяЧастица
ПриСозданииОбъекта
bsl
Процедура ПриСозданииОбъекта(ТипЧастицы, ИмяЧастицы, Аннотация, БазоваяПрилепляемаяЧастица = Неопределено)ТипЧастицы
bsl
Функция ТипЧастицы() ЭкспортИмяЧастицы
bsl
Функция ИмяЧастицы() ЭкспортАннотация
bsl
Функция Аннотация() ЭкспортБазоваяПрилепляемаяЧастица
bsl
Функция БазоваяПрилепляемаяЧастица() ЭкспортINFO
Документация из библиотеки annotations.
РаботаСАннотациями
ПолучитьАннотации
bsl
// Получить все аннотации свойства с указанным именем аннотации.
//
// Параметры:
// Свойство - СтрокаТабличнойЧасти, Структура - Описание свойства/метода:
// * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства/метода:
// * Имя - Строка - Имя аннотации.
// ИмяАннотации - Строка - Имя аннотации.
//
// Возвращаемое значение:
// Массив из СтрокаТабличнойЧасти - Массив найденных аннотаций.
//
Функция ПолучитьАннотации(Свойство, ИмяАннотации)ПолучитьАннотацию
bsl
// Получить первую аннотацию свойства с указанным именем аннотации.
//
// Параметры:
// Свойство - СтрокаТабличнойЧасти, Структура - Описание свойства/метода:
// * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства/метода:
// * Имя - Строка - Имя аннотации.
// ИмяАннотации - Строка - Имя аннотации.
//
// Возвращаемое значение:
// СтрокаТабличнойЧасти - Найденная аннотация.
//
Функция ПолучитьАннотацию(Свойство, ИмяАннотации)НайтиАннотации
bsl
// Получить все аннотации с указанным именем аннотации.
//
// Параметры:
// Аннотации - ТаблицаЗначений - Таблица аннотаций:
// * Имя - Строка - Имя аннотации.
// ИмяАннотации - Строка - Имя аннотации.
//
// Возвращаемое значение:
// Массив из СтрокаТабличнойЧасти - Массив найденных аннотаций.
//
Функция НайтиАннотации(Аннотации, ИмяАннотации)НайтиАннотацию
bsl
// Получить первую аннотацию с указанным именем аннотации.
//
// Параметры:
// Аннотации - ТаблицаЗначений - Таблица аннотаций:
// * Имя - Строка - Имя аннотации.
// ИмяАннотации - Строка - Имя аннотации.
//
// Возвращаемое значение:
// СтрокаТабличнойЧасти - Найденная аннотация.
//
Функция НайтиАннотацию(Аннотации, ИмяАннотации)НайтиМетодыСАннотацией
bsl
// Получить все методы с указанной аннотацией.
//
// Параметры:
// Методы - ТаблицаЗначений, Массив - Список методов:
// * Аннотации - ТаблицаЗначений - Таблица аннотаций метода:
// * Имя - Строка - Имя аннотации.
// ИмяАннотации - Строка - Имя аннотации.
//
// Возвращаемое значение:
// Массив из СтрокаТабличнойЧасти - Массив найденных методов.
//
Функция НайтиМетодыСАннотацией(Методы, ИмяАннотации)ПолучитьПараметрыАннотации
bsl
// Получить параметры аннотации с указанным именем параметра.
//
// Параметры:
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// * Имя - Строка - Имя параметра.
// ИмяПараметра - Строка - Имя параметра.
//
// Возвращаемое значение:
// Массив из СтрокаТабличнойЧасти - Массив найденных параметров.
//
Функция ПолучитьПараметрыАннотации(Аннотация, ИмяПараметра)ПолучитьПараметрАннотации
bsl
// Получить параметр аннотации с указанным именем параметра.
//
// Параметры:
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// * Имя - Строка - Имя параметра.
// ИмяПараметра - Строка - Имя параметра.
//
// Возвращаемое значение:
// СтрокаТабличнойЧасти - Найденный параметр.
//
Функция ПолучитьПараметрАннотации(Аннотация, ИмяПараметра)ПолучитьЗначенияПараметровАннотации
bsl
// Получить значения параметров аннотации с указанным именем параметра.
//
// Параметры:
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// * Имя - Строка - Имя параметра.
// * Значение - Произвольный - Значение параметра.
// ИмяПараметра - Строка - Имя параметра.
//
// Возвращаемое значение:
// Массив из Произвольный - Массив найденных значений параметров.
//
Функция ПолучитьЗначенияПараметровАннотации(Аннотация, ИмяПараметра)ПолучитьЗначениеПараметраАннотации
bsl
// Получить значение параметра аннотации с указанным именем параметра.
//
// Параметры:
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// * Имя - Строка - Имя параметра.
// * Значение - Произвольный - Значение параметра.
// ИмяПараметра - Строка - Имя параметра.
// ЗначениеПоУмолчанию - Произвольный - Значение параметра по умолчанию.
// НеопределеноЭтоКорректноеЗначениеПараметра - Булево - Признак того,
// что Неопределено является корректным значением параметра.
//
// Возвращаемое значение:
// Произвольный - Значение параметра.
//
Функция ПолучитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра = "Значение", ЗначениеПоУмолчанию = Неопределено, НеопределеноЭтоКорректноеЗначениеПараметра = Ложь)УстановитьЗначениеПараметраАннотации
bsl
// Установить значение параметра аннотации с указанным именем параметра.
//
// Параметры:
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
// * Имя - Строка - Имя параметра.
// * Значение - Произвольный - Значение параметра.
// ИмяПараметра - Строка - Имя параметра.
// ЗначениеПараметра - Произвольный - Значение параметра.
//
Процедура УстановитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра, ЗначениеПараметра)ОбработкаНапильникомПластилинаНаПолях
ПриСозданииОбъекта
bsl
Процедура ПриСозданииОбъекта(&Пластилин ПрилепляторЧастиц)ОбработатьЖелудь
bsl
Функция ОбработатьЖелудь(Желудь, ОпределениеЖелудя) ЭкспортОбработкаНапильникомФинальныйШтрих
ПриСозданииОбъекта
bsl
Процедура ПриСозданииОбъекта()ОбработатьЖелудь
bsl
Функция ОбработатьЖелудь(Желудь, ОпределениеЖелудя) ЭкспортТипыПрилепляемыхЧастиц
Деталька
bsl
Функция Деталька() ЭкспортЖелудь
bsl
Функция Желудь() ЭкспортБлестяшка
bsl
Функция Блестяшка() ЭкспортТабакерка
bsl
Функция Табакерка() ЭкспортХарактерыЖелудей
Компанейский
bsl
Функция Компанейский() ЭкспортОдиночка
bsl
Функция Одиночка() ЭкспортЭтоХарактерЖелудя
bsl
Функция ЭтоХарактерЖелудя(Характер) Экспорт