pidgin/pidginkeypad.h

changeset 41478
27d70d93355d
child 42465
b7d530551c1b
equal deleted inserted replaced
41477:34907838c401 41478:27d70d93355d
1 /*
2 * Pidgin - Internet Messenger
3 * Copyright (C) Pidgin Developers <devel@pidgin.im>
4 *
5 * Pidgin is the legal property of its developers, whose names are too numerous
6 * to list here. Please refer to the COPYRIGHT file distributed with this
7 * source distribution.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, see <https://www.gnu.org/licenses/>.
21 */
22
23 #if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
24 # error "only <pidgin.h> may be included directly"
25 #endif
26
27 #ifndef PIDGIN_KEYPAD_H
28 #define PIDGIN_KEYPAD_H
29
30 #include <gtk/gtk.h>
31
32 #include <purple.h>
33
34 /**
35 * PidginKeypad:
36 *
37 * #PidginKeypad is a widget that displays a DTMF keypad, with the digits 0-9,
38 * an asterisk, and a number sign.
39 *
40 * Since: 3.0.0
41 */
42
43 G_BEGIN_DECLS
44
45 #define PIDGIN_TYPE_KEYPAD pidgin_keypad_get_type()
46 G_DECLARE_FINAL_TYPE(PidginKeypad, pidgin_keypad, PIDGIN, KEYPAD, GtkGrid)
47
48 /**
49 * pidgin_keypad_new:
50 *
51 * Creates a new #PidginKeypad.
52 *
53 * Returns: (transfer full): The new instance.
54 *
55 * Since: 3.0.0
56 */
57 GtkWidget *pidgin_keypad_new(void);
58
59 /**
60 * pidgin_keypad_set_key_capture_widget:
61 * @keypad: The keypad.
62 * @widget: A widget to capture keys from.
63 *
64 * Sets @widget as the widget that @keypad will capture key events from.
65 *
66 * If key events are handled by the keypad, the DTMF digits will be captured
67 * and trigger the pressed signal on @keypad.
68 *
69 * Since: 3.0.0
70 */
71 void pidgin_keypad_set_key_capture_widget(PidginKeypad *keypad, GtkWidget *widget);
72
73 G_END_DECLS
74
75 #endif /* PIDGIN_KEYPAD_H */

mercurial