]> Pileus Git - ~andy/gtk/blob - gtk/gtkmain.h
Don't use zip -r on the etc directory, to avoid including editor backup
[~andy/gtk] / gtk / gtkmain.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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 Public
15  * 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
20 /*
21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
25  */
26
27 #ifndef __GTK_MAIN_H__
28 #define __GTK_MAIN_H__
29
30
31 #include <gdk/gdk.h>
32 #include <gtk/gtkwidget.h>
33 #ifdef G_PLATFORM_WIN32
34 #include <gtk/gtkbox.h>
35 #include <gtk/gtkwindow.h>
36 #endif
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif /* __cplusplus */
41
42 /* Priorities for redrawing and resizing
43  */
44 #define GTK_PRIORITY_RESIZE     (G_PRIORITY_HIGH_IDLE + 10)
45
46 #ifndef GTK_DISABLE_DEPRECATED
47
48 /* Use GDK_PRIORITY_REDRAW */
49 #define GTK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)
50
51 /* Deprecated. Use G_PRIORITY #define's instead
52  */
53 #define GTK_PRIORITY_HIGH       G_PRIORITY_HIGH
54 #define GTK_PRIORITY_INTERNAL   GTK_PRIORITY_REDRAW
55 #define GTK_PRIORITY_DEFAULT    G_PRIORITY_DEFAULT_IDLE
56 #define GTK_PRIORITY_LOW        G_PRIORITY_LOW
57
58 #endif /* GTK_DISABLE_DEPRECATED */
59
60 typedef void    (*GtkModuleInitFunc)        (gint         *argc,
61                                              gchar      ***argv);
62 typedef void    (*GtkModuleDisplayInitFunc) (GdkDisplay   *display);
63 typedef gint    (*GtkKeySnoopFunc)          (GtkWidget    *grab_widget,
64                                              GdkEventKey  *event,
65                                              gpointer      func_data);
66
67 /* Gtk version.
68  */
69 #ifdef G_PLATFORM_WIN32
70 #ifdef GTK_COMPILATION
71 #define GTKMAIN_C_VAR __declspec(dllexport)
72 #else
73 #define GTKMAIN_C_VAR extern __declspec(dllimport)
74 #endif
75 #else
76 #define GTKMAIN_C_VAR extern
77 #endif
78
79 GTKMAIN_C_VAR const guint gtk_major_version;
80 GTKMAIN_C_VAR const guint gtk_minor_version;
81 GTKMAIN_C_VAR const guint gtk_micro_version;
82 GTKMAIN_C_VAR const guint gtk_binary_age;
83 GTKMAIN_C_VAR const guint gtk_interface_age;
84 gchar* gtk_check_version (guint required_major,
85                           guint required_minor,
86                           guint required_micro);
87
88
89 /* Initialization, exit, mainloop and miscellaneous routines
90  */
91
92 void     gtk_init                 (int    *argc,
93                                    char ***argv);
94
95 gboolean gtk_init_check           (int    *argc,
96                                    char ***argv);
97 #ifdef G_PLATFORM_WIN32
98
99 /* Variants that are used to check for correct struct packing
100  * when building GTK+-using code.
101  */
102 void     gtk_init_abi_check       (int    *argc,
103                                    char ***argv,
104                                    int     num_checks,
105                                    size_t  sizeof_GtkWindow,
106                                    size_t  sizeof_GtkBox);
107 gboolean gtk_init_check_abi_check (int    *argc,
108                                    char ***argv,
109                                    int     num_checks,
110                                    size_t  sizeof_GtkWindow,
111                                    size_t  sizeof_GtkBox);
112
113 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
114 #define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
115
116 #endif
117
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 gchar *        gtk_set_locale           (void);
124 PangoLanguage *gtk_get_default_language (void);
125 gint           gtk_events_pending       (void);
126
127 /* The following is the event func GTK+ registers with GDK
128  * we expose it mainly to allow filtering of events between
129  * GDK and GTK+.
130  */
131 void       gtk_main_do_event       (GdkEvent           *event);
132
133 void       gtk_main                (void);
134 guint      gtk_main_level          (void);
135 void       gtk_main_quit           (void);
136 gboolean   gtk_main_iteration      (void);
137 /* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
138 gboolean   gtk_main_iteration_do   (gboolean blocking);
139
140 gboolean   gtk_true                (void) G_GNUC_CONST;
141 gboolean   gtk_false               (void) G_GNUC_CONST;
142
143 void       gtk_grab_add            (GtkWidget          *widget);
144 GtkWidget* gtk_grab_get_current    (void);
145 void       gtk_grab_remove         (GtkWidget          *widget);
146
147 void       gtk_init_add            (GtkFunction        function,
148                                     gpointer           data);
149 void       gtk_quit_add_destroy    (guint              main_level,
150                                     GtkObject         *object);
151 guint      gtk_quit_add            (guint              main_level,
152                                     GtkFunction        function,
153                                     gpointer           data);
154 guint      gtk_quit_add_full       (guint              main_level,
155                                     GtkFunction        function,
156                                     GtkCallbackMarshal marshal,
157                                     gpointer           data,
158                                     GtkDestroyNotify   destroy);
159 void       gtk_quit_remove         (guint              quit_handler_id);
160 void       gtk_quit_remove_by_data (gpointer           data);
161 #ifndef GTK_DISABLE_DEPRECATED
162 guint      gtk_timeout_add         (guint32            interval,
163                                     GtkFunction        function,
164                                     gpointer           data);
165 guint      gtk_timeout_add_full    (guint32            interval,
166                                     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 guint      gtk_idle_add_priority   (gint               priority,
175                                     GtkFunction        function,
176                                     gpointer           data);
177 guint      gtk_idle_add_full       (gint               priority,
178                                     GtkFunction        function,
179                                     GtkCallbackMarshal marshal,
180                                     gpointer           data,
181                                     GtkDestroyNotify   destroy);
182 void       gtk_idle_remove         (guint              idle_handler_id);
183 void       gtk_idle_remove_by_data (gpointer           data);
184 guint      gtk_input_add_full      (gint               source,
185                                     GdkInputCondition  condition,
186                                     GdkInputFunction   function,
187                                     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 GdkEvent*       gtk_get_current_event       (void);
198 guint32         gtk_get_current_event_time  (void);
199 gboolean        gtk_get_current_event_state (GdkModifierType *state);
200
201 GtkWidget* gtk_get_event_widget    (GdkEvent       *event);
202
203
204 /* Private routines internal to GTK+ 
205  */
206 void       gtk_propagate_event     (GtkWidget         *widget,
207                                     GdkEvent          *event);
208
209 gboolean _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
210                                    GValue                *return_accu,
211                                    const GValue          *handler_return,
212                                    gpointer               dummy);
213
214 gchar * _gtk_find_module     (const gchar *name,
215                               const gchar *type);
216 gchar **_gtk_get_module_path (const gchar *type);
217
218 gchar *_gtk_get_lc_ctype (void);
219
220 #ifdef __cplusplus
221 }
222 #endif /* __cplusplus */
223
224
225 #endif /* __GTK_MAIN_H__ */