gtksignal.h 7.2 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * 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.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31 32 33
#ifndef __GTK_SIGNAL_H__
#define __GTK_SIGNAL_H__


#include <gdk/gdk.h>
#include <gtk/gtkenums.h>
#include <gtk/gtkobject.h>
Elliot Lee's avatar
Elliot Lee committed
34
#include <gtk/gtkmarshal.h>
Elliot Lee's avatar
Elliot Lee committed
35 36 37 38 39

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

40
  
41
#define GTK_SIGNAL_OFFSET(struct, field)	(GTK_STRUCT_OFFSET (struct, field))
42
  
43
  
44
typedef void    (*GtkSignalMarshal) (GtkObject	    *object,
45 46 47 48 49
				     gpointer	     data,
				     guint	     nparams,
				     GtkArg	    *args,
				     GtkType	    *arg_types,
				     GtkType	     return_type);
50 51 52
typedef void    (*GtkSignalDestroy) (gpointer	     data);
typedef gboolean (*GtkEmissionHook) (GtkObject	    *object,
				     guint           signal_id,
53 54
				     guint	     n_params,
				     GtkArg	    *params,
55 56
				     gpointer        data);

57 58 59 60
typedef struct _GtkSignalQuery		GtkSignalQuery;

struct	_GtkSignalQuery
{
61 62
  GtkType	   object_type;
  guint		   signal_id;
63
  const gchar	  *signal_name;
64
  guint		   is_user_signal : 1;
65
  GtkSignalRunType signal_flags;
66 67 68 69
  GtkType	   return_val;
  guint		   nparams;
  const GtkType	  *params;
};
Elliot Lee's avatar
Elliot Lee committed
70

71 72

/* Application-level methods */
73 74
guint  gtk_signal_lookup		  (const gchar	       *name,
					   GtkType		object_type);
Elliot Lee's avatar
Elliot Lee committed
75
gchar* gtk_signal_name			  (guint		signal_id) G_GNUC_CONST;
76 77 78 79
guint  gtk_signal_n_emissions		  (GtkObject   	       *object,
					   guint                signal_id);
guint  gtk_signal_n_emissions_by_name	  (GtkObject   	       *object,
					   const gchar         *name);
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
void   gtk_signal_emit_stop		  (GtkObject	       *object,
					   guint		signal_id);
void   gtk_signal_emit_stop_by_name	  (GtkObject	       *object,
					   const gchar	       *name);
guint  gtk_signal_connect		  (GtkObject	       *object,
					   const gchar	       *name,
					   GtkSignalFunc	func,
					   gpointer		func_data);
guint  gtk_signal_connect_after		  (GtkObject	       *object,
					   const gchar	       *name,
					   GtkSignalFunc	func,
					   gpointer		func_data);
guint  gtk_signal_connect_object	  (GtkObject	       *object,
					   const gchar	       *name,
					   GtkSignalFunc	func,
					   GtkObject	       *slot_object);
guint  gtk_signal_connect_object_after	  (GtkObject	       *object,
					   const gchar	       *name,
					   GtkSignalFunc	func,
					   GtkObject	       *slot_object);
guint  gtk_signal_connect_full		  (GtkObject	       *object,
					   const gchar	       *name,
					   GtkSignalFunc	func,
					   GtkCallbackMarshal	marshal,
					   gpointer		data,
					   GtkDestroyNotify	destroy_func,
					   gint			object_signal,
					   gint			after);

void   gtk_signal_connect_object_while_alive (GtkObject	       *object,
110
					      const gchar      *signal,
111 112 113
					      GtkSignalFunc	func,
					      GtkObject	       *alive_object);
void   gtk_signal_connect_while_alive	     (GtkObject	       *object,
114
					      const gchar      *signal,
115 116 117 118 119 120
					      GtkSignalFunc	func,
					      gpointer		func_data,
					      GtkObject	       *alive_object);

void   gtk_signal_disconnect		  (GtkObject	       *object,
					   guint		handler_id);
