]> Pileus Git - ~andy/gtk/blob - gtk/gtkmain.h
Don't use the same name for a function that used to be a variable
[~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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
29 #endif
30
31 #ifndef __GTK_MAIN_H__
32 #define __GTK_MAIN_H__
33
34
35 #include <gdk/gdk.h>
36 #include <gtk/gtkwidget.h>
37 #ifdef G_PLATFORM_WIN32
38 #include <gtk/gtkbox.h>
39 #include <gtk/gtkwindow.h>
40 #endif
41
42 G_BEGIN_DECLS
43
44 /* Priorities for redrawing and resizing
45  */
46 #define GTK_PRIORITY_RESIZE     (G_PRIORITY_HIGH_IDLE + 10)
47
48 typedef gint    (*GtkKeySnoopFunc)          (GtkWidget    *grab_widget,
49                                              GdkEventKey  *event,
50                                              gpointer      func_data);
51
52 /* Gtk version.
53  */
54 guint gtk_get_major_version (void) G_GNUC_CONST;
55 guint gtk_get_minor_version (void) G_GNUC_CONST;
56 guint gtk_get_micro_version (void) G_GNUC_CONST;
57 guint gtk_get_binary_age    (void) G_GNUC_CONST;
58 guint gtk_get_interface_age (void) G_GNUC_CONST;
59
60 #define gtk_major_version gtk_get_major_version ()
61 #define gtk_minor_version gtk_get_minor_version ()
62 #define gtk_micro_version gtk_get_micro_version ()
63 #define gtk_binary_age gtk_get_binary_age ()
64 #define gtk_interface_age gtk_get_interface_age ()
65
66 const gchar* gtk_check_version (guint   required_major,
67                                 guint   required_minor,
68                                 guint   required_micro);
69
70
71 /* Initialization, exit, mainloop and miscellaneous routines
72  */
73
74 gboolean gtk_parse_args           (int    *argc,
75                                    char ***argv);
76
77 void     gtk_init                 (int    *argc,
78                                    char ***argv);
79
80 gboolean gtk_init_check           (int    *argc,
81                                    char ***argv);
82
83 gboolean gtk_init_with_args       (gint                 *argc,
84                                    gchar              ***argv,
85                                    const gchar          *parameter_string,
86                                    const GOptionEntry   *entries,
87                                    const gchar          *translation_domain,
88                                    GError              **error);
89
90 GOptionGroup *gtk_get_option_group (gboolean open_default_display);
91   
92 #ifdef G_PLATFORM_WIN32
93
94 /* Variants that are used to check for correct struct packing
95  * when building GTK+-using code.
96  */
97 void     gtk_init_abi_check       (int    *argc,
98                                    char ***argv,
99                                    int     num_checks,
100                                    size_t  sizeof_GtkWindow,
101                                    size_t  sizeof_GtkBox);
102 gboolean gtk_init_check_abi_check (int    *argc,
103                                    char ***argv,
104                                    int     num_checks,
105                                    size_t  sizeof_GtkWindow,
106                                    size_t  sizeof_GtkBox);
107
108 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
109 #define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
110
111 #endif
112
113 void           gtk_disable_setlocale    (void);
114 gchar *        gtk_set_locale           (void);
115 PangoLanguage *gtk_get_default_language (void);
116 gboolean       gtk_events_pending       (void);
117
118 /* The following is the event func GTK+ registers with GDK
119  * we expose it mainly to allow filtering of events between
120  * GDK and GTK+.
121  */
122 void       gtk_main_do_event       (GdkEvent           *event);
123
124 void       gtk_main                (void);
125 guint      gtk_main_level          (void);
126 void       gtk_main_quit           (void);
127 gboolean   gtk_main_iteration      (void);
128 /* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
129 gboolean   gtk_main_iteration_do   (gboolean blocking);
130
131 gboolean   gtk_true                (void) G_GNUC_CONST;
132 gboolean   gtk_false               (void) G_GNUC_CONST;
133
134 void       gtk_grab_add            (GtkWidget          *widget);
135 GtkWidget* gtk_grab_get_current    (void);
136 void       gtk_grab_remove         (GtkWidget          *widget);
137
138 void       gtk_device_grab_add     (GtkWidget          *widget,
139                                     GdkDevice          *device,
140                                     gboolean            block_others);
141 void       gtk_device_grab_remove  (GtkWidget          *widget,
142                                     GdkDevice          *device);
143
144 void       gtk_init_add            (GtkFunction        function,
145                                     gpointer           data);
146 void       gtk_quit_add_destroy    (guint              main_level,
147                                     GtkObject         *object);
148 guint      gtk_quit_add            (guint              main_level,
149                                     GtkFunction        function,
150                                     gpointer           data);
151 guint      gtk_quit_add_full       (guint              main_level,
152                                     GtkFunction        function,
153                                     GtkCallbackMarshal marshal,
154                                     gpointer           data,
155                                     GDestroyNotify     destroy);
156 void       gtk_quit_remove         (guint              quit_handler_id);
157 void       gtk_quit_remove_by_data (gpointer           data);
158
159 guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
160                                     gpointer        func_data);
161 void       gtk_key_snooper_remove  (guint           snooper_handler_id);
162
163 GdkEvent*       gtk_get_current_event       (void);
164 guint32         gtk_get_current_event_time  (void);
165 gboolean        gtk_get_current_event_state (GdkModifierType *state);
166 GdkDevice *     gtk_get_current_event_device (void);
167
168 GtkWidget* gtk_get_event_widget    (GdkEvent       *event);
169
170
171 /* Private routines internal to GTK+ 
172  */
173 void       gtk_propagate_event     (GtkWidget         *widget,
174                                     GdkEvent          *event);
175
176 gboolean _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
177                                    GValue                *return_accu,
178                                    const GValue          *handler_return,
179                                    gpointer               dummy);
180
181 gchar *_gtk_get_lc_ctype (void);
182
183 G_END_DECLS
184
185 #endif /* __GTK_MAIN_H__ */