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 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
20 #error "Only <glib-object.h> can be included directly."
23 #ifndef __G_SIGNAL_H__
24 #define __G_SIGNAL_H__
26 #include <gobject/gclosure.h>
27 #include <gobject/gvalue.h>
28 #include <gobject/gparam.h>
29 #include <gobject/gmarshal.h>
33 /* --- typedefs --- */
34 typedef struct _GSignalQuery GSignalQuery
;
35 typedef struct _GSignalInvocationHint GSignalInvocationHint
;
36 typedef GClosureMarshal GSignalCMarshaller
;
37 typedef gboolean (*GSignalEmissionHook
) (GSignalInvocationHint
*ihint
,
39 const GValue
*param_values
,
41 typedef gboolean (*GSignalAccumulator
) (GSignalInvocationHint
*ihint
,
43 const GValue
*handler_return
,
47 /* --- run, match and connect types --- */
50 G_SIGNAL_RUN_FIRST
= 1 << 0,
51 G_SIGNAL_RUN_LAST
= 1 << 1,
52 G_SIGNAL_RUN_CLEANUP
= 1 << 2,
53 G_SIGNAL_NO_RECURSE
= 1 << 3,
54 G_SIGNAL_DETAILED
= 1 << 4,
55 G_SIGNAL_ACTION
= 1 << 5,
56 G_SIGNAL_NO_HOOKS
= 1 << 6
58 #define G_SIGNAL_FLAGS_MASK 0x7f
61 G_CONNECT_AFTER
= 1 << 0,
62 G_CONNECT_SWAPPED
= 1 << 1
66 G_SIGNAL_MATCH_ID
= 1 << 0,
67 G_SIGNAL_MATCH_DETAIL
= 1 << 1,
68 G_SIGNAL_MATCH_CLOSURE
= 1 << 2,
69 G_SIGNAL_MATCH_FUNC
= 1 << 3,
70 G_SIGNAL_MATCH_DATA
= 1 << 4,
71 G_SIGNAL_MATCH_UNBLOCKED
= 1 << 5
73 #define G_SIGNAL_MATCH_MASK 0x3f
74 #define G_SIGNAL_TYPE_STATIC_SCOPE (G_TYPE_FLAG_RESERVED_ID_BIT)
77 /* --- signal information --- */
78 struct _GSignalInvocationHint
82 GSignalFlags run_type
;
87 const gchar
*signal_name
;
89 GSignalFlags signal_flags
;
90 GType return_type
; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
92 const GType
*param_types
; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
97 guint
g_signal_newv (const gchar
*signal_name
,
99 GSignalFlags signal_flags
,
100 GClosure
*class_closure
,
101 GSignalAccumulator accumulator
,
103 GSignalCMarshaller c_marshaller
,
107 guint
g_signal_new_valist (const gchar
*signal_name
,
109 GSignalFlags signal_flags
,
110 GClosure
*class_closure
,
111 GSignalAccumulator accumulator
,
113 GSignalCMarshaller c_marshaller
,
117 guint
g_signal_new (const gchar
*signal_name
,
119 GSignalFlags signal_flags
,
121 GSignalAccumulator accumulator
,
123 GSignalCMarshaller c_marshaller
,
127 void g_signal_emitv (const GValue
*instance_and_params
,
130 GValue
*return_value
);
131 void g_signal_emit_valist (gpointer instance
,
135 void g_signal_emit (gpointer instance
,
139 void g_signal_emit_by_name (gpointer instance
,
140 const gchar
*detailed_signal
,
142 guint
g_signal_lookup (const gchar
*name
,
144 G_CONST_RETURN gchar
* g_signal_name (guint signal_id
);
145 void g_signal_query (guint signal_id
,
146 GSignalQuery
*query
);
147 guint
* g_signal_list_ids (GType itype
,
149 gboolean
g_signal_parse_name (const gchar
*detailed_signal
,
153 gboolean force_detail_quark
);
154 GSignalInvocationHint
* g_signal_get_invocation_hint (gpointer instance
);
157 /* --- signal emissions --- */
158 void g_signal_stop_emission (gpointer instance
,
161 void g_signal_stop_emission_by_name (gpointer instance
,
162 const gchar
*detailed_signal
);
163 gulong
g_signal_add_emission_hook (guint signal_id
,
165 GSignalEmissionHook hook_func
,
167 GDestroyNotify data_destroy
);
168 void g_signal_remove_emission_hook (guint signal_id
,
172 /* --- signal handlers --- */
173 gboolean
g_signal_has_handler_pending (gpointer instance
,
176 gboolean may_be_blocked
);
177 gulong
g_signal_connect_closure_by_id (gpointer instance
,
182 gulong
g_signal_connect_closure (gpointer instance
,
183 const gchar
*detailed_signal
,
186 gulong
g_signal_connect_data (gpointer instance
,
187 const gchar
*detailed_signal
,
190 GClosureNotify destroy_data
,
191 GConnectFlags connect_flags
);
192 void g_signal_handler_block (gpointer instance
,
194 void g_signal_handler_unblock (gpointer instance
,
196 void g_signal_handler_disconnect (gpointer instance
,
198 gboolean
g_signal_handler_is_connected (gpointer instance
,
200 gulong
g_signal_handler_find (gpointer instance
,
201 GSignalMatchType mask
,
207 guint
g_signal_handlers_block_matched (gpointer instance
,
208 GSignalMatchType mask
,
214 guint
g_signal_handlers_unblock_matched (gpointer instance
,
215 GSignalMatchType mask
,
221 guint
g_signal_handlers_disconnect_matched (gpointer instance
,
222 GSignalMatchType mask
,
230 /* --- chaining for language bindings --- */
231 void g_signal_override_class_closure (guint signal_id
,
233 GClosure
*class_closure
);
234 void g_signal_chain_from_overridden (const GValue
*instance_and_params
,
235 GValue
*return_value
);
238 /* --- convenience --- */
239 #define g_signal_connect(instance, detailed_signal, c_handler, data) \
240 g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, (GConnectFlags) 0)
241 #define g_signal_connect_after(instance, detailed_signal, c_handler, data) \
242 g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, G_CONNECT_AFTER)
243 #define g_signal_connect_swapped(instance, detailed_signal, c_handler, data) \
244 g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, G_CONNECT_SWAPPED)
245 #define g_signal_handlers_disconnect_by_func(instance, func, data) \
246 g_signal_handlers_disconnect_matched ((instance), \
247 (GSignalMatchType) (G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA), \
248 0, 0, NULL, (func), (data))
249 #define g_signal_handlers_block_by_func(instance, func, data) \
250 g_signal_handlers_block_matched ((instance), \
251 (GSignalMatchType) (G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA), \
252 0, 0, NULL, (func), (data))
253 #define g_signal_handlers_unblock_by_func(instance, func, data) \
254 g_signal_handlers_unblock_matched ((instance), \
255 (GSignalMatchType) (G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA), \
256 0, 0, NULL, (func), (data))
260 void g_signal_handlers_destroy (gpointer instance
);
261 void _g_signals_destroy (GType itype
);
265 #endif /* __G_SIGNAL_H__ */