1/*
2 * Copyright © 2018 Benjamin Otte
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 *
17 * Authors: Benjamin Otte <otte@gnome.org>
18 */
19
20#ifndef __GTK_SHORTCUT_TRIGGER_H__
21#define __GTK_SHORTCUT_TRIGGER_H__
22
23#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
24#error "Only <gtk/gtk.h> can be included directly."
25#endif
26
27#include <gtk/gtktypes.h>
28
29G_BEGIN_DECLS
30
31#define GTK_TYPE_SHORTCUT_TRIGGER (gtk_shortcut_trigger_get_type ())
32
33GDK_AVAILABLE_IN_ALL
34GDK_DECLARE_INTERNAL_TYPE (GtkShortcutTrigger, gtk_shortcut_trigger, GTK, SHORTCUT_TRIGGER, GObject)
35
36GDK_AVAILABLE_IN_ALL
37GtkShortcutTrigger * gtk_shortcut_trigger_parse_string (const char *string);
38
39GDK_AVAILABLE_IN_ALL
40char * gtk_shortcut_trigger_to_string (GtkShortcutTrigger *self);
41GDK_AVAILABLE_IN_ALL
42void gtk_shortcut_trigger_print (GtkShortcutTrigger *self,
43 GString *string);
44GDK_AVAILABLE_IN_ALL
45char * gtk_shortcut_trigger_to_label (GtkShortcutTrigger *self,
46 GdkDisplay *display);
47GDK_AVAILABLE_IN_ALL
48gboolean gtk_shortcut_trigger_print_label (GtkShortcutTrigger *self,
49 GdkDisplay *display,
50 GString *string);
51
52GDK_AVAILABLE_IN_ALL
53guint gtk_shortcut_trigger_hash (gconstpointer trigger);
54GDK_AVAILABLE_IN_ALL
55gboolean gtk_shortcut_trigger_equal (gconstpointer trigger1,
56 gconstpointer trigger2);
57GDK_AVAILABLE_IN_ALL
58int gtk_shortcut_trigger_compare (gconstpointer trigger1,
59 gconstpointer trigger2);
60
61GDK_AVAILABLE_IN_ALL
62GdkKeyMatch gtk_shortcut_trigger_trigger (GtkShortcutTrigger *self,
63 GdkEvent *event,
64 gboolean enable_mnemonics);
65
66
67#define GTK_TYPE_NEVER_TRIGGER (gtk_never_trigger_get_type())
68
69/**
70 * GtkNeverTrigger:
71 *
72 * A `GtkShortcutTrigger` that never triggers.
73 */
74GDK_AVAILABLE_IN_ALL
75GDK_DECLARE_INTERNAL_TYPE (GtkNeverTrigger, gtk_never_trigger, GTK, NEVER_TRIGGER, GtkShortcutTrigger)
76
77GDK_AVAILABLE_IN_ALL
78GtkShortcutTrigger * gtk_never_trigger_get (void);
79
80#define GTK_TYPE_KEYVAL_TRIGGER (gtk_keyval_trigger_get_type())
81
82/**
83 * GtkKeyvalTrigger:
84 *
85 * A `GtkShortcutTrigger` that triggers when a specific keyval and modifiers are pressed.
86 */
87
88GDK_AVAILABLE_IN_ALL
89GDK_DECLARE_INTERNAL_TYPE (GtkKeyvalTrigger, gtk_keyval_trigger, GTK, KEYVAL_TRIGGER, GtkShortcutTrigger)
90
91GDK_AVAILABLE_IN_ALL
92GtkShortcutTrigger * gtk_keyval_trigger_new (guint keyval,
93 GdkModifierType modifiers);
94GDK_AVAILABLE_IN_ALL
95GdkModifierType gtk_keyval_trigger_get_modifiers (GtkKeyvalTrigger *self);
96GDK_AVAILABLE_IN_ALL
97guint gtk_keyval_trigger_get_keyval (GtkKeyvalTrigger *self);
98
99#define GTK_TYPE_MNEMONIC_TRIGGER (gtk_mnemonic_trigger_get_type())
100
101/**
102 * GtkMnemonicTrigger:
103 *
104 * A `GtkShortcutTrigger` that triggers when a specific mnemonic is pressed.
105 *
106 * Mnemonics require a *mnemonic modifier* (typically <kbd>Alt</kbd>) to be
107 * pressed together with the mnemonic key.
108 */
109GDK_AVAILABLE_IN_ALL
110GDK_DECLARE_INTERNAL_TYPE (GtkMnemonicTrigger, gtk_mnemonic_trigger, GTK, MNEMONIC_TRIGGER, GtkShortcutTrigger)
111
112GDK_AVAILABLE_IN_ALL
113GtkShortcutTrigger * gtk_mnemonic_trigger_new (guint keyval);
114GDK_AVAILABLE_IN_ALL
115guint gtk_mnemonic_trigger_get_keyval (GtkMnemonicTrigger *self);
116
117#define GTK_TYPE_ALTERNATIVE_TRIGGER (gtk_alternative_trigger_get_type())
118
119/**
120 * GtkAlternativeTrigger:
121 *
122 * A `GtkShortcutTrigger` that combines two triggers.
123 *
124 * The `GtkAlternativeTrigger` triggers when either of two trigger.
125 *
126 * This can be cascaded to combine more than two triggers.
127 */
128
129GDK_AVAILABLE_IN_ALL
130GDK_DECLARE_INTERNAL_TYPE (GtkAlternativeTrigger, gtk_alternative_trigger, GTK, ALTERNATIVE_TRIGGER, GtkShortcutTrigger)
131
132GDK_AVAILABLE_IN_ALL
133GtkShortcutTrigger * gtk_alternative_trigger_new (GtkShortcutTrigger *first,
134 GtkShortcutTrigger *second);
135GDK_AVAILABLE_IN_ALL
136GtkShortcutTrigger * gtk_alternative_trigger_get_first (GtkAlternativeTrigger *self);
137GDK_AVAILABLE_IN_ALL
138GtkShortcutTrigger * gtk_alternative_trigger_get_second (GtkAlternativeTrigger *self);
139
140G_END_DECLS
141
142#endif /* __GTK_SHORTCUT_TRIGGER_H__ */
143

source code of gtk/gtk/gtkshortcuttrigger.h