gobject/gsignal.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 2000-2001 Red Hat, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19 #ifndef __G_SIGNAL_H__
  20 #define __G_SIGNAL_H__
  21
  22
  23 #include        <gobject/gclosure.h>
  24 #include        <gobject/gvalue.h>
  25 #include        <gobject/gparam.h>
  26 #include        <gobject/gmarshal.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /* --- typedefs --- */
  31 typedef struct _GSignalQuery             GSignalQuery;
  32 typedef struct _GSignalInvocationHint    GSignalInvocationHint;
  33 typedef GClosureMarshal                  GSignalCMarshaller;
  34 typedef gboolean (*GSignalEmissionHook) (GSignalInvocationHint *ihint,
  35                                          guint                  n_param_values,
  36                                          const GValue          *param_values,
  37                                          gpointer               data);
  38 typedef gboolean (*GSignalAccumulator)  (GSignalInvocationHint *ihint,
  39                                          GValue                *return_accu,
  40                                          const GValue          *handler_return,
  41                                          gpointer               data);
  42
  43
  44 /* --- run, match and connect types --- */
  45 typedef enum
  46 {
  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
  54 } GSignalFlags;
  55 #define G_SIGNAL_FLAGS_MASK  0x7f
  56 typedef enum
  57 {
  58   G_CONNECT_AFTER       = 1 << 0,
  59   G_CONNECT_SWAPPED     = 1 << 1
  60 } GConnectFlags;
  61 typedef enum
  62 {
  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
  69 } GSignalMatchType;
  70 #define G_SIGNAL_MATCH_MASK  0x3f
  71 #define G_SIGNAL_TYPE_STATIC_SCOPE (G_TYPE_FLAG_RESERVED_ID_BIT)
  72
  73
  74 /* --- signal information --- */
  75 struct _GSignalInvocationHint
  76 {
  77   guint         signal_id;
  78   GQuark        detail;
  79   GSignalFlags  run_type;
  80 };
  81 struct _GSignalQuery
  82 {
  83   guint         signal_id;
  84   const gchar  *signal_name;
  85   GType         itype;
  86   GSignalFlags  signal_flags;
  87   GType         return_type; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
  88   guint         n_params;
  89   const GType  *param_types; /* mangled with G_SIGNAL_TYPE_STATIC_SCOPE flag */
  90 };
  91
  92
  93 /* --- signals --- */
  94 guint                 g_signal_newv         (const gchar        *signal_name,
  95                                              GType               itype,
  96                                              GSignalFlags        signal_flags,
  97                                              GClosure           *class_closure,
  98                                              GSignalAccumulator  accumulator,
  99                                              gpointer            accu_data,
 100                                              GSignalCMarshaller  c_marshaller,
 101                                              GType               return_type,
 102                                              guint               n_params,
 103                                              GType              *param_types);
 104 guint                 g_signal_new_valist   (const gchar        *signal_name,
 105                                              GType               itype,
 106                                              GSignalFlags        signal_flags,
 107                                              GClosure           *class_closure,
 108                                              GSignalAccumulator  accumulator,
 109                                              gpointer            accu_data,
 110                                              GSignalCMarshaller  c_marshaller,
 111                                              GType               return_type,
 112                                              guint               n_params,
 113                                              va_list             args);
 114 guint                 g_signal_new          (const gchar        *signal_name,
 115                                              GType               itype,
 116                                              GSignalFlags        signal_flags,
 117                                              guint               class_offset,
 118                                              GSignalAccumulator  accumulator,
 119                                              gpointer            accu_data,
 120                                              GSignalCMarshaller  c_marshaller,
 121                                              GType               return_type,
 122                                              guint               n_params,
 123                                              ...);
 124 void                  g_signal_emitv        (const GValue       *instance_and_params,
 125                                              guint               signal_id,
 126                                              GQuark              detail,
 127                                              GValue             *return_value);
 128 void                  g_signal_emit_valist  (gpointer            instance,
 129                                              guint               signal_id,
 130                                              GQuark              detail,
 131                                              va_list             var_args);
 132 void                  g_signal_emit         (gpointer            instance,
 133                                              guint               signal_id,
 134                                              GQuark              detail,
 135                                              ...);
 136 void                  g_signal_emit_by_name (gpointer            instance,
 137                                              const gchar        *detailed_signal,
 138                                              ...);
 139 guint                 g_signal_lookup       (const gchar        *name,
 140                                              GType               itype);
 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,
 145                                              guint              *n_ids);
 146 gboolean              g_signal_parse_name   (const gchar        *detailed_signal,
 147                                              GType               itype,
 148                                              guint              *signal_id_p,
 149                                              GQuark             *detail_p,
 150                                              gboolean            force_detail_quark);
 151
 152
 153 /* --- signal emissions --- */
 154 void    g_signal_stop_emission              (gpointer             instance,
 155                                              guint                signal_id,
 156                                              GQuark               detail);
 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,
 160                                              GQuark               quark,
 161                                              GSignalEmissionHook  hook_func,
 162                                              gpointer             hook_data,
 163                                              GDestroyNotify       data_destroy);
 164 void    g_signal_remove_emission_hook       (guint                signal_id,
 165                                              gulong               hook_id);
 166
 167
 168 /* --- signal handlers --- */
 169 gboolean g_signal_has_handler_pending         (gpointer           instance,
 170                                                guint              signal_id,
 171                                                GQuark             detail,
 172                                                gboolean           may_be_blocked);
 173 gulong   g_signal_connect_closure_by_id       (gpointer           instance,
 174                                                guint              signal_id,
 175                                                GQuark             detail,
 176                                                GClosure          *closure,
 177                                                gboolean           after);
 178 gulong   g_signal_connect_closure             (gpointer           instance,
 179                                                const gchar       *detailed_signal,
 180                                                GClosure          *closure,
 181                                                gboolean           after);
 182 gulong   g_signal_connect_data                (gpointer           instance,
 183                                                const gchar       *detailed_signal,
 184                                                GCallback          c_handler,
 185                                                gpointer           data,
 186                                                GClosureNotify     destroy_data,
 187                                                GConnectFlags      connect_flags);
 188 void     g_signal_handler_block               (gpointer           instance,
 189                                                gulong             handler_id);
 190 void     g_signal_handler_unblock             (gpointer           instance,
 191                                                gulong             handler_id);
 192 void     g_signal_handler_disconnect          (gpointer           instance,
 193                                                gulong             handler_id);
 194 gboolean g_signal_handler_is_connected        (gpointer           instance,
 195                                                gulong             handler_id);
 196 gulong   g_signal_handler_find                (gpointer           instance,
 197                                                GSignalMatchType   mask,
 198                                                guint              signal_id,
 199                                                GQuark             detail,
 200                                                GClosure          *closure,
 201                                                gpointer           func,
 202                                                gpointer           data);
 203 guint    g_signal_handlers_block_matched      (gpointer           instance,
 204                                                GSignalMatchType   mask,
 205                                                guint              signal_id,
 206                                                GQuark             detail,
 207                                                GClosure          *closure,
 208                                                gpointer           func,
 209                                                gpointer           data);
 210 guint    g_signal_handlers_unblock_matched    (gpointer           instance,
 211                                                GSignalMatchType   mask,
 212                                                guint              signal_id,
 213                                                GQuark             detail,
 214                                                GClosure          *closure,
 215                                                gpointer           func,
 216                                                gpointer           data);
 217 guint    g_signal_handlers_disconnect_matched (gpointer           instance,
 218                                                GSignalMatchType   mask,
 219                                                guint              signal_id,
 220                                                GQuark             detail,
 221                                                GClosure          *closure,
 222                                                gpointer           func,
 223                                                gpointer           data);
 224
 225
 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_after(instance, detailed_signal, c_handler, data) \
 230     g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, G_CONNECT_AFTER)
 231 #define g_signal_connect_swapped(instance, detailed_signal, c_handler, data) \
 232     g_signal_connect_data ((instance), (detailed_signal), (c_handler), (data), NULL, G_CONNECT_SWAPPED)
 233 #define g_signal_handlers_disconnect_by_func(instance, func, data) \
 234     g_signal_handlers_disconnect_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
 235                                           0, 0, NULL, (func), (data))
 236 #define g_signal_handlers_block_by_func(instance, func, data) \
 237     g_signal_handlers_block_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
 238                                      0, 0, NULL, (func), (data))
 239 #define g_signal_handlers_unblock_by_func(instance, func, data) \
 240     g_signal_handlers_unblock_matched ((instance), G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA, \
 241                                        0, 0, NULL, (func), (data))
 242
 243
 244 /*< private >*/
 245 void     g_signal_handlers_destroy            (gpointer           instance);
 246 void     _g_signals_destroy                   (GType              itype);
 247
 248 G_END_DECLS
 249
 250 #endif /* __G_SIGNAL_H__ */