Группы ускорителей
Группы ускорителей — это группы глобальных клавишных сочетаний для всего GtkWindow.
Функции
Свойства
| gboolean | is-locked | Чтение |
| GdkModifierType | modifier-mask | Чтение |
Сигналы
Типы и значения
| структура | GtkAccelGroup |
| структура | GtkAccelGroupClass |
| перечисление | GtkAccelFlags |
| структура | GtkAccelKey |
Иерархия объектов
GObject ╰── GtkAccelGroup
Файлы
#include <gtk/gtk.h>
Описание
Объект GtkAccelGroup представляет собой группу клавишных сокращений, обычно прикреплённых к главному окну GtkWindow (с помощью gtk_window_add_accel_group()). Обычно нет необходимости создавать GtkAccelGroup напрямую; вместо этого при использовании GtkUIManager, GTK+ автоматически настраивает сокращения для ваших меню в GtkAccelGroup менеджера пользовательского интерфейса.
Обратите внимание, что «сокращения» отличаются от «мнемоник». Сокращения — это комбинации клавиш для активации пункта меню; они отображаются вместе с пунктом меню, для которого они являются сокращениями. Например, «Ctrl+Q» может отображаться вместе с пунктом меню «Выход». Мнемоники — это сокращения для элементов графического интерфейса, таких как текстовые поля или кнопки; они отображаются в виде подчеркнутых символов. См. gtk_label_new_with_mnemonic(). Пункты меню могут иметь как сокращения, так и мнемоники.
Функции
gtk_accel_group_new ()
GtkAccelGroup *
gtk_accel_group_new (void); Создаёт новую GtkAccelGroup.
Возвращает
новый объект GtkAccelGroup
gtk_accel_group_connect ()
void gtk_accel_group_connect (GtkAccelGroup *accel_group,guint accel_key,GdkModifierType accel_mods,GtkAccelFlags accel_flags,GClosure *closure);
Устанавливает ускоритель в этой группе. Когда accel_group активируется в ответ на вызов gtk_accel_groups_activate(), closure будет вызвано, если accel_key и accel_mods из gtk_accel_groups_activate() совпадают с этими значениями.
Подпись, используемая для closure, такая же, как у GtkAccelGroupActivate.
Обратите внимание, что из-за особенностей реализации, единственное замыкание может быть подключено только к одной группе ускорителей.
Параметры
accel_group | группа ускорителей, в которую необходимо установить ускоритель | |
accel_key | значение ключа ускорителя | |
accel_mods | комбинация модификаторов ускорителя | |
accel_flags | флаги для настройки этого ускорителя | |
closure | замыкание, которое будет выполнено при активации ускорителя |
gtk_accel_group_connect_by_path ()
void gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group,const gchar *accel_path,GClosure *closure);
Устанавливает ускоритель в этой группе, используя путь ускорителя для поиска соответствующего ключа и модификаторов (см. gtk_accel_map_add_entry()). Когда accel_group активируется в ответ на вызов gtk_accel_groups_activate(), closure будет вызвано, если accel_key и accel_mods из gtk_accel_groups_activate() соответствуют ключу и модификаторам для этого пути.
Подпись, используемая для closure, такая же, как у GtkAccelGroupActivate.
Обратите внимание, что строка accel_path будет храниться в GQuark. Поэтому, если вы передаёте статическую строку, вы можете сэкономить память, предварительно интернировав её с помощью g_intern_static_string().
Параметры
accel_group | группа ускорителей, в которую необходимо установить ускоритель | |
accel_path | путь, используемый для определения ключа и модификаторов | |
closure | замыкание, которое будет выполнено при активации ускорителя |
GtkAccelGroupActivate ()
gboolean (*GtkAccelGroupActivate) (GtkAccelGroup *accel_group,GObject *acceleratable,guint keyval,GdkModifierType modifier);
GtkAccelGroupFindFunc ()
gboolean (*GtkAccelGroupFindFunc) (GtkAccelKey *key,GClosure *closure,gpointer data);
Параметры
data | . | [closure] |
С: 2.2
gtk_accel_group_disconnect ()
gboolean gtk_accel_group_disconnect (GtkAccelGroup *accel_group,GClosure *closure);
Удаляет ранее установленный ускоритель через gtk_accel_group_connect().
С версии 2.20 closure может быть NULL.
Параметры
accel_group | группа ускорителей, из которой необходимо удалить ускоритель | |
closure | замыкание для удаления из этой группы ускорителей, или | [allow-none] |
Возвращает
TRUE, если замыкание найдено и отключено
gtk_accel_group_disconnect_key ()
gboolean gtk_accel_group_disconnect_key (GtkAccelGroup *accel_group,guint accel_key,GdkModifierType accel_mods);
Удаляет ранее установленный ускоритель через gtk_accel_group_connect().
Параметры
accel_group | группа ускорителей, в которую необходимо установить ускоритель | |
accel_key | значение ключа ускорителя | |
accel_mods | комбинация модификаторов ускорителя |
gtk_accel_group_activate ()
gboolean gtk_accel_group_activate (GtkAccelGroup *accel_group,GQuark accel_quark,GObject *acceleratable,guint accel_key,GdkModifierType accel_mods);
Ищет первый ускоритель в accel_group, который соответствует accel_key и accel_mods, и активирует его.
Параметры
Возвращает
TRUE, если ускоритель был активирован и обработано это нажатие клавиши
gtk_accel_group_lock ()
void
gtk_accel_group_lock (GtkAccelGroup *accel_group); Блокирует заданную группу ускорителей.
Блокировка группы ускорителей предотвращает изменение ускорителей внутри неё во время выполнения. Обратитесь к gtk_accel_map_change_entry() для получения информации об изменениях ускорителей во время выполнения.
Если вызов осуществляется более одного раза, accel_group остаётся заблокированной до тех пор, пока не будет вызван gtk_accel_group_unlock() эквивалентное количество раз.
Параметры
accel_group |
gtk_accel_group_unlock ()
void
gtk_accel_group_unlock (GtkAccelGroup *accel_group); Отменяет последнее обращение к gtk_accel_group_lock() для этой accel_group.
Параметры
accel_group |
gtk_accel_group_get_is_locked ()
gboolean
gtk_accel_group_get_is_locked (GtkAccelGroup *accel_group); Блокировки добавляются и удаляются с помощью gtk_accel_group_lock() и gtk_accel_group_unlock().
Параметры
accel_group |
Возвращаемое значение
TRUE, если на accel_group есть 1 или более блокировок, FALSE в противном случае.
С: 2.14
gtk_accel_group_from_accel_closure ()
GtkAccelGroup *
gtk_accel_group_from_accel_closure (GClosure *closure); Находит GtkAccelGroup, к которому подключена closure; см. gtk_accel_group_connect().
Параметры
closure | a GClosure |
Возвращаемое значение
GtkAccelGroup к которому подключена closure или NULL.
[nullable][transfer none]
gtk_accel_group_get_modifier_mask ()
GdkModifierType
gtk_accel_group_get_modifier_mask (GtkAccelGroup *accel_group); Получает GdkModifierType, представляющий маску для этой accel_group. Например, GDK_CONTROL_MASK, GDK_SHIFT_MASK и т.д.
Параметры
accel_group |
Возвращаемое значение
маска модификаторов для этой группы ускорителей.
С: 2.14
gtk_accel_groups_activate ()
gboolean gtk_accel_groups_activate (GObject *object,guint accel_key,GdkModifierType accel_mods);
Находит первый ускоритель в любой GtkAccelGroup, прикреплённой к object, который соответствует accel_key и accel_mods, и активирует этот ускоритель.
Параметры
Возвращаемое значение
TRUE, если ускоритель был активирован и обработал нажатие клавиши
gtk_accel_groups_from_object ()
GSList *
gtk_accel_groups_from_object (GObject *object); Получает список всех групп ускорителей, прикреплённых к object.
Возвращаемое значение
список всех групп ускорителей, прикреплённых к object.
[element-type GtkAccelGroup][transfer none]
gtk_accel_group_find ()
GtkAccelKey * gtk_accel_group_find (GtkAccelGroup *accel_group,GtkAccelGroupFindFunc find_func,gpointer data);
Находит первую запись в группе ускорителей, для которой find_func возвращает TRUE, и возвращает его GtkAccelKey.
Параметры
accel_group | ||
find_func | функция для фильтрации записей | [scope call] |
data | данные для передачи в |
Возвращаемое значение
ключ первой записи, проходящей проверку find_func. Ключ принадлежит GTK+ и не должен освобождаться.
[transfer none]
gtk_accelerator_valid ()
gboolean gtk_accelerator_valid (guint keyval,GdkModifierType modifiers);
Определяет, являются ли заданные keyval и modifier mask действительным клавиатурным ускорителем. Например, keyval GDK_KEY_a плюс GDK_CONTROL_MASK — это действительный ускоритель «Ctrl+a». Но, например, вы не можете использовать keyval GDK_KEY_Control_L в качестве ускорителя.
Параметры
keyval | GDK keyval | |
modifiers | маска модификаторов |
Возвращаемое значение
TRUE, если ускоритель действителен
gtk_accelerator_parse ()
void gtk_accelerator_parse (const gchar *accelerator,guint *accelerator_key,GdkModifierType *accelerator_mods);
Разбирает строку, представляющую сочетание клавиш. Формат похож на «<Control>a» или «<Shift><Alt>F1» или «<Release>z» (последнее для отпускания клавиши).
Парсер довольно либерален и допускает использование прописных и строчных букв, а также сокращения, такие как «<Ctl>» и «<Ctrl>». Названия клавиш анализируются с помощью gdk_keyval_from_name(). Для символьных клавиш имя не является символом, а строчным именем, например, следует использовать «<Ctrl>minus» вместо «<Ctrl>-».
Если разбор не удался, accelerator_key и accelerator_mods будут установлены в 0 (ноль).
gtk_accelerator_name ()
gchar * gtk_accelerator_name (guint accelerator_key,GdkModifierType accelerator_mods);
Преобразует код клавиши сочетания и маску модификаторов в строку, которую можно разобрать с помощью gtk_accelerator_parse(). Например, если вы передаете GDK_KEY_q и GDK_CONTROL_MASK, эта функция возвращает «<Control>q».
Если вам нужно отобразить сочетания клавиш в пользовательском интерфейсе, см. gtk_accelerator_get_label().
Параметры
accelerator_key | код клавиши сочетания | |
accelerator_mods | маска модификаторов сочетания |
Возвращает
имя сочетания клавиш (выделяется память под него)
gtk_accelerator_get_label ()
gchar * gtk_accelerator_get_label (guint accelerator_key,GdkModifierType accelerator_mods);
Преобразует код клавиши сочетания и маску модификаторов в строку, которую можно использовать для представления сочетания клавиш для пользователя.
Параметры
accelerator_key | код клавиши сочетания | |
accelerator_mods | маска модификаторов сочетания |
Возвращает
выделенную строку, представляющую сочетание клавиш.
С: 2.6
gtk_accelerator_parse_with_keycode ()
void gtk_accelerator_parse_with_keycode (const gchar *accelerator,guint *accelerator_key,guint **accelerator_codes,GdkModifierType *accelerator_mods);
Разбирает строку, представляющую сочетание клавиш, аналогично gtk_accelerator_parse(), но также обрабатывает коды клавиш. Это полезно только для компонентов системного уровня, приложения должны использовать gtk_accelerator_parse() вместо этого.
Если accelerator_codes задано и результат, сохранённый в нём, не NULL, результат должен быть освобождён с помощью g_free().
Если в сочетании клавиш есть код клавиши и accelerator_codes не указан, разбор завершится неудачей.
Если разбор не удался, accelerator_key , accelerator_mods и accelerator_codes будут установлены в 0 (ноль).
Параметры
accelerator | строка, представляющая сочетание клавиш | |
accelerator_key | место для возврата кода клавиши сочетания, или | [out][allow-none] |
accelerator_codes | место для возврата кодов клавиш сочетания, или | [out][array нуль-терминированный=1][transfer full][allow-none] |
accelerator_mods | место для возврата маски модификаторов сочетания клавиш, | [out][allow-none] |
С: 3.4
gtk_accelerator_name_with_keycode ()
gchar * gtk_accelerator_name_with_keycode (GdkDisplay *display,guint accelerator_key,guint keycode,GdkModifierType accelerator_mods);
Преобразует код клавиши сочетания и маску модификаторов в строку, которую можно разобрать с помощью gtk_accelerator_parse_with_keycode(), аналогично gtk_accelerator_name(), но учитывая коды клавиш. Это полезно только для компонентов системного уровня, приложения должны использовать gtk_accelerator_parse() вместо этого.
Параметры
display | GdkDisplay или | [allow-none] |
accelerator_key | код клавиши сочетания | |
keycode | код клавиши сочетания | |
accelerator_mods | маска модификаторов сочетания |
Возвращает
выделенное имя сочетания клавиш.
С: 3.4
gtk_accelerator_get_label_with_keycode ()
gchar * gtk_accelerator_get_label_with_keycode (GdkDisplay *display,guint accelerator_key,guint keycode,GdkModifierType accelerator_mods);
Преобразует значение клавиши и маску модификаторов акселератора в (возможно переведённую) строку, которая может быть отображена пользователю, аналогично gtk_accelerator_get_label(), но обрабатывает коды клавиш.
Это полезно только для компонентов системного уровня, приложения должны использовать gtk_accelerator_parse() вместо этого.
Параметры
display | GdkDisplay или | [allow-none] |
accelerator_key | значение клавиши акселератора | |
keycode | код клавиши акселератора | |
accelerator_mods | маска модификаторов акселератора |
Возвращаемое значение
новый выделенный строковый объект, представляющий акселератор.
С: 3.4
gtk_accelerator_set_default_mod_mask ()
void
gtk_accelerator_set_default_mod_mask (GdkModifierType default_mod_mask); Устанавливает модификаторы, которые будут считаться значимыми для клавиш акселератора. Маска по умолчанию зависит от используемого бэкэнда GDK, но обычно включает GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK | GDK_SUPER_MASK | GDK_HYPER_MASK | GDK_META_MASK. Другими словами, Control, Shift, Alt, Super, Hyper и Meta. Другие модификаторы по умолчанию будут игнорироваться GtkAccelGroup.
Вы должны включить как минимум три модификатора: Control, Shift и Alt в любом значении, которое вы передаёте в эту функцию.
Маска модификаторов по умолчанию должна изменяться при запуске приложения, до использования каких-либо групп акселераторов.
Параметры
default_mod_mask | маска модификаторов акселератора |
gtk_accelerator_get_default_mod_mask ()
GdkModifierType
gtk_accelerator_get_default_mod_mask (void); Получает маску модификаторов.
Маска модификаторов определяет, какие модификаторы считаются значимыми для клавиш акселератора. См. gtk_accelerator_set_default_mod_mask().
Возвращаемое значение
маска модификаторов акселератора по умолчанию
Типы и значения
struct GtkAccelGroup
struct GtkAccelGroup;
Объект, представляющий и поддерживающий группу акселераторов.
struct GtkAccelGroupClass
struct GtkAccelGroupClass {
GObjectClass parent_class;
void (*accel_changed) (GtkAccelGroup *accel_group,
guint keyval,
GdkModifierType modifier,
GClosure *accel_closure);
};
Члены
| Сигнал, генерируемый при добавлении или удалении записи из группы акселераторов. |
enum GtkAccelFlags
Флаги акселератора, используемые с gtk_accel_group_connect().
Члены
GTK_ACCEL_VISIBLE | Акселератор видимый | |
GTK_ACCEL_LOCKED | Акселератор не удаляемый | |
GTK_ACCEL_MASK | Маска |
struct GtkAccelKey
struct GtkAccelKey {
guint accel_key;
GdkModifierType accel_mods;
guint accel_flags : 16;
};
Члены
guint | Значение клавиши акселератора | |
GdkModifierType | Модификаторы акселератора | |
guint | Флаги акселератора |
Подробное описание свойств
Свойство “is-locked”
“is-locked” gboolean
Закрыта ли группа акселераторов.
Флаги: Чтение
Значение по умолчанию: ЛОЖЬ
Подробности сигналов
Сигнал “accel-activate”
gboolean user_function (GtkAccelGroup *accel_group, GObject *acceleratable, guint keyval, GdkModifierType modifier, gpointer user_data)
Сигнал accel-activate — это деталь реализации GtkAccelGroup, и приложениями он не предназначен для использования.
Параметры
accel_group | группа GtkAccelGroup, получившая сигнал | |
acceleratable | объект, на котором был активирован ускоритель | |
keyval | значение клавиши ускорителя | |
modifier | комбинация модификаторов ускорителя | |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Возвращаемое значение
TRUE, если ускоритель был активирован
Флаги: Подробная информация
Сигнал “accel-changed”
void user_function (GtkAccelGroup *accel_group, guint keyval, GdkModifierType modifier, GClosure *accel_closure, gpointer user_data)
Сигнал accel-changed генерируется при добавлении или удалении записи из группы ускорителей.
Элементы управления, такие как GtkAccelLabel, отображающие связанный ускоритель, должны подключаться к этому сигналу и перестраивать своё визуальное представление, если accel_closure принадлежит им.
Параметры
accel_group | группа GtkAccelGroup, получившая сигнал | |
keyval | значение клавиши ускорителя | |
modifier | комбинация модификаторов ускорителя | |
accel_closure | замыкание GClosure ускорителя | |
user_data | данные пользователя, заданные при подключении обработчика сигнала. |
Флаги: Подробная информация
См. также
gtk_window_add_accel_group(), gtk_accel_map_change_entry(), gtk_item_factory_new(), gtk_label_new_with_mnemonic()
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.20/gtk3-Keyboard-Accelerators.html