XGrabKey

HotKey, linux, X11, XGrabKey

Синтаксис

XGrabKey(display, keycode, modifiers, grab_window, owner_events, pointer_mode, keyboard_mode)
      Display *    display;
      int          keycode;
      unsigned int modifiers;
      Window       grab_window;
      Bool         owner_events;
      int          pointer_mode, keyboard_mode;

Аргументы

display         // Указывает соединение с X Сервером
keycode         // Указывает код клавиши (KeyCode) или любой код (AnyKey)
modifiers       // Указывает установку конкретных масок модификаторов 
                // или использование любых модификаторов (AnyModifier). 
                // Маска является поразрядным ИЛИ для проверки битов маски.
grab_window     // Указывает захватываемое окно
owner_events    // Указывает значение Boolean, которое указывает на события клавиатуры, 
                // будут ли представлены как обычно.
pointer_mode    // Описывает дальнейший способ обработки событий указателя мыши.
                // Вы можете передавать GrabModeSync или GrabModeAsync.
keyboard_mode   // Описывает дальнейший способ обработки событий клавиатуры. 
                // Вы можете передавать GrabModeSync or GrabModeAsync.

Описание

Функция XGrabKey() устанавливает пассивный захват клавиатуры. В дальнейшем клавиатура может захватываться активно (с помощью XGrabKeyboard() ), время последнего захвата клавиатуры устанавливается в момент, когда нажата клавиша (тогда передаётся событие KeyPress ), а вызывается событие KeyPress , если выполнены все условия (то есть являются true):

• Клавиатура не захвачена, а указанная клавиша (которая может быть сама по себе модификатором) является логически нажатой, когда также нажаты другие целевые клавиши модификаторы, и при этом не нажаты иные модификаторы, которые не заложены в .
• Захватываемое окно является предком или является окном фокусировки захватываемого сочетания клавиш, или окно фокусировки является потомком окна фокусировки и содержит указатель на предка
• Пассивный захват той же комбинации клавиш не существует у какого-либо предка захватываемого окна.

Интерпретация следующих аргументов для XGrabKeyboard() . Активный захват завершается автоматически, когда логическое состояние клавиатуры описывается отпускание клавиши (независимо от логического состояния клавиш модификаторов).

Примечание. Логическое состояние устройства (как видно по клиентским приложениям) может запаздывать по сравнению с физическим состоянием, если обработка события устройства заморозилась. То есть может происходить подлагивание приложения или даже заморозка сервера X11. В частности это может наблюдаться при запуске режима захвата в качестве GrabModeSync , если не реализована корректная обработка событий нажатия клавиш.

Значение модификатора AnyModifier для аргумента modifiers является эквивалентом разрешения обработки всех возможных сочетаний клавиш модификаторов (включая комбинации без модификаторов).

Стоит отметить, что в X11 модификаторами являются не только клавиши Ctrl, Alt, Shift, Win(Meta), как в ОС Windows , но и клавиши ScrollLock, CapsLock, NumLock. Поэтому при регистрации сочетаний горячих клавиш необходимо учитывать и сочетания с данными клавишами. То есть, фактически вместо одного сочетания Сtrl+Alt+R, необходимо зарегистрировать ещё 7 сочетаний с клавишами ScrollLock, CapsLock и NumLock, чтобы сочетание корректно работало, если, конечно, Вам специально не требуется иной логики поведения приложения в сочетании с данным модификаторами.

Значение AnyKey для аргумента keycode эквивалентно решению обработки всех возможных клавиш (кодов клавиш). Однако, указание keycode должно быть в пределах между min_keycode и max_keycode. Иначе будет получена ошибка BadValues.

Если какое-то клиентское приложение уже использует определённое сочетание клавиш с помощью XGrabKey() на определённом целевом окне, то будет возвращена ошибка BadAccess . При использовании модификатора AnyModifier или AnyKey запрос на некоторые клавиши будет ошибочен и в результате BadAccess захват не будет выполняться из-за конфликта с комбинацией клавиш, захваченной другим приложением.

В частности, из-за такого поведения XGrabKey() можно некоторое время недоумевать о том, почему не срабатывает захват клавиши PrintScreen под тем же самым дистрибутивом Ubuntu. А причина в том, что данная клавиша уже захвачена приложением для создания скриншотов, которое идёт в поставке Ubuntu по умолчанию и уже захватывает данную клавишу.

XGrabKey() может генерировать следующие ошибки BadAccess , BadValue и BadWindow .

Диагностика

BadAccess - клиентское приложение попыталось освободить запись цветовой карты, которые уже освобождена.

BadAccess - клиентское приложение попыталось сохранить запись цветовой карты, которая в режиме read-only.

BadValue - некоторые числовые значения выходят за пределы диапазона запроса.  Если определенный диапазон не указан для аргумента, полный спектр определяется типом принимаемого аргумента.Любой аргумент определяется как набор альтернатив который может вызывать данную ошибку.

BadWindow - Значение для аргумента Окна (Window) не имеет имени определённого Окна (Window). Неверный идентификатор окна.

см. также XUngrabKey()