1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2000 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>
31 #endif /* __cplusplus */
34 /* --- typedefs --- */
35 typedef struct _GSignalQuery GSignalQuery;
36 typedef struct _GSignalInvocationHint GSignalInvocationHint;
37 typedef GClosureMarshal GSignalCMarshaller;
38 typedef gboolean (*GSignalEmissionHook) (GSignalInvocationHint *ihint,
40 const GValue *param_values);
41 typedef gboolean (*GSignalAccumulator) (GSignalInvocationHint *ihint,
43 const GValue *return_value);
46 /* --- run & match types --- */
49 G_SIGNAL_RUN_FIRST = 1 << 0,
50 G_SIGNAL_RUN_LAST = 1 << 1,
51 G_SIGNAL_RUN_CLEANUP = 1 << 2,
52 G_SIGNAL_NO_RECURSE = 1 << 3,
53 G_SIGNAL_DETAILED = 1 << 4,
54 G_SIGNAL_ACTION = 1 << 5,
55 G_SIGNAL_NO_HOOKS = 1 << 6
57 #define G_SIGNAL_FLAGS_MASK 0x7f
60 G_SIGNAL_MATCH_ID = 1 << 0,
61 G_SIGNAL_MATCH_DETAIL = 1 << 1,
62 G_SIGNAL_MATCH_CLOSURE = 1 << 2,
63 G_SIGNAL_MATCH_FUNC = 1 << 3,
64 G_SIGNAL_MATCH_DATA = 1 << 4,
65 G_SIGNAL_MATCH_UNBLOCKED = 1 << 5
67 #define G_SIGNAL_MATCH_MASK 0x3f
68 #define G_SIGNAL_TYPE_STATIC_SCOPE (G_TYPE_FLAG_RESERVED_ID_BIT)
71 /* --- signal information --- */
72 struct _GSignalInvocationHint
76 GSignalFlags run_type;
81 const gchar *signal_name;
82 GType itype; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
83 GSignalFlags signal_flags;
84 GType return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
86 const GType *param_types;
91 guint g_signal_newv (const gchar *signal_name,
93 GSignalFlags signal_flags,
94 GClosure *class_closure,
95 GSignalAccumulator accumulator,
96 GSignalCMarshaller c_marshaller,
100 guint g_signal_new_valist (const gchar *signal_name,
102 GSignalFlags signal_flags,
103 GClosure *class_closure,
104 GSignalAccumulator accumulator,
105 GSignalCMarshaller c_marshaller,
109 guint g_signal_newc (const gchar *signal_name,
111 GSignalFlags signal_flags,
113 GSignalAccumulator accumulator,
114 GSignalCMarshaller c_marshaller,
118 void g_signal_emitv (const GValue *instance_and_params,
121 GValue *return_value);
122 void g_signal_emit_valist (gpointer instance,
126 void g_signal_emit (gpointer instance,
130 void g_signal_emit_by_name (gpointer instance,
131 const gchar *detailed_signal,
133 guint g_signal_lookup (const gchar *name,
135 gchar* g_signal_name (guint signal_id);
136 void g_signal_query (guint signal_id,
137 GSignalQuery *query);
138 guint* g_signal_list_ids (GType itype,
141 /* --- signal emissions --- */
142 void g_signal_stop_emission (gpointer instance,
145 guint g_signal_add_emission_hook_full (guint signal_id,
147 void g_signal_remove_emission_hook (guint signal_id,
151 /* --- signal handlers --- */
152 gboolean g_signal_has_handler_pending (gpointer instance,
155 gboolean may_be_blocked);
156 guint g_signal_connect_closure_by_id (gpointer instance,
161 guint g_signal_connect_closure (gpointer instance,
162 const gchar *detailed_signal,
165 guint g_signal_connect_data (gpointer instance,
166 const gchar *detailed_signal,
169 GClosureNotify destroy_data,
172 void g_signal_handler_block (gpointer instance,
174 void g_signal_handler_unblock (gpointer instance,
176 void g_signal_handler_disconnect (gpointer instance,
178 guint g_signal_handler_find (gpointer instance,
179 GSignalMatchType mask,
185 guint g_signal_handlers_block_matched (gpointer instance,
186 GSignalMatchType mask,
192 guint g_signal_handlers_unblock_matched (gpointer instance,
193 GSignalMatchType mask,
199 guint g_signal_handlers_disconnect_matched (gpointer instance,
200 GSignalMatchType mask,
206 gboolean g_signal_parse_name (const gchar *detailed_signal,
210 gboolean force_detail_quark);
214 void g_signal_handlers_destroy (gpointer instance);
215 void _g_signals_destroy (GType itype);
220 #endif /* __cplusplus */
222 #endif /* __G_SIGNAL_H__ */