1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2000-2001 Red Hat, Inc.
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 of the License, or (at your option) any later version.
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.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 #ifndef __G_SIGNAL_H__
20 #define __G_SIGNAL_H__
23 #include <gobject/gclosure.h>
24 #include <gobject/gvalue.h>
25 #include <gobject/gparam.h>
26 #include <gobject/gmarshal.h>
30 /* --- typedefs --- */
31 typedef struct _GSignalQuery GSignalQuery
;
32 typedef struct _GSignalInvocationHint GSignalInvocationHint
;
33 typedef GClosureMarshal GSignalCMarshaller
;
34 typedef gboolean (*GSignalEmissionHook
) (GSignalInvocationHint
*ihint
,
36 const GValue
*param_values
,
38 typedef gboolean (*GSignalAccumulator
) (GSignalInvocationHint
*ihint
,
40 const GValue
*handler_return
,
44 /* --- run, match and connect types --- */
47 G_SIGNAL_RUN_FIRST
= 1 << 0,
48 G_SIGNAL_RUN_LAST
= 1 << 1,
49 G_SIGNAL_RUN_CLEANUP
= 1 << 2,
50 G_SIGNAL_NO_RECURSE
= 1 << 3,
51 G_SIGNAL_DETAILED
= 1 << 4,
52 G_SIGNAL_ACTION
= 1 << 5,
53 G_SIGNAL_NO_HOOKS
= 1 << 6
55 #define G_SIGNAL_FLAGS_MASK 0x7f
58 G_CONNECT_AFTER
= 1 << 0,
59 G_CONNECT_SWAPPED
= 1 << 1
63 G_SIGNAL_MATCH_ID
= 1 << 0,
64 G_SIGNAL_MATCH_DETAIL
= 1 << 1,
65 G_SIGNAL_MATCH_CLOSURE
= 1 << 2,
66 G_SIGNAL_MATCH_FUNC
= 1 << 3,
67 G_SIGNAL_MATCH_DATA
= 1 << 4,
68 G_SIGNAL_MATCH_UNBLOCKED
= 1 << 5
70 #define G_SIGNAL_MATCH_MASK 0x3f
71 #define G_SIGNAL_TYPE_STATIC_SCOPE (G_TYPE_FLAG_RESERVED_ID_BIT)
74 /* --- signal information --- */
75 struct _GSignalInvocationHint
79 GSignalFlags run_type
;
84 const gchar
*signal_name
;
85 GType itype
; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
86 GSignalFlags signal_flags
;
87 GType return_type
; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
89 const GType
*param_types
;
94 guint
g_signal_newv (const gchar
*signal_name
,
96 GSignalFlags signal_flags
,
97 GClosure
*class_closure
,
98 GSignalAccumulator accumulator
,
100 GSignalCMarshaller c_marshaller
,
104 guint
g_signal_new_valist (const gchar
*signal_name
,
106 GSignalFlags signal_flags
,
107 GClosure
*class_closure
,
108 GSignalAccumulator accumulator
,
110 GSignalCMarshaller c_marshaller
,
114 guint
g_signal_new (const gchar
*signal_name
,
116 GSignalFlags signal_flags
,
118 GSignalAccumulator accumulator
,
120 GSignalCMarshaller c_marshaller
,
124 void g_signal_emitv (const GValue
*instance_and_params
,
127 GValue
*return_value
);
128 void g_signal_emit_valist (gpointer instance
,
132 void g_signal_emit (gpointer instance
,
136 void g_signal_emit_by_name (gpointer instance
,
137 const gchar
*detailed_signal
,
139 guint
g_signal_lookup (const gchar
*name
,
141 G_CONST_RETURN gchar
* g_signal_name (guint signal_id
);
142 void g_signal_query (guint signal_id
,
143 GSignalQuery
*query
);
144 guint
* g_signal_list_ids (GType itype
,
146 gboolean
g_signal_parse_name (const gchar
*detailed_signal
,
150 gboolean force_detail_quark
);
153 /* --- signal emissions --- */
154 void g_signal_stop_emission (gpointer instance
,
157 void g_signal_stop_emission_by_name (gpointer instance
,
158 const gchar
*detailed_signal
);
159 gulong
g_signal_add_emission_hook (guint signal_id
,
161 GSignalEmissionHook hook_func
,
163 GDestroyNotify data_destroy
);
164 void g_signal_remove_emission_hook (guint signal_id
,
168 /* --- signal handlers --- */
169 gboolean
g_signal_has_handler_pending (gpointer instance
,
172 gboolean may_be_blocked
);
173 gulong
g_signal_connect_closure_by_id (gpointer instance
,
178 gulong
g_signal_connect_closure (gpointer instance
,
179 const gchar
*detailed_signal
,
182 gulong
g_signal_connect_data (gpointer instance
,
183 const gchar
*detailed_signal
,
186 GClosureNotify destroy_data
,
187 GConnectFlags connect_flags
);
188 void g_signal_handler_block (gpointer instance
,
190 void g_signal_handler_unblock (gpointer instance
,
192 void g_signal_handler_disconnect (gpointer instance
,
194 gboolean
g_signal_handler_is_connected (gpointer instance
,
196 gulong
g_signal_handler_find (gpointer instance
,
197 GSignalMatchType mask
,
203 guint
g_signal_handlers_block_matched (gpointer instance
,
204 GSignalMatchType mask
,
210 guint
g_signal_handlers_unblock_matched (gpointer instance
,
211 GSignalMatchType mask
,
217 guint
g_signal_handlers_disconnect_matched (gpointer instance
,
218 GSignalMatchType mask
,
226 /* --- convenience --- */
227 #define g_signal_connect(instance, detailed_signal, c_handler, data) \
228 g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, 0)
229 #define g_signal_connect_swapped(instance, detailed_signal, c_handler, data) \
230 g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, G_CONNECT_SWAPPED)
231 #define g_signal_handlers_disconnect_by_func(instance, func, data) \
232 g_signal_handlers_disconnect_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
233 0, 0, NULL, (func), (data))
234 #define g_signal_handlers_block_by_func(instance, func, data) \
235 g_signal_handlers_block_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
236 0, 0, NULL, (func), (data))
237 #define g_signal_handlers_unblock_by_func(instance, func, data) \
238 g_signal_handlers_unblock_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
239 0, 0, NULL, (func), (data))
241 #ifndef G_DISABLE_COMPAT
242 /* tmp compat, to be nuked soon */
243 #define g_signal_connectc(instance, detailed_signal, c_handler, data, swapped) \
244 g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, (swapped)?G_CONNECT_SWAPPED:0);
245 #define g_signal_newc g_signal_new
246 #define g_signal_disconnect_by_func g_signal_handlers_disconnect_by_func
247 #define g_signal_block_by_func g_signal_handlers_block_by_func
248 #define g_signal_unblock_by_func g_signal_handlers_unblock_by_func
252 void g_signal_handlers_destroy (gpointer instance
);
253 void _g_signals_destroy (GType itype
);
257 #endif /* __G_SIGNAL_H__ */