Pileus Git - ~andy/gtk/blob - 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __GTK_MAIN_H__
  26 #define __GTK_MAIN_H__
  27
  28
  29 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  30 #error "Only <gtk/gtk.h> can be included directly."
  31 #endif
  32
  33 #include <gdk/gdk.h>
  34 #include <gtk/gtkwidget.h>
  35 #ifdef G_PLATFORM_WIN32
  36 #include <gtk/gtkbox.h>
  37 #include <gtk/gtkwindow.h>
  38 #endif
  39
  40 G_BEGIN_DECLS
  41
  42 /**
  43  * GTK_PRIORITY_RESIZE:
  44  *
  45  * Use this priority for functionality related to size allocation.
  46  *
  47  * It is used internally by GTK+ to compute the sizes of widgets.
  48  * This priority is higher than %GDK_PRIORITY_REDRAW to avoid
  49  * resizing a widget which was just redrawn.
  50  */
  51 #define GTK_PRIORITY_RESIZE (G_PRIORITY_HIGH_IDLE + 10)
  52
  53 /**
  54  * GtkKeySnoopFunc:
  55  * @grab_widget: the widget to which the event will be delivered
  56  * @event: the key event
  57  * @func_data: data supplied to gtk_key_snooper_install()
  58  *
  59  * Key snooper functions are called before normal event delivery.
  60  * They can be used to implement custom key event handling.
  61  *
  62  * Returns: %TRUE to stop further processing of @event, %FALSE to continue.
  63  */
  64 typedef gint (*GtkKeySnoopFunc) (GtkWidget   *grab_widget,
  65                                  GdkEventKey *event,
  66                                  gpointer     func_data);
  67
  68 /* GTK+ version
  69  */
  70 guint gtk_get_major_version (void) G_GNUC_CONST;
  71 guint gtk_get_minor_version (void) G_GNUC_CONST;
  72 guint gtk_get_micro_version (void) G_GNUC_CONST;
  73 guint gtk_get_binary_age    (void) G_GNUC_CONST;
  74 guint gtk_get_interface_age (void) G_GNUC_CONST;
  75
  76 #define gtk_major_version gtk_get_major_version ()
  77 #define gtk_minor_version gtk_get_minor_version ()
  78 #define gtk_micro_version gtk_get_micro_version ()
  79 #define gtk_binary_age gtk_get_binary_age ()
  80 #define gtk_interface_age gtk_get_interface_age ()
  81
  82 const gchar* gtk_check_version (guint   required_major,
  83                                 guint   required_minor,
  84                                 guint   required_micro);
  85
  86
  87 /* Initialization, exit, mainloop and miscellaneous routines
  88  */
  89
  90 gboolean gtk_parse_args           (int    *argc,
  91                                    char ***argv);
  92
  93 void     gtk_init                 (int    *argc,
  94                                    char ***argv);
  95
  96 gboolean gtk_init_check           (int    *argc,
  97                                    char ***argv);
  98
  99 gboolean gtk_init_with_args       (gint                 *argc,
 100                                    gchar              ***argv,
 101                                    const gchar          *parameter_string,
 102                                    const GOptionEntry   *entries,
 103                                    const gchar          *translation_domain,
 104                                    GError              **error);
 105
 106 GOptionGroup *gtk_get_option_group (gboolean open_default_display);
 107
 108 #ifdef G_OS_WIN32
 109
 110 /* Variants that are used to check for correct struct packing
 111  * when building GTK+-using code.
 112  */
 113 void     gtk_init_abi_check       (int    *argc,
 114                                    char ***argv,
 115                                    int     num_checks,
 116                                    size_t  sizeof_GtkWindow,
 117                                    size_t  sizeof_GtkBox);
 118 gboolean gtk_init_check_abi_check (int    *argc,
 119                                    char ***argv,
 120                                    int     num_checks,
 121                                    size_t  sizeof_GtkWindow,
 122                                    size_t  sizeof_GtkBox);
 123
 124 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
 125 #define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
 126
 127 #endif
 128
 129 void           gtk_disable_setlocale    (void);
 130 PangoLanguage *gtk_get_default_language (void);
 131 gboolean       gtk_events_pending       (void);
 132
 133 void       gtk_main_do_event       (GdkEvent           *event);
 134 void       gtk_main                (void);
 135 guint      gtk_main_level          (void);
 136 void       gtk_main_quit           (void);
 137 gboolean   gtk_main_iteration      (void);
 138 gboolean   gtk_main_iteration_do   (gboolean            blocking);
 139
 140 gboolean   gtk_true                (void) G_GNUC_CONST;
 141 gboolean   gtk_false               (void) G_GNUC_CONST;
 142
 143 void       gtk_grab_add            (GtkWidget          *widget);
 144 GtkWidget* gtk_grab_get_current    (void);
 145 void       gtk_grab_remove         (GtkWidget          *widget);
 146
 147 void       gtk_device_grab_add     (GtkWidget          *widget,
 148                                     GdkDevice          *device,
 149                                     gboolean            block_others);
 150 void       gtk_device_grab_remove  (GtkWidget          *widget,
 151                                     GdkDevice          *device);
 152
 153 GDK_DEPRECATED_IN_3_4
 154 guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
 155                                     gpointer        func_data);
 156 GDK_DEPRECATED_IN_3_4
 157 void       gtk_key_snooper_remove  (guint           snooper_handler_id);
 158
 159 GdkEvent * gtk_get_current_event        (void);
 160 guint32    gtk_get_current_event_time   (void);
 161 gboolean   gtk_get_current_event_state  (GdkModifierType *state);
 162 GdkDevice *gtk_get_current_event_device (void);
 163
 164 GtkWidget *gtk_get_event_widget         (GdkEvent        *event);
 165
 166 void       gtk_propagate_event          (GtkWidget       *widget,
 167                                          GdkEvent        *event);
 168
 169
 170 G_END_DECLS
 171
 172 #endif /* __GTK_MAIN_H__ */