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 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_SIGNAL_MATCH_ID = 1 << 0,
59 G_SIGNAL_MATCH_DETAIL = 1 << 1,
60 G_SIGNAL_MATCH_CLOSURE = 1 << 2,
61 G_SIGNAL_MATCH_FUNC = 1 << 3,
62 G_SIGNAL_MATCH_DATA = 1 << 4,
63 G_SIGNAL_MATCH_UNBLOCKED = 1 << 5
65 #define G_SIGNAL_MATCH_MASK 0x3f
66 #define G_SIGNAL_TYPE_STATIC_SCOPE (G_TYPE_FLAG_RESERVED_ID_BIT)
69 /* --- signal information --- */
70 struct _GSignalInvocationHint
74 GSignalFlags run_type;
79 const gchar *signal_name;
80 GType itype; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
81 GSignalFlags signal_flags;
82 GType return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
84 const GType *param_types;
89 guint g_signal_newv (const gchar *signal_name,
91 GSignalFlags signal_flags,
92 GClosure *class_closure,
93 GSignalAccumulator accumulator,
95 GSignalCMarshaller c_marshaller,
99 guint g_signal_new_valist (const gchar *signal_name,
101 GSignalFlags signal_flags,
102 GClosure *class_closure,
103 GSignalAccumulator accumulator,
105 GSignalCMarshaller c_marshaller,
109 guint g_signal_newc (const gchar *signal_name,
111 GSignalFlags signal_flags,
113 GSignalAccumulator accumulator,
115 GSignalCMarshaller c_marshaller,
119 void g_signal_emitv (const GValue *instance_and_params,
122 GValue *return_value);
123 void g_signal_emit_valist (gpointer instance,
127 void g_signal_emit (gpointer instance,
131 void g_signal_emit_by_name (gpointer instance,
132 const gchar *detailed_signal,
134 guint g_signal_lookup (const gchar *name,
136 G_CONST_RETURN gchar* g_signal_name (guint signal_id);
137 void g_signal_query (guint signal_id,
138 GSignalQuery *query);
139 guint* g_signal_list_ids (GType itype,
141 gboolean g_signal_parse_name (const gchar *detailed_signal,
145 gboolean force_detail_quark);
148 /* --- signal emissions --- */
149 void g_signal_stop_emission (gpointer instance,
152 gulong g_signal_add_emission_hook (guint signal_id,
154 GSignalEmissionHook hook_func,
156 GDestroyNotify data_destroy);
157 void g_signal_remove_emission_hook (guint signal_id,
161 /* --- signal handlers --- */
162 gboolean g_signal_has_handler_pending (gpointer instance,
165 gboolean may_be_blocked);
166 gulong g_signal_connect_closure_by_id (gpointer instance,
171 gulong g_signal_connect_closure (gpointer instance,
172 const gchar *detailed_signal,
175 gulong g_signal_connect_data (gpointer instance,
176 const gchar *detailed_signal,
179 GClosureNotify destroy_data,
182 void g_signal_handler_block (gpointer instance,
184 void g_signal_handler_unblock (gpointer instance,
186 void g_signal_handler_disconnect (gpointer instance,
188 gulong g_signal_handler_find (gpointer instance,
189 GSignalMatchType mask,
195 guint g_signal_handlers_block_matched (gpointer instance,
196 GSignalMatchType mask,
202 guint g_signal_handlers_unblock_matched (gpointer instance,
203 GSignalMatchType mask,
209 guint g_signal_handlers_disconnect_matched (gpointer instance,
210 GSignalMatchType mask,
218 /* --- convenience --- */
219 #define g_signal_connectc(instance, detailed_signal, c_handler, data, swapped) \
220 g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, (swapped), FALSE)
223 void g_signal_handlers_destroy (gpointer instance);
224 void _g_signals_destroy (GType itype);
228 #endif /* __G_SIGNAL_H__ */