gtkmain.h 7.45 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
63
64
65
typedef void	(*GtkModuleInitFunc)        (gint	  *argc,
				             gchar      ***argv);
typedef void	(*GtkModuleDisplayInitFunc) (GdkDisplay   *display);
typedef gint	(*GtkKeySnoopFunc)	    (GtkWidget	  *grab_widget,
					     GdkEventKey  *event,
					     gpointer	   func_data);
66

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

88

Elliot Lee's avatar
Elliot Lee committed
89
90
/* Initialization, exit, mainloop and miscellaneous routines
 */
91

Matthias Clasen's avatar
Matthias Clasen committed
92
gboolean gtk_parse_args           (int    *argc,
Matthias Clasen's avatar
Matthias Clasen committed
93
				   char ***argv);
Matthias Clasen's avatar
Matthias Clasen committed
94

95
96
void     gtk_init                 (int    *argc,
                                   char ***argv);
97

98
99
gboolean gtk_init_check           (int    *argc,
                                   char ***argv);
100
#ifdef G_PLATFORM_WIN32
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,
108
109
				   size_t  sizeof_GtkWindow,
				   size_t  sizeof_GtkBox);
110
111
112
gboolean gtk_init_check_abi_check (int	  *argc,
				   char	***argv,
				   int     num_checks,
113
114
				   size_t  sizeof_GtkWindow,
				   size_t  sizeof_GtkBox);
115

116
117
#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))
118
119
120

#endif

121
#ifndef GTK_DISABLE_DEPRECATED
122
void     gtk_exit                 (gint    error_code);
123
#endif /* GTK_DISABLE_DEPRECATED */
124
125

void           gtk_disable_setlocale    (void);
126
127
gchar *        gtk_set_locale           (void);
PangoLanguage *gtk_get_default_language (void);
128
gboolean       gtk_events_pending       (void);
129
130
131
132
133

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

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

143
144
gboolean   gtk_true		   (void) G_GNUC_CONST;
gboolean   gtk_false		   (void) G_GNUC_CONST;
Elliot Lee's avatar
Elliot Lee committed
145

146
void	   gtk_grab_add		   (GtkWidget	       *widget);
147
GtkWidget* gtk_grab_get_current	   (void);
148
149
150
151
void	   gtk_grab_remove	   (GtkWidget	       *widget);

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

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

196
guint	   gtk_key_snooper_install (GtkKeySnoopFunc snooper,
197
				    gpointer	    func_data);
198
void	   gtk_key_snooper_remove  (guint	    snooper_handler_id);
199
200
201
202

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

204
GtkWidget* gtk_get_event_widget	   (GdkEvent	   *event);
Elliot Lee's avatar
Elliot Lee committed
205

206

207
208
209
210
211
/* Private routines internal to GTK+ 
 */
void       gtk_propagate_event     (GtkWidget         *widget,
				    GdkEvent          *event);

212
213
214
215
216
gboolean _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
                                   GValue                *return_accu,
                                   const GValue          *handler_return,
                                   gpointer               dummy);

217
218
219
gchar * _gtk_find_module     (const gchar *name,
			      const gchar *type);
gchar **_gtk_get_module_path (const gchar *type);
220

221
222
gchar *_gtk_get_lc_ctype (void);

Elliot Lee's avatar
Elliot Lee committed
223
224
225
226
227
228
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_MAIN_H__ */