gtkmain.h 7.17 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
#ifndef __GTK_MAIN_H__
#define __GTK_MAIN_H__


#include <gdk/gdk.h>
#include <gtk/gtkwidget.h>
33 34 35 36
#ifdef G_PLATFORM_WIN32
#include <gtk/gtkbox.h>
#include <gtk/gtkwindow.h>
#endif
Elliot Lee's avatar
Elliot Lee committed
37 38 39 40 41

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

42 43 44 45
/* Priorities for redrawing and resizing
 */
#define GTK_PRIORITY_RESIZE     (G_PRIORITY_HIGH_IDLE + 10)

46 47 48 49 50
#ifndef GTK_DISABLE_DEPRECATED

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

51 52 53 54 55 56
/* 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
57

58 59
#endif /* GTK_DISABLE_DEPRECATED */

60 61 62
typedef gint	(*GtkKeySnoopFunc)	    (GtkWidget	  *grab_widget,
					     GdkEventKey  *event,
					     gpointer	   func_data);
63

64 65
/* Gtk version.
 */
66
#ifdef G_PLATFORM_WIN32
67 68 69
#ifdef GTK_COMPILATION
#define GTKMAIN_C_VAR __declspec(dllexport)
#else
Tor Lillqvist's avatar
Tor Lillqvist committed
70
#define GTKMAIN_C_VAR extern __declspec(dllimport)
71 72 73 74 75 76 77 78 79 80
#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;
81 82 83
gchar* gtk_check_version (guint	required_major,
			  guint	required_minor,
			  guint	required_micro);
84

85

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

Matthias Clasen's avatar
Matthias Clasen committed
89
gboolean gtk_parse_args           (int    *argc,
Matthias Clasen's avatar
Matthias Clasen committed
90
				   char ***argv);
Matthias Clasen's avatar
Matthias Clasen committed
91

92 93
void     gtk_init                 (int    *argc,
                                   char ***argv);
94

95 96
gboolean gtk_init_check           (int    *argc,
                                   char ***argv);
97
#ifdef G_PLATFORM_WIN32
98 99 100 101 102 103 104

/* 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,
105 106
				   size_t  sizeof_GtkWindow,
				   size_t  sizeof_GtkBox);
107 108 109
gboolean gtk_init_check_abi_check (int	  *argc,
				   char	***argv,
				   int     num_checks,
110 111
				   size_t  sizeof_GtkWindow,
				   size_t  sizeof_GtkBox);
112

113 114
#define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
#define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
115 116 117

#endif

118
#ifndef GTK_DISABLE_DEPRECATED
119
void     gtk_exit                 (gint    error_code);
120
#endif /* GTK_DISABLE_DEPRECATED */
121 122

void           gtk_disable_setlocale    (void);
123 124
gchar *        gtk_set_locale           (void);
PangoLanguage *gtk_get_default_language (void);
125
gboolean       gtk_events_pending       (void);
126 127 128 129 130

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

133 134 135 136
void	   gtk_main		   (void);
guint	   gtk_main_level	   (void);
void	   gtk_main_quit	   (void);
gboolean   gtk_main_iteration	   (void);
137
/* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
138
gboolean   gtk_main_iteration_do   (gboolean blocking);
Elliot Lee's avatar
Elliot Lee committed
139

140 141
gboolean   gtk_true		   (void) G_GNUC_CONST;
gboolean   gtk_false		   (void) G_GNUC_CONST;
Elliot Lee's avatar
Elliot Lee committed
142

143
void	   gtk_grab_add		   (GtkWidget	       *widget);
144
GtkWidget* gtk_grab_get_current	   (void);
145 146 147 148
void	   gtk_grab_remove	   (GtkWidget	       *widget);

void	   gtk_init_add		   (GtkFunction	       function,
				    gpointer	       data);
149 150
void	   gtk_quit_add_destroy	   (guint	       main_level,
				    GtkObject	      *object);
151 152 153 154 155
guint	   gtk_quit_add		   (guint	       main_level,
				    GtkFunction	       function,
				    gpointer	       data);
guint	   gtk_quit_add_full	   (guint	       main_level,
				    GtkFunction	       function,
156
				    GtkCallbackMarshal marshal,
157
				    gpointer	       data,
158
				    GtkDestroyNotify   destroy);
159 160
void	   gtk_quit_remove	   (guint	       quit_handler_id);
void	   gtk_quit_remove_by_data (gpointer	       data);
161
#ifndef GTK_DISABLE_DEPRECATED
162 163 164
guint	   gtk_timeout_add	   (guint32	       interval,
				    GtkFunction	       function,
				    gpointer	       data);
165 166
guint	   gtk_timeout_add_full	   (guint32	       interval,
				    GtkFunction	       function,
167
				    GtkCallbackMarshal marshal,
168
				    gpointer	       data,
169
				    GtkDestroyNotify   destroy);
170
void	   gtk_timeout_remove	   (guint	       timeout_handler_id);
171

172
guint	   gtk_idle_add		   (GtkFunction	       function,
173
				    gpointer	       data);
174 175 176 177 178
guint	   gtk_idle_add_priority   (gint	       priority,
				    GtkFunction	       function,
				    gpointer	       data);
guint	   gtk_idle_add_full	   (gint	       priority,
				    GtkFunction	       function,
179 180 181
				    GtkCallbackMarshal marshal,
				    gpointer	       data,
				    GtkDestroyNotify   destroy);
182 183 184
void	   gtk_idle_remove	   (guint	       idle_handler_id);
void	   gtk_idle_remove_by_data (gpointer	       data);
guint	   gtk_input_add_full	   (gint	       source,
185 186 187
				    GdkInputCondition  condition,
				    GdkInputFunction   function,
				    GtkCallbackMarshal marshal,
188
				    gpointer	       data,
189
				    GtkDestroyNotify   destroy);
190
void	   gtk_input_remove	   (guint	       input_handler_id);
191
#endif /* GTK_DISABLE_DEPRECATED */
192

193
guint	   gtk_key_snooper_install (GtkKeySnoopFunc snooper,
194
				    gpointer	    func_data);
195
void	   gtk_key_snooper_remove  (guint	    snooper_handler_id);
196 197 198 199

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

201
GtkWidget* gtk_get_event_widget	   (GdkEvent	   *event);
Elliot Lee's avatar
Elliot Lee committed
202

203

204 205 206 207 208
/* Private routines internal to GTK+ 
 */
void       gtk_propagate_event     (GtkWidget         *widget,
				    GdkEvent          *event);

209 210 211 212 213
gboolean _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
                                   GValue                *return_accu,
                                   const GValue          *handler_return,
                                   gpointer               dummy);

214 215
gchar *_gtk_get_lc_ctype (void);

Elliot Lee's avatar
Elliot Lee committed
216 217 218 219 220 221
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_MAIN_H__ */