gtkmain.h 6.32 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
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * 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 29 30
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34 35 36
#ifndef __GTK_MAIN_H__
#define __GTK_MAIN_H__


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

42
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
43

44 45 46 47 48 49 50 51
/**
 * GTK_PRIORITY_RESIZE:
 *
 * 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.
52
 */
53
#define GTK_PRIORITY_RESIZE (G_PRIORITY_HIGH_IDLE + 10)
54

55 56 57 58 59 60 61 62 63 64 65 66 67 68
/**
 * GtkKeySnoopFunc:
 * @grab_widget: the widget to which the event will be delivered
 * @event: the key event
 * @func_data: data supplied to gtk_key_snooper_install()
 *
 * 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);
69

70
/* GTK+ version
71
 */
72 73 74 75 76 77 78 79 80 81 82
guint gtk_get_major_version (void) G_GNUC_CONST;
guint gtk_get_minor_version (void) G_GNUC_CONST;
guint gtk_get_micro_version (void) G_GNUC_CONST;
guint gtk_get_binary_age    (void) G_GNUC_CONST;
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 ()
83

84 85 86
const gchar* gtk_check_version (guint   required_major,
                                guint   required_minor,
                                guint   required_micro);
87

88

Elliot Lee's avatar
Elliot Lee committed
89 90
/* Initialization, exit, mainloop and miscellaneous routines
 */
91

Matthias Clasen's avatar
Matthias Clasen committed
92
gboolean gtk_parse_args           (int    *argc,
93
                                   char ***argv);
Matthias Clasen's avatar
Matthias Clasen committed
94

95 96
void     gtk_init                 (int    *argc,
                                   char ***argv);
97

98 99
gboolean gtk_init_check           (int    *argc,
                                   char ***argv);
100 101 102 103 104 105 106

gboolean gtk_init_with_args       (gint                 *argc,
                                   gchar              ***argv,
                                   const gchar          *parameter_string,
                                   const GOptionEntry   *entries,
                                   const gchar          *translation_domain,
                                   GError              **error);
107 108

GOptionGroup *gtk_get_option_group (gboolean open_default_display);
109

Fridrich Strba's avatar
Fridrich Strba committed
110
#ifdef G_OS_WIN32
111 112 113 114

/* Variants that are used to check for correct struct packing
 * when building GTK+-using code.
 */
115 116 117 118 119 120 121 122 123 124
void     gtk_init_abi_check       (int    *argc,
                                   char ***argv,
                                   int     num_checks,
                                   size_t  sizeof_GtkWindow,
                                   size_t  sizeof_GtkBox);
gboolean gtk_init_check_abi_check (int    *argc,
                                   char ***argv,
                                   int     num_checks,
                                   size_t  sizeof_GtkWindow,
                                   size_t  sizeof_GtkBox);
125

126 127
#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))
128 129 130

#endif

131
void           gtk_disable_setlocale    (void);
132
PangoLanguage *gtk_get_default_language (void);
133
gboolean       gtk_events_pending       (void);
134

135 136 137 138 139 140
void       gtk_main_do_event       (GdkEvent           *event);
void       gtk_main                (void);
guint      gtk_main_level          (void);
void       gtk_main_quit           (void);
gboolean   gtk_main_iteration      (void);
gboolean   gtk_main_iteration_do   (gboolean            blocking);
Elliot Lee's avatar
Elliot Lee committed
141

142 143
gboolean   gtk_true                (void) G_GNUC_CONST;
gboolean   gtk_false               (void) G_GNUC_CONST;
Elliot Lee's avatar
Elliot Lee committed
144

145 146 147
void       gtk_grab_add            (GtkWidget          *widget);
GtkWidget* gtk_grab_get_current    (void);
void       gtk_grab_remove         (GtkWidget          *widget);
148

149 150 151 152 153 154
void       gtk_device_grab_add     (GtkWidget          *widget,
                                    GdkDevice          *device,
                                    gboolean            block_others);
void       gtk_device_grab_remove  (GtkWidget          *widget,
                                    GdkDevice          *device);

155
G_GNUC_DEPRECATED
156 157
guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
                                    gpointer        func_data);
158
G_GNUC_DEPRECATED
159
void       gtk_key_snooper_remove  (guint           snooper_handler_id);
160

161 162 163 164
GdkEvent * gtk_get_current_event        (void);
guint32    gtk_get_current_event_time   (void);
gboolean   gtk_get_current_event_state  (GdkModifierType *state);
GdkDevice *gtk_get_current_event_device (void);
165

166
GtkWidget *gtk_get_event_widget         (GdkEvent        *event);
167

168 169
void       gtk_propagate_event          (GtkWidget       *widget,
                                         GdkEvent        *event);
170

171

172
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
173 174

#endif /* __GTK_MAIN_H__ */