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