121 122 123
void   gtk_signal_disconnect_by_func	  (GtkObject	       *object,
					   GtkSignalFunc	func,
					   gpointer		data);
124 125 126 127
void   gtk_signal_disconnect_by_data	  (GtkObject	       *object,
					   gpointer		data);
void   gtk_signal_handler_block		  (GtkObject	       *object,
					   guint		handler_id);
128 129 130
void   gtk_signal_handler_block_by_func	  (GtkObject	       *object,
					   GtkSignalFunc	func,
					   gpointer		data);
131 132 133 134
void   gtk_signal_handler_block_by_data	  (GtkObject	       *object,
					   gpointer		data);
void   gtk_signal_handler_unblock	  (GtkObject	       *object,
					   guint		handler_id);
135 136 137
void   gtk_signal_handler_unblock_by_func (GtkObject	       *object,
					   GtkSignalFunc	func,
					   gpointer		data);
138 139
void   gtk_signal_handler_unblock_by_data (GtkObject	       *object,
					   gpointer		data);
140
guint  gtk_signal_handler_pending	  (GtkObject	       *object,
141
					   guint		signal_id,
142
					   gboolean		may_be_blocked);
143 144 145 146 147
guint  gtk_signal_handler_pending_by_func (GtkObject	       *object,
					   guint		signal_id,
					   gboolean		may_be_blocked,
					   GtkSignalFunc	func,
					   gpointer		data);
148 149 150
gint   gtk_signal_handler_pending_by_id   (GtkObject	       *object,
					   guint		handler_id,
					   gboolean		may_be_blocked);
151 152 153 154 155 156 157 158 159 160
guint  gtk_signal_add_emission_hook	  (guint		signal_id,
					   GtkEmissionHook	hook_func,
					   gpointer       	data);
guint  gtk_signal_add_emission_hook_full  (guint		signal_id,
					   GtkEmissionHook	hook_func,
					   gpointer       	data,
					   GDestroyNotify	destroy);
void   gtk_signal_remove_emission_hook	  (guint		signal_id,
					   guint		hook_id);

161
/* Report internal information about a signal. The caller has the
162 163
 * responsibility to invoke a subsequent g_free (returned_data); but
 * must not modify data pointed to by the members of GtkSignalQuery 
164
 */
165
GtkSignalQuery* gtk_signal_query	  (guint		signal_id);
166

Elliot Lee's avatar
Elliot Lee committed
167

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
/* Widget-level methods */
void   gtk_signal_init			  (void);
guint  gtk_signal_new			  (const gchar	       *name,
					   GtkSignalRunType	signal_flags,
					   GtkType		object_type,
					   guint		function_offset,
					   GtkSignalMarshaller	marshaller,
					   GtkType		return_val,
					   guint		nparams,
					   ...);
guint  gtk_signal_newv			  (const gchar	       *name,
					   GtkSignalRunType	signal_flags,
					   GtkType		object_type,
					   guint		function_offset,
					   GtkSignalMarshaller	marshaller,
					   GtkType		return_val,
					   guint		nparams,
					   GtkType	       *params);
void   gtk_signal_emit			  (GtkObject	       *object,
					   guint		signal_id,
					   ...);
void   gtk_signal_emit_by_name		  (GtkObject	       *object,
					   const gchar	       *name,
					   ...);
void   gtk_signal_emitv			  (GtkObject           *object,
					   guint                signal_id,
					   GtkArg              *params);
void   gtk_signal_emitv_by_name		  (GtkObject           *object,
					   const gchar	       *name,
					   GtkArg              *params);
/* Non-public methods */
void   gtk_signal_handlers_destroy	  (GtkObject	       *object);
void   gtk_signal_set_funcs		  (GtkSignalMarshal	marshal_func,
					   GtkSignalDestroy	destroy_func);
202
       
203 204


Elliot Lee's avatar
Elliot Lee committed
205 206 207 208 209 210
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_SIGNAL_H__ */