GtkShortcutTrigger
GtkShortcutTrigger — Триггеры для отслеживания активации сочетаний клавиш
Функции
Типы и значения
Иерархия объектов
GObject
╰── GtkShortcutTrigger
├── GtkKeyvalTrigger
├── GtkNeverTrigger
╰── GtkAlternativeTrigger
Файлы заголовков
#include <gtk/gtk.h>
Описание
GtkShortcutTrigger — объект, используемый для отслеживания активации сочетания клавиш GtkShortcut. Для этой цели можно вызвать gtk_shortcut_trigger_trigger() для GdkEvent.
В GtkShortcutTriggers содержатся функции, которые позволяют легко представить их пользователю, а также вывести для отладки.
Все GtkShortcutTriggers являются неизменяемыми; их свойства можно задавать только во время создания. Если вы хотите изменить триггер, вы должны заменить его новым.
Функции
gtk_shortcut_trigger_trigger ()
GdkKeyMatch gtk_shortcut_trigger_trigger (GtkShortcutTrigger *self,GdkEvent *event,gboolean enable_mnemonics);
Проверяет, вызывает ли заданный event событие self .
Параметры
self | объект GtkShortcutTrigger | |
event | событие для проверки | |
enable_mnemonics |
|
Возвращаемое значение
Содержит ли событие сочетание клавиш
gtk_shortcut_trigger_hash ()
guint gtk_shortcut_trigger_hash (gconstpointer trigger);
Генерирует значение хеша для GtkShortcutTrigger.
Гарантируется, что для заданного значения результат этой функции будет одинаковым только в пределах текущего процесса. Он может отличаться на разных архитектурах процессоров или даже в разных версиях GTK. Не используйте эту функцию в качестве основы для создания протоколов или форматов файлов.
Типы trigger являются gconstpointer, только для возможности использования этой функции с GHashTable. Каждый из них должен быть GtkShortcutTrigger.
Параметры
trigger | объект GtkShortcutTrigger. | [type GtkShortcutTrigger] |
Возвращаемое значение
Значение хеша, соответствующее trigger
gtk_shortcut_trigger_equal ()
gboolean
gtk_shortcut_trigger_equal (gconstpointer trigger1,
gconstpointer trigger2); Проверяет, вызывают ли trigger1 и trigger2 сочетания клавиш в одинаковых условиях.
Типы one и two являются gconstpointer, только для возможности использования этой функции с GHashTable. Каждый из них должен быть GtkShortcutTrigger.
Параметры
trigger1 | объект GtkShortcutTrigger. | [type GtkShortcutTrigger] |
trigger2 | объект GtkShortcutTrigger. | [type GtkShortcutTrigger] |
Возвращаемое значение
TRUE если trigger1 и trigger2 равны
gtk_shortcut_trigger_compare ()
int
gtk_shortcut_trigger_compare (gconstpointer trigger1,
gconstpointer trigger2); Типы trigger1 и trigger2 являются gconstpointer, только для возможности использования этой функции в качестве GCompareFunc. Каждый из них должен быть GtkShortcutTrigger.
Параметры
trigger1 | объект GtkShortcutTrigger. | [type GtkShortcutTrigger] |
trigger2 | объект GtkShortcutTrigger. | [type GtkShortcutTrigger] |
Возвращаемое значение
Целое число меньше, равно или больше нуля, если trigger1 соответственно меньше, совпадает или больше trigger2 .
gtk_shortcut_trigger_to_string ()
char *
gtk_shortcut_trigger_to_string (GtkShortcutTrigger *self); Выводит заданный триггер в читаемый человеком строковый вид. Это небольшой обертка над gtk_shortcut_trigger_print(), которая полезна при отладке.
Параметры
self | объект GtkShortcutTrigger |
Возвращаемое значение
новая строка.
[transfer full]
gtk_shortcut_trigger_print ()
void gtk_shortcut_trigger_print (GtkShortcutTrigger *self,GString *string);
Выводит заданный триггер в строковый вид для разработчиков. Предназначено для отладки и ведения журнала.
Форма представления может меняться в любое время и не гарантируется, что она останется идентичной.
Параметры
self | объект GtkShortcutTrigger | |
string | объект GString для вывода |
gtk_shortcut_trigger_to_label ()
char * gtk_shortcut_trigger_to_label (GtkShortcutTrigger *self,GdkDisplay *display);
Получает текстовое представление для данного триггера. Эта функция возвращает переведённую строку для отображения пользователю, например, в пунктах меню или в текстах справки.
Используемый display может повлиять на результирующую строку различными способами, такими как разрешение кодов клавиш аппаратной клавиатуры или вывод специфичных для дисплея имён модификаторов.
Форма представления может меняться в любое время и не гарантируется, что она останется идентичной.
Параметры
self | объект GtkShortcutTrigger | |
display | GdkDisplay для вывода |
Возвращаемое значение
новая строка.
[transfer full]
gtk_shortcut_trigger_print_label ()
gboolean gtk_shortcut_trigger_print_label (GtkShortcutTrigger *self,GdkDisplay *display,GString *string);
Выводит заданный триггер в строковый вид. Эта функция возвращает переведённую строку для отображения пользователю, например, в пунктах меню или в текстах справки.
Используемый display может повлиять на результирующую строку различными способами, такими как разрешение кодов клавиш аппаратной клавиатуры или вывод специфичных для дисплея имён модификаторов.
Форма представления может меняться в любое время и не гарантируется, что она останется идентичной.
Параметры
self | объект GtkShortcutTrigger | |
display | GdkDisplay для вывода | |
string | объект GString для вывода |
Возвращаемое значение
TRUE если что-то было выведено или FALSE если у триггера не было текстового представления, пригодного для отображения пользователю.
gtk_shortcut_trigger_parse_string ()
GtkShortcutTrigger *
gtk_shortcut_trigger_parse_string (const char *string); Пытается разобрать заданную строку в триггер. При успехе возвращается обработанный триггер. В случае неудачи возвращается NULL.
Принятые строки:
never, для GtkNeverTriggerстрока, обработанная функцией
gtk_accelerator_parse(), для GtkKeyvalTrigger, например<Control>Cподчеркивание, за которым следует один символ, для MnemonicTrigger, например
_lдве допустимые строки триггеров, разделенные символом
|, для GtkAlternativeTrigger:<Control>q|<Control>w
Обратите внимание, что вам необходимо экранировать символы < и > при указании триггеров в файлах XML, таких как файлы GtkBuilder. Используйте < вместо < и > вместо >
[конструктор]
Параметры
string | строка для разбора |
gtk_keyval_trigger_new ()
GtkShortcutTrigger * gtk_keyval_trigger_new (guint keyval,GdkModifierType modifiers);
Создает GtkShortcutTrigger, который срабатывает при нажатии клавиши с заданным keyval и modifiers.
Параметры
keyval | Значение клавиши для триггера | |
modifiers | необходимые модификаторы |
Возвращаемое значение
Новый GtkShortcutTrigger
gtk_keyval_trigger_get_modifiers ()
GdkModifierType
gtk_keyval_trigger_get_modifiers (GtkKeyvalTrigger *self); Возвращает модификаторы, которые должны быть установлены для срабатывания self.
Параметры
self | триггер GtkShortcutTrigger для получения модификаторов |
Возвращаемое значение
модификаторы
gtk_keyval_trigger_get_keyval ()
guint
gtk_keyval_trigger_get_keyval (GtkKeyvalTrigger *self); Возвращает значение клавиши, которое необходимо нажать для срабатывания self.
Параметры
self | триггер GtkShortcutTrigger для получения значения клавиши |
Возвращаемое значение
значение клавиши
gtk_mnemonic_trigger_new ()
GtkShortcutTrigger *
gtk_mnemonic_trigger_new (guint keyval); Создает GtkShortcutTrigger, который срабатывает при нажатии клавиши с заданным keyval и включении функции выделения.
Функция выделения активируется кодом при обнаружении события нажатия клавиши с соответствующими модификаторами.
Параметры
keyval | Значение клавиши для триггера |
gtk_mnemonic_trigger_get_keyval ()
guint
gtk_mnemonic_trigger_get_keyval (GtkMnemonicTrigger *self); Возвращает значение клавиши, которое необходимо нажать для срабатывания self.
Параметры
self | триггер GtkShortcutTrigger типа mnemonic |
Возвращаемое значение
значение клавиши
gtk_alternative_trigger_new ()
GtkShortcutTrigger * gtk_alternative_trigger_new (GtkShortcutTrigger *first,GtkShortcutTrigger *second);
Создаёт GtkShortcutTrigger, который срабатывает при срабатывании любого из двух заданных триггеров.
Вложенность разрешена, поэтому если требуется более двух альтернатив, создайте новый триггер для каждой опции.
Параметры
first | Первый триггер, который может сработать. | [transfer full] |
second | Второй триггер, который может сработать. | [transfer full] |
Возвращаемое значение
новый GtkShortcutTrigger
gtk_alternative_trigger_get_first ()
GtkShortcutTrigger *
gtk_alternative_trigger_get_first (GtkAlternativeTrigger *self); Возвращает первый из двух альтернативных триггеров, который может сработать. gtk_alternative_trigger_get_second() вернёт другой.
Параметры
self | альтернативный триггер GtkShortcutTrigger |
Возвращаемое значение
первый альтернативный триггер.
[transfer none]
gtk_alternative_trigger_get_second ()
GtkShortcutTrigger *
gtk_alternative_trigger_get_second (GtkAlternativeTrigger *self); Возвращает второй из двух альтернативных триггеров, который может сработать. gtk_alternative_trigger_get_first() вернёт первый.
Параметры
self | альтернативный триггер GtkShortcutTrigger |
Возвращаемое значение
второй альтернативный триггер.
[transfer none]
gtk_never_trigger_get ()
GtkShortcutTrigger *
gtk_never_trigger_get (void); Возвращает триггер, который никогда не срабатывает. Это синглтон для триггера, который никогда не срабатывает. Используйте этот триггер вместо NULL, так как он реализует все виртуальные функции.
Возвращаемое значение
триггер, который никогда не срабатывает.
[type GtkNeverTrigger][transfer none]
Типы и значения
GtkShortcutTrigger
typedef struct _GtkShortcutTrigger GtkShortcutTrigger;
Триггер для сочетания клавиш.
GtkKeyvalTrigger
typedef struct _GtkKeyvalTrigger GtkKeyvalTrigger;
A GtkShortcutTrigger что срабатывает при нажатии определённого значения клавиши и (необязательно) модификаторов.
GtkMnemonicTrigger
typedef struct _GtkMnemonicTrigger GtkMnemonicTrigger;
A GtkShortcutTrigger срабатывает при нажатии определённого символа-мнемоники.
GtkAlternativeTrigger
typedef struct _GtkAlternativeTrigger GtkAlternativeTrigger;
A GtkShortcutTrigger который срабатывает при активации любого из двух GtkShortcutTriggers.
GtkNeverTrigger
typedef struct _GtkNeverTrigger GtkNeverTrigger;
A GtkShortcutTrigger который никогда не срабатывает.
См. также
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer-old.gnome.org/gtk4/4.0/GtkShortcutTrigger.html