Группы ускорителей
Группы ускорителей — группы глобальных клавишных ускорителей для всего 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, и активирует его.
Параметры
accel_group | объект GtkAccelGroup | |
accel_quark | кворк для имени акселератора | |
acceleratable | GObject, обычно GtkWindow, на котором активировать акселератор | |
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 |
С: 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 |
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);
Определяет, является ли заданное значение клавиши и маска модификаторов допустимым акселератором клавиатуры. Например, значение клавиши GDK_KEY_a плюс GDK_CONTROL_MASK является допустимым — это акселератор «Ctrl+a». Но, например, вы не можете использовать значение клавиши GDK_KEY_Control_L в качестве акселератора.
Параметры
keyval | значение клавиши GDK | |
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 zero-terminated=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.22/gtk3-Keyboard-Accelerators.html