gtkmain.h 7.01 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 34 35 36 37 38
#ifndef __GTK_MAIN_H__
#define __GTK_MAIN_H__


#include <gdk/gdk.h>
#include <gtk/gtkwidget.h>


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

39 40 41 42
/* Priorities for redrawing and resizing
 */
#define GTK_PRIORITY_RESIZE     (G_PRIORITY_HIGH_IDLE + 10)

43 44 45 46 47
#ifndef GTK_DISABLE_DEPRECATED

/* Use GDK_PRIORITY_REDRAW */
#define GTK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)

48 49 50 51 52 53
/* Deprecated. Use G_PRIORITY #define's instead
 */
#define GTK_PRIORITY_HIGH       G_PRIORITY_HIGH
#define GTK_PRIORITY_INTERNAL   GTK_PRIORITY_REDRAW
#define GTK_PRIORITY_DEFAULT	G_PRIORITY_DEFAULT_IDLE
#define GTK_PRIORITY_LOW	G_PRIORITY_LOW
Elliot Lee's avatar
Elliot Lee committed
54

55 56
#endif /* GTK_DISABLE_DEPRECATED */

57 58
typedef void	(*GtkModuleInitFunc)	(gint		*argc,
					 gchar	      ***argv);
59 60 61
typedef gint	(*GtkKeySnoopFunc)	(GtkWidget	*grab_widget,
					 GdkEventKey	*event,
					 gpointer	 func_data);
62

63 64
/* Gtk version.
 */
65
#ifdef G_PLATFORM_WIN32
66 67 68
#ifdef GTK_COMPILATION
#define GTKMAIN_C_VAR __declspec(dllexport)
#else
Tor Lillqvist's avatar
Tor Lillqvist committed
69
#define GTKMAIN_C_VAR extern __declspec(dllimport)
70 71 72 73 74 75 76 77 78 79
#endif
#else
#define GTKMAIN_C_VAR extern
#endif

GTKMAIN_C_VAR const guint gtk_major_version;
GTKMAIN_C_VAR const guint gtk_minor_version;
GTKMAIN_C_VAR const guint gtk_micro_version;
GTKMAIN_C_VAR const guint gtk_binary_age;
GTKMAIN_C_VAR const guint gtk_interface_age;
80 81 82
gchar* gtk_check_version (guint	required_major,
			  guint	required_minor,
			  guint	required_micro);
83

84

Elliot Lee's avatar
Elliot Lee committed
85 86
/* Initialization, exit, mainloop and miscellaneous routines
 */
87 88 89

void     gtk_init                 (int    *argc,
                                   char ***argv);
90

91 92
gboolean gtk_init_check           (int    *argc,
                                   char ***argv);
93
#ifdef G_PLATFORM_WIN32
94 95 96 97 98 99 100 101 102 103 104 105 106 107

/* Variants that are used to check for correct struct packing
 * when building GTK+-using code.
 */
void	 gtk_init_abi_check       (int	  *argc,
				   char	***argv,
				   int     num_checks,
				   size_t  sizeof_GtkWindow);
gboolean gtk_init_check_abi_check (int	  *argc,
				   char	***argv,
				   int     num_checks,
				   size_t  sizeof_GtkWindow);

#define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 1, sizeof (GtkWindow))
108
#define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 1, sizeof (GtkWindow))
109 110 111

#endif

112
#ifndef GTK_DISABLE_DEPRECATED
113
void     gtk_exit                 (gint    error_code);
114
#endif /* GTK_DISABLE_DEPRECATED */
115 116

void           gtk_disable_setlocale    (void);
117 118 119
gchar *        gtk_set_locale           (void);
PangoLanguage *gtk_get_default_language (void);
gint           gtk_events_pending       (void);
120 121 122 123 124

/* The following is the event func GTK+ registers with GDK
 * we expose it mainly to allow filtering of events between
 * GDK and GTK+.
 */
125
void 	   gtk_main_do_event	   (GdkEvent           *event);
126

