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_DISABLE_SINGLE_INCLUDES) && !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 /* Priorities for redrawing and resizing
  45  */
  46 #define GTK_PRIORITY_RESIZE     (G_PRIORITY_HIGH_IDLE + 10)
  47
  48 #ifndef GTK_DISABLE_DEPRECATED
  49
  50 /* Use GDK_PRIORITY_REDRAW */
  51 #define GTK_PRIORITY_REDRAW     (G_PRIORITY_HIGH_IDLE + 20)
  52
  53 /* Deprecated. Use G_PRIORITY #define's instead
  54  */
  55 #define GTK_PRIORITY_HIGH       G_PRIORITY_HIGH
  56 #define GTK_PRIORITY_INTERNAL   GTK_PRIORITY_REDRAW
  57 #define GTK_PRIORITY_DEFAULT    G_PRIORITY_DEFAULT_IDLE
  58 #define GTK_PRIORITY_LOW        G_PRIORITY_LOW
  59
  60 #endif /* GTK_DISABLE_DEPRECATED */
  61
  62 typedef gint    (*GtkKeySnoopFunc)          (GtkWidget    *grab_widget,
  63                                              GdkEventKey  *event,
  64                                              gpointer      func_data);
  65
  66 /* Gtk version.
  67  */
  68 #ifdef G_PLATFORM_WIN32
  69 #ifdef GTK_COMPILATION
  70 #define GTKMAIN_C_VAR __declspec(dllexport)
  71 #else
  72 #define GTKMAIN_C_VAR extern __declspec(dllimport)
  73 #endif
  74 #else
  75 #define GTKMAIN_C_VAR extern
  76 #endif
  77
  78 GTKMAIN_C_VAR const guint gtk_major_version;
  79 GTKMAIN_C_VAR const guint gtk_minor_version;
  80 GTKMAIN_C_VAR const guint gtk_micro_version;
  81 GTKMAIN_C_VAR const guint gtk_binary_age;
  82 GTKMAIN_C_VAR const guint gtk_interface_age;
  83 const gchar* gtk_check_version (guint   required_major,
  84                                 guint   required_minor,
  85                                 guint   required_micro);
  86
  87
  88 /* Initialization, exit, mainloop and miscellaneous routines
  89  */
  90
  91 gboolean gtk_parse_args           (int    *argc,
  92                                    char ***argv);
  93
  94 void     gtk_init                 (int    *argc,
  95                                    char ***argv);
  96
  97 gboolean gtk_init_check           (int    *argc,
  98                                    char ***argv);
  99
 100 gboolean gtk_init_with_args       (int            *argc,
 101                                    char         ***argv,
 102                                    char           *parameter_string,
 103                                    GOptionEntry   *entries,
 104                                    char           *translation_domain,
 105                                    GError        **error);
 106
 107 GOptionGroup *gtk_get_option_group (gboolean open_default_display);
 108
 109 #ifdef G_PLATFORM_WIN32
 110
 111 /* Variants that are used to check for correct struct packing
 112  * when building GTK+-using code.
 113  */
 114 void     gtk_init_abi_check       (int    *argc,
 115                                    char ***argv,
 116                                    int     num_checks,
 117                                    size_t  sizeof_GtkWindow,
 118                                    size_t  sizeof_GtkBox);
 119 gboolean gtk_init_check_abi_check (int    *argc,
 120                                    char ***argv,
 121                                    int     num_checks,
 122                                    size_t  sizeof_GtkWindow,
 123                                    size_t  sizeof_GtkBox);
 124
 125 #define gtk_init(argc, argv) gtk_init_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
 126 #define gtk_init_check(argc, argv) gtk_init_check_abi_check (argc, argv, 2, sizeof (GtkWindow), sizeof (GtkBox))
 127
 128 #endif
 129
 130 #ifndef GTK_DISABLE_DEPRECATED
 131 void     gtk_exit                 (gint    error_code);
 132 #endif /* GTK_DISABLE_DEPRECATED */
 133
 134 void           gtk_disable_setlocale    (void);
 135 gchar *        gtk_set_locale           (void);
 136 PangoLanguage *gtk_get_default_language (void);
 137 gboolean       gtk_events_pending       (void);
 138
 139 /* The following is the event func GTK+ registers with GDK
 140  * we expose it mainly to allow filtering of events between
 141  * GDK and GTK+.
 142  */
 143 void       gtk_main_do_event       (GdkEvent           *event);
 144
 145 void       gtk_main                (void);
 146 guint      gtk_main_level          (void);
 147 void       gtk_main_quit           (void);
 148 gboolean   gtk_main_iteration      (void);
 149 /* gtk_main_iteration() calls gtk_main_iteration_do(TRUE) */
 150 gboolean   gtk_main_iteration_do   (gboolean blocking);
 151
 152 gboolean   gtk_true                (void) G_GNUC_CONST;
 153 gboolean   gtk_false               (void) G_GNUC_CONST;
 154
 155 void       gtk_grab_add            (GtkWidget          *widget);
 156 GtkWidget* gtk_grab_get_current    (void);
 157 void       gtk_grab_remove         (GtkWidget          *widget);
 158
 159 void       gtk_init_add            (GtkFunction        function,
 160                                     gpointer           data);
 161 void       gtk_quit_add_destroy    (guint              main_level,
 162                                     GtkObject         *object);
 163 guint      gtk_quit_add            (guint              main_level,
 164                                     GtkFunction        function,
 165                                     gpointer           data);
 166 guint      gtk_quit_add_full       (guint              main_level,
 167                                     GtkFunction        function,
 168                                     GtkCallbackMarshal marshal,
 169                                     gpointer           data,
 170                                     GtkDestroyNotify   destroy);
 171 void       gtk_quit_remove         (guint              quit_handler_id);
 172 void       gtk_quit_remove_by_data (gpointer           data);
 173 #ifndef GTK_DISABLE_DEPRECATED
 174 guint      gtk_timeout_add         (guint32            interval,
 175                                     GtkFunction        function,
 176                                     gpointer           data);
 177 guint      gtk_timeout_add_full    (guint32            interval,
 178                                     GtkFunction        function,
 179                                     GtkCallbackMarshal marshal,
 180                                     gpointer           data,
 181                                     GtkDestroyNotify   destroy);
 182 void       gtk_timeout_remove      (guint              timeout_handler_id);
 183
 184 guint      gtk_idle_add            (GtkFunction        function,
 185                                     gpointer           data);
 186 guint      gtk_idle_add_priority   (gint               priority,
 187                                     GtkFunction        function,
 188                                     gpointer           data);
 189 guint      gtk_idle_add_full       (gint               priority,
 190                                     GtkFunction        function,
 191                                     GtkCallbackMarshal marshal,
 192                                     gpointer           data,
 193                                     GtkDestroyNotify   destroy);
 194 void       gtk_idle_remove         (guint              idle_handler_id);
 195 void       gtk_idle_remove_by_data (gpointer           data);
 196 guint      gtk_input_add_full      (gint               source,
 197                                     GdkInputCondition  condition,
 198                                     GdkInputFunction   function,
 199                                     GtkCallbackMarshal marshal,
 200                                     gpointer           data,
 201                                     GtkDestroyNotify   destroy);
 202 void       gtk_input_remove        (guint              input_handler_id);
 203 #endif /* GTK_DISABLE_DEPRECATED */
 204
 205 guint      gtk_key_snooper_install (GtkKeySnoopFunc snooper,
 206                                     gpointer        func_data);
 207 void       gtk_key_snooper_remove  (guint           snooper_handler_id);
 208
 209 GdkEvent*       gtk_get_current_event       (void);
 210 guint32         gtk_get_current_event_time  (void);
 211 gboolean        gtk_get_current_event_state (GdkModifierType *state);
 212
 213 GtkWidget* gtk_get_event_widget    (GdkEvent       *event);
 214
 215
 216 /* Private routines internal to GTK+
 217  */
 218 void       gtk_propagate_event     (GtkWidget         *widget,
 219                                     GdkEvent          *event);
 220
 221 gboolean _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
 222                                    GValue                *return_accu,
 223                                    const GValue          *handler_return,
 224                                    gpointer               dummy);
 225
 226 gchar *_gtk_get_lc_ctype (void);
 227
 228 G_END_DECLS
 229
 230 #endif /* __GTK_MAIN_H__ */