]> Pileus Git - ~andy/gtk/blob - gtk/gtkmain.h
97b24b98aee484729d1ba243705450f473255c2a
[~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
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif /* __cplusplus */
38
39 /* Priorities for redrawing and resizing
40  */
41 #define GTK_PRIORITY_RESIZE     (G_PRIORITY_HIGH_IDLE + 10)
42
43 #ifndef GTK_DISABLE_DEPRECATED
44
45 /* Use GDK_PRIORITY_REDRAW */
46 #define GTK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)
47
48 /* Deprecated. Use G_PRIORITY #define's instead
49  */
50 #define GTK_PRIORITY_HIGH       G_PRIORITY_HIGH
51 #define GTK_PRIORITY_INTERNAL   GTK_PRIORITY_REDRAW
52 #define GTK_PRIORITY_DEFAULT    G_PRIORITY_DEFAULT_IDLE
53 #define GTK_PRIORITY_LOW        G_PRIORITY_LOW
54
55 #endif /* GTK_DISABLE_DEPRECATED */
56
57 typedef void    (*GtkModuleInitFunc)    (gint           *argc,
58                                          gchar        ***argv);
59 typedef gint    (*GtkKeySnoopFunc)      (GtkWidget      *grab_widget,
60                                          GdkEventKey    *event,
61                                          gpointer        func_data);
62
63 /* Gtk version.
64  */
65 #ifdef G_PLATFORM_WIN32
66 #ifdef GTK_COMPILATION
67 #define GTKMAIN_C_VAR __declspec(dllexport)
68 #else
69 #define GTKMAIN_C_VAR extern __declspec(dllimport)
70 #endif
71 #else
72 #define GTKMAIN_C_VAR extern
73 #endif
74
75 GTKMAIN_C_VAR const guint gtk_major_version;
76 GTKMAIN_C_VAR const guint gtk_minor_version;
77 GTKMAIN_C_VAR const guint gtk_micro_version;
78 GTKMAIN_C_VAR const guint gtk_binary_age;
79 GTKMAIN_C_VAR const guint gtk_interface_age;
80 gchar* gtk_check_version (guint required_major,
81                           guint required_minor,
82                           guint required_micro);
83
84
85 /* Initialization, exit, mainloop and miscellaneous routines
86  */
87
88 void     gtk_init                 (int    *argc,
89                                    char ***argv);
90
91 gboolean gtk_init_check           (int    *argc,
92                                    char ***argv);
93 #ifdef G_PLATFORM_WIN32
94
95 /* Variants that are used to check for correct struct packing
96  * when building GTK+-using code.
97  */
98 void     gtk_init_abi_check       (int    *argc,
99                                    char ***argv,
100                                    int     num_checks,
101                                    size_t  sizeof_GtkWindow);
102 gboolean gtk_init_check_abi_check (int    *argc,
103                                    char ***argv,
104                                    int     num_checks,
105                                    size_t  sizeof_GtkWindow);
106
107 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 1, sizeof (GtkWindow))
108 #define gtk_init_check(args, argv) gtk_init_check_abi_check (argc, argv, 1, sizeof (GtkWindow))
109
110 #endif
111
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 gchar *        gtk_set_locale           (void);
118 PangoLanguage *gtk_get_default_language (void);
119 gint           gtk_events_pending       (void);
120
121 /* The following is the event func GTK+ registers with GDK
122  * we expose it mainly to allow filtering of events between
123  * GDK and GTK+.
124  */
125 void       gtk_main_do_event       (GdkEvent           *event);
126
127 void       gtk_main                (void);
128 guint      gtk_main_level          (void);
129 void       gtk_main_quit           (void);
130 gboolean   gtk_main_iteration      (void);
131 /* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
132 gboolean   gtk_main_iteration_do   (gboolean blocking);
133
134 gboolean   gtk_true                (void) G_GNUC_CONST;
135 gboolean   gtk_false               (void) G_GNUC_CONST;
136
137 void       gtk_grab_add            (GtkWidget          *widget);
138 GtkWidget* gtk_grab_get_current    (void);
139 void       gtk_grab_remove         (GtkWidget          *widget);
140
141 void       gtk_init_add            (GtkFunction        function,
142                                     gpointer           data);
143 void       gtk_quit_add_destroy    (guint              main_level,
144                                     GtkObject         *object);
145 guint      gtk_quit_add            (guint              main_level,
146                                     GtkFunction        function,
147                                     gpointer           data);
148 guint      gtk_quit_add_full       (guint              main_level,
149                                     GtkFunction        function,
150                                     GtkCallbackMarshal marshal,
151                                     gpointer           data,
152                                     GtkDestroyNotify   destroy);
153 void       gtk_quit_remove         (guint              quit_handler_id);
154 void       gtk_quit_remove_by_data (gpointer           data);
155 guint      gtk_timeout_add         (guint32            interval,
156                                     GtkFunction        function,
157                                     gpointer           data);
158 guint      gtk_timeout_add_full    (guint32            interval,
159                                     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 guint      gtk_idle_add_priority   (gint               priority,
168                                     GtkFunction        function,
169                                     gpointer           data);
170 guint      gtk_idle_add_full       (gint               priority,
171                                     GtkFunction        function,
172                                     GtkCallbackMarshal marshal,
173                                     gpointer           data,
174                                     GtkDestroyNotify   destroy);
175 void       gtk_idle_remove         (guint              idle_handler_id);
176 void       gtk_idle_remove_by_data (gpointer           data);
177 guint      gtk_input_add_full      (gint               source,
178                                     GdkInputCondition  condition,
179                                     GdkInputFunction   function,
180                                     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 GdkEvent*       gtk_get_current_event       (void);
191 guint32         gtk_get_current_event_time  (void);
192 gboolean        gtk_get_current_event_state (GdkModifierType *state);
193
194 GtkWidget* gtk_get_event_widget    (GdkEvent       *event);
195
196
197 /* Private routines internal to GTK+ 
198  */
199 void       gtk_propagate_event     (GtkWidget         *widget,
200                                     GdkEvent          *event);
201
202 gboolean _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
203                                    GValue                *return_accu,
204                                    const GValue          *handler_return,
205                                    gpointer               dummy);
206
207
208 #ifdef __cplusplus
209 }
210 #endif /* __cplusplus */
211
212
213 #endif /* __GTK_MAIN_H__ */