]> Pileus Git - ~andy/gtk/blob - gtk/gtkmain.h
New function. print_event_state, print_event): Use preprocessor macro to
[~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_PLATFORM_WIN32
60 #ifdef GTK_COMPILATION
61 #define GTKMAIN_C_VAR __declspec(dllexport)
62 #else
63 #define GTKMAIN_C_VAR extern __declspec(dllimport)
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_PLATFORM_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 #ifndef GTK_DISABLE_DEPRECATED
107 void     gtk_exit                 (gint    error_code);
108 #endif /* GTK_DISABLE_DEPRECATED */
109 gchar*   gtk_set_locale           (void);
110 gchar*   gtk_get_default_language (void);
111 gint     gtk_events_pending       (void);
112
113
114
115 /* The following is the event func GTK+ registers with GDK
116  * we expose it mainly to allow filtering of events between
117  * GDK and GTK+.
118  */
119 void       gtk_main_do_event       (GdkEvent           *event);
120
121 void       gtk_main                (void);
122 guint      gtk_main_level          (void);
123 void       gtk_main_quit           (void);
124 gboolean   gtk_main_iteration      (void);
125 /* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
126 gboolean   gtk_main_iteration_do   (gboolean blocking);
127
128 gboolean   gtk_true                (void) G_GNUC_CONST;
129 gboolean   gtk_false               (void) G_GNUC_CONST;
130
131 void       gtk_grab_add            (GtkWidget          *widget);
132 GtkWidget* gtk_grab_get_current    (void);
133 void       gtk_grab_remove         (GtkWidget          *widget);
134
135 void       gtk_init_add            (GtkFunction        function,
136                                     gpointer           data);
137 void       gtk_quit_add_destroy    (guint              main_level,
138                                     GtkObject         *object);
139 guint      gtk_quit_add            (guint              main_level,
140                                     GtkFunction        function,
141                                     gpointer           data);
142 guint      gtk_quit_add_full       (guint              main_level,
143                                     GtkFunction        function,
144                                     GtkCallbackMarshal marshal,
145                                     gpointer           data,
146                                     GtkDestroyNotify   destroy);
147 void       gtk_quit_remove         (guint              quit_handler_id);
148 void       gtk_quit_remove_by_data (gpointer           data);
149 guint      gtk_timeout_add         (guint32            interval,
150                                     GtkFunction        function,
151                                     gpointer           data);
152 guint      gtk_timeout_add_full    (guint32            interval,
153                                     GtkFunction        function,
154                                     GtkCallbackMarshal marshal,
155                                     gpointer           data,
156                                     GtkDestroyNotify   destroy);
157 void       gtk_timeout_remove      (guint              timeout_handler_id);
158
159 guint      gtk_idle_add            (GtkFunction        function,
160                                     gpointer           data);
161 guint      gtk_idle_add_priority   (gint               priority,
162                                     GtkFunction        function,
163                                     gpointer           data);
164 guint      gtk_idle_add_full       (gint               priority,
165                                     GtkFunction        function,
166                                     GtkCallbackMarshal marshal,
167                                     gpointer           data,
168                                     GtkDestroyNotify   destroy);
169 void       gtk_idle_remove         (guint              idle_handler_id);
170 void       gtk_idle_remove_by_data (gpointer           data);
171 guint      gtk_input_add_full      (gint               source,
172                                     GdkInputCondition  condition,
173                                     GdkInputFunction   function,
174                                     GtkCallbackMarshal marshal,
175                                     gpointer           data,
176                                     GtkDestroyNotify   destroy);
177 void       gtk_input_remove        (guint              input_handler_id);
178
179
180 guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
181                                     gpointer        func_data);
182 void       gtk_key_snooper_remove  (guint           snooper_handler_id);
183
184 GdkEvent*       gtk_get_current_event       (void);
185 guint32         gtk_get_current_event_time  (void);
186 gboolean        gtk_get_current_event_state (GdkModifierType *state);
187
188 GtkWidget* gtk_get_event_widget    (GdkEvent       *event);
189
190
191 /* Private routines internal to GTK+ 
192  */
193 void       gtk_propagate_event     (GtkWidget         *widget,
194                                     GdkEvent          *event);
195
196 #ifdef __cplusplus
197 }
198 #endif /* __cplusplus */
199
200
201 #endif /* __GTK_MAIN_H__ */