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