]> Pileus Git - ~andy/gtk/blob - gtk/gtkmain.h
Merge the xi2-for-master branch
[~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 #ifdef G_PLATFORM_WIN32
55 #ifdef GTK_COMPILATION
56 #define GTKMAIN_C_VAR __declspec(dllexport)
57 #else
58 #define GTKMAIN_C_VAR extern __declspec(dllimport)
59 #endif
60 #else
61 #define GTKMAIN_C_VAR extern
62 #endif
63
64 GTKMAIN_C_VAR const guint gtk_major_version;
65 GTKMAIN_C_VAR const guint gtk_minor_version;
66 GTKMAIN_C_VAR const guint gtk_micro_version;
67 GTKMAIN_C_VAR const guint gtk_binary_age;
68 GTKMAIN_C_VAR const guint gtk_interface_age;
69 const gchar* gtk_check_version (guint   required_major,
70                                 guint   required_minor,
71                                 guint   required_micro);
72
73
74 /* Initialization, exit, mainloop and miscellaneous routines
75  */
76
77 gboolean gtk_parse_args           (int    *argc,
78                                    char ***argv);
79
80 void     gtk_init                 (int    *argc,
81                                    char ***argv);
82
83 gboolean gtk_init_check           (int    *argc,
84                                    char ***argv);
85   
86 gboolean gtk_init_with_args       (int            *argc,
87                                    char         ***argv,
88                                    const char     *parameter_string,
89                                    GOptionEntry   *entries,
90                                    const char     *translation_domain,
91                                    GError        **error);
92
93 GOptionGroup *gtk_get_option_group (gboolean open_default_display);
94   
95 #ifdef G_PLATFORM_WIN32
96
97 /* Variants that are used to check for correct struct packing
98  * when building GTK+-using code.
99  */
100 void     gtk_init_abi_check       (int    *argc,
101                                    char ***argv,
102                                    int     num_checks,
103                                    size_t  sizeof_GtkWindow,
104                                    size_t  sizeof_GtkBox);
105 gboolean gtk_init_check_abi_check (int    *argc,
106                                    char ***argv,
107                                    int     num_checks,
108                                    size_t  sizeof_GtkWindow,
109                                    size_t  sizeof_GtkBox);
110
111 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
112 #define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
113
114 #endif
115
116 void           gtk_disable_setlocale    (void);
117 gchar *        gtk_set_locale           (void);
118 PangoLanguage *gtk_get_default_language (void);
119 gboolean       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_device_grab_add     (GtkWidget          *widget,
142                                     GdkDevice          *device,
143                                     gboolean            block_others);
144 void       gtk_device_grab_remove  (GtkWidget          *widget,
145                                     GdkDevice          *device);
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                                     GDestroyNotify     destroy);
159 void       gtk_quit_remove         (guint              quit_handler_id);
160 void       gtk_quit_remove_by_data (gpointer           data);
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__ */