]> Pileus Git - ~andy/gtk/blob - gtk/gtkmain.h
Use G_GNUC_CONST.
[~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_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)
42 #define GTK_PRIORITY_RESIZE     (G_PRIORITY_HIGH_IDLE + 10)
43
44 /* Deprecated. Use G_PRIORITY #define's instead
45  */
46 #define GTK_PRIORITY_HIGH       G_PRIORITY_HIGH
47 #define GTK_PRIORITY_INTERNAL   GTK_PRIORITY_REDRAW
48 #define GTK_PRIORITY_DEFAULT    G_PRIORITY_DEFAULT_IDLE
49 #define GTK_PRIORITY_LOW        G_PRIORITY_LOW
50
51 typedef void    (*GtkModuleInitFunc)    (gint           *argc,
52                                          gchar        ***argv);
53 typedef gint    (*GtkKeySnoopFunc)      (GtkWidget      *grab_widget,
54                                          GdkEventKey    *event,
55                                          gpointer        func_data);
56
57 /* Gtk version.
58  */
59 #ifdef G_OS_WIN32
60 #ifdef GTK_COMPILATION
61 #define GTKMAIN_C_VAR __declspec(dllexport)
62 #else
63 #define GTKMAIN_C_VAR __declspec(dllimport) extern
64 #endif
65 #else
66 #define GTKMAIN_C_VAR extern
67 #endif
68
69 GTKMAIN_C_VAR const guint gtk_major_version;
70 GTKMAIN_C_VAR const guint gtk_minor_version;
71 GTKMAIN_C_VAR const guint gtk_micro_version;
72 GTKMAIN_C_VAR const guint gtk_binary_age;
73 GTKMAIN_C_VAR const guint gtk_interface_age;
74 gchar* gtk_check_version (guint required_major,
75                           guint required_minor,
76                           guint required_micro);
77
78
79 /* Initialization, exit, mainloop and miscellaneous routines
80  */
81
82 void     gtk_init                 (int    *argc,
83                                    char ***argv);
84
85 gboolean gtk_init_check           (int    *argc,
86                                    char ***argv);
87 #ifdef G_OS_WIN32
88
89 /* Variants that are used to check for correct struct packing
90  * when building GTK+-using code.
91  */
92 void     gtk_init_abi_check       (int    *argc,
93                                    char ***argv,
94                                    int     num_checks,
95                                    size_t  sizeof_GtkWindow);
96 gboolean gtk_init_check_abi_check (int    *argc,
97                                    char ***argv,
98                                    int     num_checks,
99                                    size_t  sizeof_GtkWindow);
100
101 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 1, sizeof (GtkWindow))
102 #define gtk_init_check(args, argv) gtk_init_check_abi_check (argc, argv, 1, sizeof (GtkWindow))
103
104 #endif
105
106 void     gtk_exit                 (gint    error_code);
107 gchar*   gtk_set_locale           (void);
108 gchar*   gtk_get_default_language (void);
109 gint     gtk_events_pending       (void);
110
111
112
113 /* The following is the event func GTK+ registers with GDK
114  * we expose it mainly to allow filtering of events between
115  * GDK and GTK+.
116  */
117 void  gtk_main_do_event          (GdkEvent           *event);
118
119 void       gtk_main              (void);
120 guint      gtk_main_level        (void);
121 void       gtk_main_quit         (void);
122 gint       gtk_main_iteration    (void);
123 /* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
124 gint       gtk_main_iteration_do (gboolean blocking);
125
126 gint       gtk_true                (void) G_GNUC_CONST;
127 gint       gtk_false               (void) G_GNUC_CONST;
128
129 void       gtk_grab_add            (GtkWidget          *widget);
130 GtkWidget* gtk_grab_get_current    (void);
131 void       gtk_grab_remove         (GtkWidget          *widget);
132
133 void       gtk_init_add            (GtkFunction        function,
134                                     gpointer           data);
135 void       gtk_quit_add_destroy    (guint              main_level,
136                                     GtkObject         *object);
137 guint      gtk_quit_add            (guint              main_level,
138                                     GtkFunction        function,
139                                     gpointer           data);
140 guint      gtk_quit_add_full       (guint              main_level,
141                                     GtkFunction        function,
142                                     GtkCallbackMarshal marshal,
143                                     gpointer           data,
144                                     GtkDestroyNotify   destroy);
145 void       gtk_quit_remove         (guint              quit_handler_id);
146 void       gtk_quit_remove_by_data (gpointer           data);
147 guint      gtk_timeout_add         (guint32            interval,
148                                     GtkFunction        function,
149                                     gpointer           data);
150 guint      gtk_timeout_add_full    (guint32            interval,
151                                     GtkFunction        function,
152                                     GtkCallbackMarshal marshal,
153                                     gpointer           data,
154                                     GtkDestroyNotify   destroy);
155 void       gtk_timeout_remove      (guint              timeout_handler_id);
156
157 guint      gtk_idle_add            (GtkFunction        function,
158                                     gpointer           data);
159 guint      gtk_idle_add_priority   (gint               priority,
160                                     GtkFunction        function,
161                                     gpointer           data);
162 guint      gtk_idle_add_full       (gint               priority,
163                                     GtkFunction        function,
164                                     GtkCallbackMarshal marshal,
165                                     gpointer           data,
166                                     GtkDestroyNotify   destroy);
167 void       gtk_idle_remove         (guint              idle_handler_id);
168 void       gtk_idle_remove_by_data (gpointer           data);
169 guint      gtk_input_add_full      (gint               source,
170                                     GdkInputCondition  condition,
171                                     GdkInputFunction   function,
172                                     GtkCallbackMarshal marshal,
173                                     gpointer           data,
174                                     GtkDestroyNotify   destroy);
175 void       gtk_input_remove        (guint              input_handler_id);
176
177
178 guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
179                                     gpointer        func_data);
180 void       gtk_key_snooper_remove  (guint           snooper_handler_id);
181   
182 GdkEvent*  gtk_get_current_event   (void);
183 GtkWidget* gtk_get_event_widget    (GdkEvent       *event);
184
185
186 /* Private routines internal to GTK+ 
187  */
188 void       gtk_propagate_event     (GtkWidget         *widget,
189                                     GdkEvent          *event);
190
191 #ifdef __cplusplus
192 }
193 #endif /* __cplusplus */
194
195
196 #endif /* __GTK_MAIN_H__ */