gtkmain.h 7.07 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * 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.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17 18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20 21
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
22
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 24
 */

Elliot Lee's avatar
Elliot Lee committed
25 26 27 28
#ifndef __GTK_MAIN_H__
#define __GTK_MAIN_H__


29 30 31 32
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
33 34
#include <gdk/gdk.h>
#include <gtk/gtkwidget.h>
35 36 37 38
#ifdef G_PLATFORM_WIN32
#include <gtk/gtkbox.h>
#include <gtk/gtkwindow.h>
#endif
Elliot Lee's avatar
Elliot Lee committed
39

40
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
41

42
/**
43
 * GTK_PRIORITY_RESIZE: (value 110)
44 45 46 47 48 49
 *
 * Use this priority for functionality related to size allocation.
 *
 * It is used internally by GTK+ to compute the sizes of widgets.
 * This priority is higher than %GDK_PRIORITY_REDRAW to avoid
 * resizing a widget which was just redrawn.
50
 */
51
#define GTK_PRIORITY_RESIZE (G_PRIORITY_HIGH_IDLE + 10)
52

53 54 55 56
/**
 * GtkKeySnoopFunc:
 * @grab_widget: the widget to which the event will be delivered
 * @event: the key event
57
 * @func_data: (closure): data supplied to gtk_key_snooper_install()
58 59 60 61 62 63 64 65 66
 *
 * Key snooper functions are called before normal event delivery.
 * They can be used to implement custom key event handling.
 *
 * Returns: %TRUE to stop further processing of @event, %FALSE to continue.
 */
typedef gint (*GtkKeySnoopFunc) (GtkWidget   *grab_widget,
                                 GdkEventKey *event,
                                 gpointer     func_data);
67

68
/* GTK+ version
69
 */
70
GDK_AVAILABLE_IN_ALL
71
guint gtk_get_major_version (void) G_GNUC_CONST;
72
GDK_AVAILABLE_IN_ALL
73
guint gtk_get_minor_version (void) G_GNUC_CONST;
74
GDK_AVAILABLE_IN_ALL
75
guint gtk_get_micro_version (void) G_GNUC_CONST;
76
GDK_AVAILABLE_IN_ALL
77
guint gtk_get_binary_age    (void) G_GNUC_CONST;
78
GDK_AVAILABLE_IN_ALL
79 80 81 82 83 84 85
guint gtk_get_interface_age (void) G_GNUC_CONST;

#define gtk_major_version gtk_get_major_version ()
#define gtk_minor_version gtk_get_minor_version ()
#define gtk_micro_version gtk_get_micro_version ()
#define gtk_binary_age gtk_get_binary_age ()
#define gtk_interface_age gtk_get_interface_age ()
86

87
GDK_AVAILABLE_IN_ALL
88 89 90
const gchar* gtk_check_version (guint   required_major,
                                guint   required_minor,
                                guint   required_micro);
91

92

Elliot Lee's avatar
Elliot Lee committed
93 94
/* Initialization, exit, mainloop and miscellaneous routines
 */
95

96
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
97
gboolean gtk_parse_args           (int    *argc,
98
                                   char ***argv);
Matthias Clasen's avatar
Matthias Clasen committed
99

100
GDK_AVAILABLE_IN_ALL
101 102
void     gtk_init                 (int    *argc,
                                   char ***argv);
103

104
GDK_AVAILABLE_IN_ALL
105 106
gboolean gtk_init_check           (int    *argc,
                                   char ***argv);
107

108
GDK_AVAILABLE_IN_ALL
109 110 111 112 113 114
gboolean gtk_init_with_args       (gint                 *argc,
                                   gchar              ***argv,
                                   const gchar          *parameter_string,
                                   const GOptionEntry   *entries,
                                   const gchar          *translation_domain,
                                   GError              **error);
115

116
GDK_AVAILABLE_IN_ALL
117
GOptionGroup *gtk_get_option_group (gboolean open_default_display);
118

Fridrich Strba's avatar
Fridrich Strba committed
119
#ifdef G_OS_WIN32
120 121 122 123