127 128 129 130
void	   gtk_main		   (void);
guint	   gtk_main_level	   (void);
void	   gtk_main_quit	   (void);
gboolean   gtk_main_iteration	   (void);
131
/* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
132
gboolean   gtk_main_iteration_do   (gboolean blocking);
Elliot Lee's avatar
Elliot Lee committed
133

134 135
gboolean   gtk_true		   (void) G_GNUC_CONST;
gboolean   gtk_false		   (void) G_GNUC_CONST;
Elliot Lee's avatar
Elliot Lee committed
136

137
void	   gtk_grab_add		   (GtkWidget	       *widget);
138
GtkWidget* gtk_grab_get_current	   (void);
139 140 141 142
void	   gtk_grab_remove	   (GtkWidget	       *widget);

void	   gtk_init_add		   (GtkFunction	       function,
				    gpointer	       data);
143 144
void	   gtk_quit_add_destroy	   (guint	       main_level,
				    GtkObject	      *object);
145 146 147 148 149
guint	   gtk_quit_add		   (guint	       main_level,
				    GtkFunction	       function,
				    gpointer	       data);
guint	   gtk_quit_add_full	   (guint	       main_level,
				    GtkFunction	       function,
150
				    GtkCallbackMarshal marshal,
151
				    gpointer	       data,
152
				    GtkDestroyNotify   destroy);
153 154
void	   gtk_quit_remove	   (guint	       quit_handler_id);
void	   gtk_quit_remove_by_data (gpointer	       data);
155 156 157
guint	   gtk_timeout_add	   (guint32	       interval,
				    GtkFunction	       function,
				    gpointer	       data);
158 159
guint	   gtk_timeout_add_full	   (guint32	       interval,
				    GtkFunction	       function,
160
				    GtkCallbackMarshal marshal,
161
				    gpointer	       data,
162
				    GtkDestroyNotify   destroy);
163
void	   gtk_timeout_remove	   (guint	       timeout_handler_id);
164

165
guint	   gtk_idle_add		   (GtkFunction	       function,
166
				    gpointer	       data);
167 168 169 170 171
guint	   gtk_idle_add_priority   (gint	       priority,
				    GtkFunction	       function,
				    gpointer	       data);
guint	   gtk_idle_add_full	   (gint	       priority,
				    GtkFunction	       function,
172 173 174
				    GtkCallbackMarshal marshal,
				    gpointer	       data,
				    GtkDestroyNotify   destroy);
175 176 177
void	   gtk_idle_remove	   (guint	       idle_handler_id);
void	   gtk_idle_remove_by_data (gpointer	       data);
guint	   gtk_input_add_full	   (gint	       source,
178 179 180
				    GdkInputCondition  condition,
				    GdkInputFunction   function,
				    GtkCallbackMarshal marshal,
181
				    gpointer	       data,
182
				    GtkDestroyNotify   destroy);
183
void	   gtk_input_remove	   (guint	       input_handler_id);
184 185


186
guint	   gtk_key_snooper_install (GtkKeySnoopFunc snooper,
187
				    gpointer	    func_data);
188
void	   gtk_key_snooper_remove  (guint	    snooper_handler_id);
189 190 191 192

GdkEvent*       gtk_get_current_event       (void);
guint32         gtk_get_current_event_time  (void);
gboolean        gtk_get_current_event_state (GdkModifierType *state);
193

194
GtkWidget* gtk_get_event_widget	   (GdkEvent	   *event);
Elliot Lee's avatar
Elliot Lee committed
195

196

197 198 199 200 201
/* Private routines internal to GTK+ 
 */
void       gtk_propagate_event     (GtkWidget         *widget,
				    GdkEvent          *event);

202 203 204 205 206
gboolean _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
                                   GValue                *return_accu,
                                   const GValue          *handler_return,
                                   gpointer               dummy);

207 208 209
gchar * _gtk_find_module     (const gchar *name,
			      const gchar *type);
gchar **_gtk_get_module_path (const gchar *type);
210

Elliot Lee's avatar
Elliot Lee committed
211 212 213 214 215 216
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_MAIN_H__ */