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, 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 /**
  45  * GTK_PRIORITY_RESIZE:
  46  *
  47  * Use this priority for functionality related to size allocation.
  48  *
  49  * It is used internally by GTK+ to compute the sizes of widgets.
  50  * This priority is higher than %GDK_PRIORITY_REDRAW to avoid
  51  * resizing a widget which was just redrawn.
  52  */
  53 #define GTK_PRIORITY_RESIZE (G_PRIORITY_HIGH_IDLE + 10)
  54
  55 /**
  56  * GtkKeySnoopFunc:
  57  * @grab_widget: the widget to which the event will be delivered
  58  * @event: the key event
  59  * @func_data: data supplied to gtk_key_snooper_install()
  60  *
  61  * Key snooper functions are called before normal event delivery.
  62  * They can be used to implement custom key event handling.
  63  *
  64  * Returns: %TRUE to stop further processing of @event, %FALSE to continue.
  65  */
  66 typedef gint (*GtkKeySnoopFunc) (GtkWidget   *grab_widget,
  67                                  GdkEventKey *event,
  68                                  gpointer     func_data);
  69
  70 /* GTK+ version
  71  */
  72 guint gtk_get_major_version (void) G_GNUC_CONST;
  73 guint gtk_get_minor_version (void) G_GNUC_CONST;
  74 guint gtk_get_micro_version (void) G_GNUC_CONST;
  75 guint gtk_get_binary_age    (void) G_GNUC_CONST;
  76 guint gtk_get_interface_age (void) G_GNUC_CONST;
  77
  78 #define gtk_major_version gtk_get_major_version ()
  79 #define gtk_minor_version gtk_get_minor_version ()
  80 #define gtk_micro_version gtk_get_micro_version ()
  81 #define gtk_binary_age gtk_get_binary_age ()
  82 #define gtk_interface_age gtk_get_interface_age ()
  83
  84 const gchar* gtk_check_version (guint   required_major,
  85                                 guint   required_minor,
  86                                 guint   required_micro);
  87
  88
  89 /* Initialization, exit, mainloop and miscellaneous routines
  90  */
  91
  92 gboolean gtk_parse_args           (int    *argc,
  93                                    char ***argv);
  94
  95 void     gtk_init                 (int    *argc,
  96                                    char ***argv);
  97
  98 gboolean gtk_init_check           (int    *argc,
  99                                    char ***argv);
 100
 101 gboolean gtk_init_with_args       (gint                 *argc,
 102                                    gchar              ***argv,
 103                                    const gchar          *parameter_string,
 104                                    const GOptionEntry   *entries,
 105                                    const gchar          *translation_domain,
 106                                    GError              **error);
 107
 108 GOptionGroup *gtk_get_option_group (gboolean open_default_display);
 109
 110 #ifdef G_OS_WIN32
 111
 112 /* Variants that are used to check for correct struct packing
 113  * when building GTK+-using code.
 114  */
 115 void     gtk_init_abi_check       (int    *argc,
 116                                    char ***argv,
 117                                    int     num_checks,
 118                                    size_t  sizeof_GtkWindow,
 119                                    size_t  sizeof_GtkBox);
 120 gboolean gtk_init_check_abi_check (int    *argc,
 121                                    char ***argv,
 122                                    int     num_checks,
 123                                    size_t  sizeof_GtkWindow,
 124                                    size_t  sizeof_GtkBox);
 125
 126 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
 127 #define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
 128
 129 #endif
 130
 131 void           gtk_disable_setlocale    (void);
 132 PangoLanguage *gtk_get_default_language (void);
 133 gboolean       gtk_events_pending       (void);
 134
 135 void       gtk_main_do_event       (GdkEvent           *event);
 136 void       gtk_main                (void);
 137 guint      gtk_main_level          (void);
 138 void       gtk_main_quit           (void);
 139 gboolean   gtk_main_iteration      (void);
 140 gboolean   gtk_main_iteration_do   (gboolean            blocking);
 141
 142 gboolean   gtk_true                (void) G_GNUC_CONST;
 143 gboolean   gtk_false               (void) G_GNUC_CONST;
 144
 145 void       gtk_grab_add            (GtkWidget          *widget);
 146 GtkWidget* gtk_grab_get_current    (void);
 147 void       gtk_grab_remove         (GtkWidget          *widget);
 148
 149 void       gtk_device_grab_add     (GtkWidget          *widget,
 150                                     GdkDevice          *device,
 151                                     gboolean            block_others);
 152 void       gtk_device_grab_remove  (GtkWidget          *widget,
 153                                     GdkDevice          *device);
 154
 155 guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
 156                                     gpointer        func_data);
 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__ */