/* Variants that are used to check for correct struct packing
 * when building GTK+-using code.
 */
124
GDK_AVAILABLE_IN_ALL
125 126 127 128 129
void     gtk_init_abi_check       (int    *argc,
                                   char ***argv,
                                   int     num_checks,
                                   size_t  sizeof_GtkWindow,
                                   size_t  sizeof_GtkBox);
130
GDK_AVAILABLE_IN_ALL
131 132 133 134 135
gboolean gtk_init_check_abi_check (int    *argc,
                                   char ***argv,
                                   int     num_checks,
                                   size_t  sizeof_GtkWindow,
                                   size_t  sizeof_GtkBox);
136

137 138
#define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
#define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
139 140 141

#endif

142
GDK_AVAILABLE_IN_ALL
143
void           gtk_disable_setlocale    (void);
144
GDK_AVAILABLE_IN_ALL
145
PangoLanguage *gtk_get_default_language (void);
146 147
GDK_AVAILABLE_IN_3_12
GtkTextDirection gtk_get_locale_direction (void);
148
GDK_AVAILABLE_IN_ALL
149
gboolean       gtk_events_pending       (void);
150

151
GDK_AVAILABLE_IN_ALL
152
void       gtk_main_do_event       (GdkEvent           *event);
153
GDK_AVAILABLE_IN_ALL
154
void       gtk_main                (void);
155
GDK_AVAILABLE_IN_ALL
156
guint      gtk_main_level          (void);
157
GDK_AVAILABLE_IN_ALL
158
void       gtk_main_quit           (void);
159
GDK_AVAILABLE_IN_ALL
160
gboolean   gtk_main_iteration      (void);
161
GDK_AVAILABLE_IN_ALL
162
gboolean   gtk_main_iteration_do   (gboolean            blocking);
Elliot Lee's avatar
Elliot Lee committed
163

164
GDK_AVAILABLE_IN_ALL
165
gboolean   gtk_true                (void) G_GNUC_CONST;
166
GDK_AVAILABLE_IN_ALL
167
gboolean   gtk_false               (void) G_GNUC_CONST;
Elliot Lee's avatar
Elliot Lee committed
168

169
GDK_AVAILABLE_IN_ALL
170
void       gtk_grab_add            (GtkWidget          *widget);
171
GDK_AVAILABLE_IN_ALL
172
GtkWidget* gtk_grab_get_current    (void);
173
GDK_AVAILABLE_IN_ALL
174
void       gtk_grab_remove         (GtkWidget          *widget);
175

176
GDK_AVAILABLE_IN_ALL
177 178 179
void       gtk_device_grab_add     (GtkWidget          *widget,
                                    GdkDevice          *device,
                                    gboolean            block_others);
180
GDK_AVAILABLE_IN_ALL
181 182 183
void       gtk_device_grab_remove  (GtkWidget          *widget,
                                    GdkDevice          *device);

184
GDK_DEPRECATED_IN_3_4
185 186
guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
                                    gpointer        func_data);
187
GDK_DEPRECATED_IN_3_4
188
void       gtk_key_snooper_remove  (guint           snooper_handler_id);
189

190
GDK_AVAILABLE_IN_ALL
191
GdkEvent * gtk_get_current_event        (void);
192
GDK_AVAILABLE_IN_ALL
193
guint32    gtk_get_current_event_time   (void);
194
GDK_AVAILABLE_IN_ALL
195
gboolean   gtk_get_current_event_state  (GdkModifierType *state);
196
GDK_AVAILABLE_IN_ALL
197
GdkDevice *gtk_get_current_event_device (void);
198

199
GDK_AVAILABLE_IN_ALL
200
GtkWidget *gtk_get_event_widget         (GdkEvent        *event);
201

202
GDK_AVAILABLE_IN_ALL
203 204
void       gtk_propagate_event          (GtkWidget       *widget,
                                         GdkEvent        *event);
205

206

207
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
208 209

#endif /* __GTK_MAIN_H__ */