.. _input_hook:

Перехват клавиатурного ввода
==============================

Это упрощённый вариант функционала Global1 по `перехвату клавиатуры <https://docs.global-system.ru/global1/dev/Reference/InternalLib/Application/classes/TbtkScriptApplicationObject.html#id10>`_

.. pas:function:: HookKeyboardInputHandler(operation: String; inputStartPattern: String; inputEndPattern: String; timeout: int; isInputIntercepted: boolean)

    Установить перехватчик клавиатурного ввода для приложения. Возможна установка не более одного перехватчика,
    при попытке установить перехватчик при уже установленном будет возбуждено исключение

    :param String operation:
        имя операции-обработчика ввода. В неё будет передан перехваченный ввод и флаг того, был ли перехват завершён по таймауту

    :param String inputStartPattern:
        стартовая последовательность символов, сигнализирующая о начале перехвата ввода

    :param String inputEndPattern:
        терминальная последовательность символов, сигнализирующая об окончании перехвата ввода

    :param int timeout:
        максимальный таймаут до ввода терминальной последовательности символов

    :param boolean isInputIntercepted:
        если установлен в true, то:

        - если inputStartPattern состоит из одного символа, то все нажатия клавиш, начиная с inputStartPattern и заканчивая inputEndPattern (включительно), не будут передаваться в контролы;
        - если inputStartPattern длиннее одного символа, то все нажатия клавиш не будут передаваться в контролы.
        
        Необязательный параметр, по умолчанию - false

    .. versionadded:: AS 1.25.0-rc19
    .. versionchanged:: AS 1.25.0-rc26 Добавлен опциональный параметр `isInputIntercepted`
    .. versionchanged:: AS 1.25.0-rc32 Добавлена возможость блокировки передачи в контролы только нажатий, начиная с inputStartPattern и заканчивая inputEndPattern, для односимвольной стартовой послежовательности


.. pas:function:: UnhookKeyboardInputHandler()

    Снять перехватчик клавиатурного ввода для приложения

    .. versionadded:: AS 1.25.0-rc19