1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
30 #include "gdkconfig.h"
34 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
44 #include <sys/types.h> /* For uid_t, gid_t */
52 #include <pango/pango-types.h> /* For pango_language_from_string */
56 #include "gtkaccelmap.h"
58 #include "gtkclipboard.h"
60 #include "gtkversion.h"
62 #include "gtkmodules.h"
64 #include "gtkselection.h"
65 #include "gtksettings.h"
66 #include "gtkwidget.h"
67 #include "gtkwindow.h"
68 #include "gtktooltip.h"
69 #include "gtkprivate.h"
73 #include "gdk/gdkprivate.h" /* for GDK_WINDOW_DESTROYED */
75 /* Private type definitions
77 typedef struct _GtkInitFunction GtkInitFunction;
78 typedef struct _GtkQuitFunction GtkQuitFunction;
79 typedef struct _GtkClosure GtkClosure;
80 typedef struct _GtkKeySnooperData GtkKeySnooperData;
82 struct _GtkInitFunction
88 struct _GtkQuitFunction
92 GtkCallbackMarshal marshal;
95 GtkDestroyNotify destroy;
100 GtkCallbackMarshal marshal;
102 GtkDestroyNotify destroy;
105 struct _GtkKeySnooperData
107 GtkKeySnoopFunc func;
112 static gint gtk_quit_invoke_function (GtkQuitFunction *quitf);
113 static void gtk_quit_destroy (GtkQuitFunction *quitf);
114 static gint gtk_invoke_key_snoopers (GtkWidget *grab_widget,
117 static void gtk_destroy_closure (gpointer data);
118 static gboolean gtk_invoke_idle_timeout (gpointer data);
119 static void gtk_invoke_input (gpointer data,
121 GdkInputCondition condition);
124 static void gtk_error (gchar *str);
125 static void gtk_warning (gchar *str);
126 static void gtk_message (gchar *str);
127 static void gtk_print (gchar *str);
130 static GtkWindowGroup *gtk_main_get_window_group (GtkWidget *widget);
132 const guint gtk_major_version = GTK_MAJOR_VERSION;
133 const guint gtk_minor_version = GTK_MINOR_VERSION;
134 const guint gtk_micro_version = GTK_MICRO_VERSION;
135 const guint gtk_binary_age = GTK_BINARY_AGE;
136 const guint gtk_interface_age = GTK_INTERFACE_AGE;
138 static guint gtk_main_loop_level = 0;
139 static gint gtk_initialized = FALSE;
140 static GList *current_events = NULL;
142 static GSList *main_loops = NULL; /* stack of currently executing main loops */
144 static GList *init_functions = NULL; /* A list of init functions.
146 static GList *quit_functions = NULL; /* A list of quit functions.
148 static GSList *key_snoopers = NULL;
150 guint gtk_debug_flags = 0; /* Global GTK debug flag */
152 #ifdef G_ENABLE_DEBUG
153 static const GDebugKey gtk_debug_keys[] = {
154 {"misc", GTK_DEBUG_MISC},
155 {"plugsocket", GTK_DEBUG_PLUGSOCKET},
156 {"text", GTK_DEBUG_TEXT},
157 {"tree", GTK_DEBUG_TREE},
158 {"updates", GTK_DEBUG_UPDATES},
159 {"keybindings", GTK_DEBUG_KEYBINDINGS},
160 {"multihead", GTK_DEBUG_MULTIHEAD},
161 {"modules", GTK_DEBUG_MODULES},
162 {"geometry", GTK_DEBUG_GEOMETRY},
163 {"icontheme", GTK_DEBUG_ICONTHEME},
164 {"printing", GTK_DEBUG_PRINTING}
166 #endif /* G_ENABLE_DEBUG */
170 * @required_major: the required major version.
171 * @required_minor: the required minor version.
172 * @required_micro: the required micro version.
174 * Checks that the GTK+ library in use is compatible with the
175 * given version. Generally you would pass in the constants
176 * #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION
177 * as the three arguments to this function; that produces
178 * a check that the library in use is compatible with
179 * the version of GTK+ the application or module was compiled
182 * Compatibility is defined by two things: first the version
183 * of the running library is newer than the version
184 * @required_major.required_minor.@required_micro. Second
185 * the running library must be binary compatible with the
186 * version @required_major.required_minor.@required_micro
187 * (same major version.)
189 * This function is primarily for GTK+ modules; the module
190 * can call this function to check that it wasn't loaded
191 * into an incompatible version of GTK+. However, such a
192 * a check isn't completely reliable, since the module may be
193 * linked against an old version of GTK+ and calling the
194 * old version of gtk_check_version(), but still get loaded
195 * into an application using a newer version of GTK+.
197 * Return value: %NULL if the GTK+ library is compatible with the
198 * given version, or a string describing the version mismatch.
199 * The returned string is owned by GTK+ and should not be modified
203 gtk_check_version (guint required_major,
204 guint required_minor,
205 guint required_micro)
207 gint gtk_effective_micro = 100 * GTK_MINOR_VERSION + GTK_MICRO_VERSION;
208 gint required_effective_micro = 100 * required_minor + required_micro;
210 if (required_major > GTK_MAJOR_VERSION)
211 return "Gtk+ version too old (major mismatch)";
212 if (required_major < GTK_MAJOR_VERSION)
213 return "Gtk+ version too new (major mismatch)";
214 if (required_effective_micro < gtk_effective_micro - GTK_BINARY_AGE)
215 return "Gtk+ version too new (micro mismatch)";
216 if (required_effective_micro > gtk_effective_micro)
217 return "Gtk+ version too old (micro mismatch)";
221 /* This checks to see if the process is running suid or sgid
222 * at the current time. If so, we don't allow GTK+ to be initialized.
223 * This is meant to be a mild check - we only error out if we
224 * can prove the programmer is doing something wrong, not if
225 * they could be doing something wrong. For this reason, we
226 * don't use issetugid() on BSD or prctl (PR_GET_DUMPABLE).
231 /* this isn't at all relevant on MS Windows and doesn't compile ... --hb */
233 uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
234 gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
236 #ifdef HAVE_GETRESUID
237 /* These aren't in the header files, so we prototype them here.
239 int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
240 int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
242 if (getresuid (&ruid, &euid, &suid) != 0 ||
243 getresgid (&rgid, &egid, &sgid) != 0)
244 #endif /* HAVE_GETRESUID */
246 suid = ruid = getuid ();
247 sgid = rgid = getgid ();
252 if (ruid != euid || ruid != suid ||
253 rgid != egid || rgid != sgid)
255 g_warning ("This process is currently running setuid or setgid.\n"
256 "This is not a supported use of GTK+. You must create a helper\n"
257 "program instead. For further details, see:\n\n"
258 " http://www.gtk.org/setuid.html\n\n"
259 "Refusing to initialize GTK+.");
268 G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
271 _gtk_get_datadir (void)
273 static char *gtk_datadir = NULL;
274 if (gtk_datadir == NULL)
275 gtk_datadir = g_win32_get_package_installation_subdirectory
276 (GETTEXT_PACKAGE, dll_name, "share");
282 _gtk_get_libdir (void)
284 static char *gtk_libdir = NULL;
285 if (gtk_libdir == NULL)
286 gtk_libdir = g_win32_get_package_installation_subdirectory
287 (GETTEXT_PACKAGE, dll_name, "lib");
293 _gtk_get_localedir (void)
295 static char *gtk_localedir = NULL;
296 if (gtk_localedir == NULL)
300 temp = g_win32_get_package_installation_subdirectory
301 (GETTEXT_PACKAGE, dll_name, "lib\\locale");
303 /* gtk_localedir is passed to bindtextdomain() which isn't
306 gtk_localedir = g_win32_locale_filename_from_utf8 (temp);
309 return gtk_localedir;
313 _gtk_get_sysconfdir (void)
315 static char *gtk_sysconfdir = NULL;
316 if (gtk_sysconfdir == NULL)
317 gtk_sysconfdir = g_win32_get_package_installation_subdirectory
318 (GETTEXT_PACKAGE, dll_name, "etc");
320 return gtk_sysconfdir;
324 _gtk_get_data_prefix (void)
326 static char *gtk_data_prefix = NULL;
327 if (gtk_data_prefix == NULL)
328 gtk_data_prefix = g_win32_get_package_installation_directory
329 (GETTEXT_PACKAGE, dll_name);
331 return gtk_data_prefix;
334 #endif /* G_OS_WIN32 */
336 static gboolean do_setlocale = TRUE;
339 * gtk_disable_setlocale:
341 * Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and
342 * gtk_parse_args() from automatically
343 * calling <literal>setlocale (LC_ALL, "")</literal>. You would
344 * want to use this function if you wanted to set the locale for
345 * your program to something other than the user's locale, or if
346 * you wanted to set different values for different locale categories.
348 * Most programs should not need to call this function.
351 gtk_disable_setlocale (void)
354 g_warning ("gtk_disable_setlocale() must be called before gtk_init()");
356 do_setlocale = FALSE;
359 #ifdef G_PLATFORM_WIN32
360 #undef gtk_init_check
363 static GString *gtk_modules_string = NULL;
364 static gboolean g_fatal_warnings = FALSE;
366 #ifdef G_ENABLE_DEBUG
368 gtk_arg_debug_cb (const char *key, const char *value, gpointer user_data)
370 gtk_debug_flags |= g_parse_debug_string (value,
372 G_N_ELEMENTS (gtk_debug_keys));
378 gtk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data)
380 gtk_debug_flags &= ~g_parse_debug_string (value,
382 G_N_ELEMENTS (gtk_debug_keys));
386 #endif /* G_ENABLE_DEBUG */
389 gtk_arg_module_cb (const char *key, const char *value, gpointer user_data)
393 if (gtk_modules_string)
394 g_string_append_c (gtk_modules_string, G_SEARCHPATH_SEPARATOR);
396 gtk_modules_string = g_string_new (NULL);
398 g_string_append (gtk_modules_string, value);
404 static const GOptionEntry gtk_args[] = {
405 { "gtk-module", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_module_cb,
406 /* Description of --gtk-module=MODULES in --help output */ N_("Load additional GTK+ modules"),
407 /* Placeholder in --gtk-module=MODULES in --help output */ N_("MODULES") },
408 { "g-fatal-warnings", 0, 0, G_OPTION_ARG_NONE, &g_fatal_warnings,
409 /* Description of --g-fatal-warnings in --help output */ N_("Make all warnings fatal"), NULL },
410 #ifdef G_ENABLE_DEBUG
411 { "gtk-debug", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_debug_cb,
412 /* Description of --gtk-debug=FLAGS in --help output */ N_("GTK+ debugging flags to set"),
413 /* Placeholder in --gtk-debug=FLAGS in --help output */ N_("FLAGS") },
414 { "gtk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_no_debug_cb,
415 /* Description of --gtk-no-debug=FLAGS in --help output */ N_("GTK+ debugging flags to unset"),
416 /* Placeholder in --gtk-no-debug=FLAGS in --help output */ N_("FLAGS") },
423 static char *iso639_to_check = NULL;
424 static char *iso3166_to_check = NULL;
425 static char *script_to_check = NULL;
426 static gboolean setlocale_called = FALSE;
429 enum_locale_proc (LPTSTR locale)
437 lcid = strtoul (locale, &endptr, 16);
438 if (*endptr == '\0' &&
439 GetLocaleInfo (lcid, LOCALE_SISO639LANGNAME, iso639, sizeof (iso639)) &&
440 GetLocaleInfo (lcid, LOCALE_SISO3166CTRYNAME, iso3166, sizeof (iso3166)))
442 if (strcmp (iso639, iso639_to_check) == 0 &&
443 ((iso3166_to_check != NULL &&
444 strcmp (iso3166, iso3166_to_check) == 0) ||
445 (iso3166_to_check == NULL &&
446 SUBLANGID (LANGIDFROMLCID (lcid)) == SUBLANG_DEFAULT)))
448 char language[100], country[100];
451 if (script_to_check != NULL)
453 /* If lcid is the "other" script for this language,
454 * return TRUE, i.e. continue looking.
456 if (strcmp (script_to_check, "Latn") == 0)
458 switch (LANGIDFROMLCID (lcid))
460 case MAKELANGID (LANG_AZERI, SUBLANG_AZERI_CYRILLIC):
462 case MAKELANGID (LANG_UZBEK, SUBLANG_UZBEK_CYRILLIC):
464 case MAKELANGID (LANG_SERBIAN, SUBLANG_SERBIAN_CYRILLIC):
466 case MAKELANGID (LANG_SERBIAN, 0x07):
467 /* Serbian in Bosnia and Herzegovina, Cyrillic */
471 else if (strcmp (script_to_check, "Cyrl") == 0)
473 switch (LANGIDFROMLCID (lcid))
475 case MAKELANGID (LANG_AZERI, SUBLANG_AZERI_LATIN):
477 case MAKELANGID (LANG_UZBEK, SUBLANG_UZBEK_LATIN):
479 case MAKELANGID (LANG_SERBIAN, SUBLANG_SERBIAN_LATIN):
481 case MAKELANGID (LANG_SERBIAN, 0x06):
482 /* Serbian in Bosnia and Herzegovina, Latin */
488 SetThreadLocale (lcid);
490 if (GetLocaleInfo (lcid, LOCALE_SENGLANGUAGE, language, sizeof (language)) &&
491 GetLocaleInfo (lcid, LOCALE_SENGCOUNTRY, country, sizeof (country)))
493 strcpy (locale, language);
494 strcat (locale, "_");
495 strcat (locale, country);
497 if (setlocale (LC_ALL, locale) != NULL)
498 setlocale_called = TRUE;
511 do_pre_parse_initialization (int *argc,
514 const gchar *env_string;
517 g_set_error_handler (gtk_error);
518 g_set_warning_handler (gtk_warning);
519 g_set_message_handler (gtk_message);
520 g_set_print_handler (gtk_print);
526 /* If some of the POSIXish environment variables are set, set
527 * the Win32 thread locale correspondingly.
529 char *p = getenv ("LC_ALL");
536 if (strcmp (p, "C") == 0)
537 SetThreadLocale (LOCALE_SYSTEM_DEFAULT);
540 /* Check if one of the supported locales match the
541 * environment variable. If so, use that locale.
544 iso3166_to_check = strchr (iso639_to_check, '_');
545 if (iso3166_to_check != NULL)
547 *iso3166_to_check++ = '\0';
549 script_to_check = strchr (iso3166_to_check, '@');
550 if (script_to_check != NULL)
551 *script_to_check++ = '\0';
553 /* Handle special cases. */
555 /* The standard code for Serbia and Montenegro was
556 * "CS", but MSFT uses for some reason "SP". By now
557 * (October 2006), SP has split into two, "RS" and
558 * "ME", but don't bother trying to handle those
559 * yet. Do handle the even older "YU", though.
561 if (strcmp (iso3166_to_check, "CS") == 0 ||
562 strcmp (iso3166_to_check, "YU") == 0)
563 iso3166_to_check = "SP";
567 script_to_check = strchr (iso639_to_check, '@');
568 if (script_to_check != NULL)
569 *script_to_check++ = '\0';
570 /* LANG_SERBIAN == LANG_CROATIAN, recognize just "sr" */
571 if (strcmp (iso639_to_check, "sr") == 0)
572 iso3166_to_check = "SP";
575 EnumSystemLocales (enum_locale_proc, LCID_SUPPORTED);
579 if (!setlocale_called)
580 setlocale (LC_ALL, "");
582 if (!setlocale (LC_ALL, ""))
583 g_warning ("Locale not supported by C library.\n\tUsing the fallback 'C' locale.");
587 gdk_pre_parse_libgtk_only ();
588 gdk_event_handler_set ((GdkEventFunc)gtk_main_do_event, NULL, NULL);
590 #ifdef G_ENABLE_DEBUG
591 env_string = g_getenv ("GTK_DEBUG");
592 if (env_string != NULL)
594 gtk_debug_flags = g_parse_debug_string (env_string,
596 G_N_ELEMENTS (gtk_debug_keys));
599 #endif /* G_ENABLE_DEBUG */
601 env_string = g_getenv ("GTK_MODULES");
603 gtk_modules_string = g_string_new (env_string);
607 gettext_initialization (void)
610 bindtextdomain (GETTEXT_PACKAGE, GTK_LOCALEDIR);
611 bindtextdomain (GETTEXT_PACKAGE "-properties", GTK_LOCALEDIR);
612 # ifdef HAVE_BIND_TEXTDOMAIN_CODESET
613 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
614 bind_textdomain_codeset (GETTEXT_PACKAGE "-properties", "UTF-8");
620 do_post_parse_initialization (int *argc,
626 gettext_initialization ();
628 if (g_fatal_warnings)
630 GLogLevelFlags fatal_mask;
632 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
633 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
634 g_log_set_always_fatal (fatal_mask);
637 if (gtk_debug_flags & GTK_DEBUG_UPDATES)
638 gdk_window_set_debug_updates (TRUE);
641 /* Translate to default:RTL if you want your widgets
642 * to be RTL, otherwise translate to default:LTR.
643 * Do *not* translate it to "predefinito:LTR", if it
644 * it isn't default:LTR or default:RTL it will not work
646 char *e = _("default:LTR");
647 if (strcmp (e, "default:RTL")==0) {
648 gtk_widget_set_default_direction (GTK_TEXT_DIR_RTL);
649 } else if (strcmp (e, "default:LTR")) {
650 g_warning ("Whoever translated default:LTR did so wrongly.\n");
655 _gtk_accel_map_init ();
658 /* Set the 'initialized' flag.
660 gtk_initialized = TRUE;
662 /* load gtk modules */
663 if (gtk_modules_string)
665 _gtk_modules_init (argc, argv, gtk_modules_string->str);
666 g_string_free (gtk_modules_string, TRUE);
673 gboolean open_default_display;
677 pre_parse_hook (GOptionContext *context,
682 do_pre_parse_initialization (NULL, NULL);
688 post_parse_hook (GOptionContext *context,
693 OptionGroupInfo *info = data;
696 do_post_parse_initialization (NULL, NULL);
698 if (info->open_default_display)
700 if (gdk_display_open_default_libgtk_only () == NULL)
702 const char *display_name = gdk_get_display_arg_name ();
705 G_OPTION_ERROR_FAILED,
706 "cannot open display: %s",
707 display_name ? display_name : "" );
718 * gtk_get_option_group:
719 * @open_default_display: whether to open the default display
720 * when parsing the commandline arguments
722 * Returns a #GOptionGroup for the commandline arguments recognized
723 * by GTK+ and GDK. You should add this group to your #GOptionContext
724 * with g_option_context_add_group(), if you are using
725 * g_option_context_parse() to parse your commandline arguments.
727 * Returns a #GOptionGroup for the commandline arguments recognized
733 gtk_get_option_group (gboolean open_default_display)
736 OptionGroupInfo *info;
738 gettext_initialization ();
740 info = g_new0 (OptionGroupInfo, 1);
741 info->open_default_display = open_default_display;
743 group = g_option_group_new ("gtk", _("GTK+ Options"), _("Show GTK+ Options"), info, g_free);
744 g_option_group_set_parse_hooks (group, pre_parse_hook, post_parse_hook);
746 gdk_add_option_entries_libgtk_only (group);
747 g_option_group_add_entries (group, gtk_args);
748 g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
754 * gtk_init_with_args:
755 * @argc: a pointer to the number of command line arguments.
756 * @argv: a pointer to the array of command line arguments.
757 * @parameter_string: a string which is displayed in
758 * the first line of <option>--help</option> output, after
759 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
760 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
761 * describing the options of your program
762 * @translation_domain: a translation domain to use for translating
763 * the <option>--help</option> output for the options in @entries
764 * with gettext(), or %NULL
765 * @error: a return location for errors
767 * This function does the same work as gtk_init_check().
768 * Additionally, it allows you to add your own commandline options,
769 * and it automatically generates nicely formatted
770 * <option>--help</option> output. Note that your program will
771 * be terminated after writing out the help output.
773 * Returns: %TRUE if the GUI has been successfully initialized,
779 gtk_init_with_args (int *argc,
781 char *parameter_string,
782 GOptionEntry *entries,
783 char *translation_domain,
786 GOptionContext *context;
787 GOptionGroup *gtk_group;
793 gettext_initialization ();
795 if (!check_setugid ())
798 gtk_group = gtk_get_option_group (TRUE);
800 context = g_option_context_new (parameter_string);
801 g_option_context_add_group (context, gtk_group);
804 g_option_context_add_main_entries (context, entries, translation_domain);
805 retval = g_option_context_parse (context, argc, argv, error);
807 g_option_context_free (context);
815 * @argc: a pointer to the number of command line arguments.
816 * @argv: a pointer to the array of command line arguments.
818 * Parses command line arguments, and initializes global
819 * attributes of GTK+, but does not actually open a connection
820 * to a display. (See gdk_display_open(), gdk_get_display_arg_name())
822 * Any arguments used by GTK+ or GDK are removed from the array and
823 * @argc and @argv are updated accordingly.
825 * You shouldn't call this function explicitely if you are using
826 * gtk_init(), or gtk_init_check().
828 * Return value: %TRUE if initialization succeeded, otherwise %FALSE.
831 gtk_parse_args (int *argc,
834 GOptionContext *option_context;
835 GOptionGroup *gtk_group;
836 GError *error = NULL;
841 gettext_initialization ();
843 if (!check_setugid ())
846 option_context = g_option_context_new (NULL);
847 g_option_context_set_ignore_unknown_options (option_context, TRUE);
848 g_option_context_set_help_enabled (option_context, FALSE);
849 gtk_group = gtk_get_option_group (FALSE);
850 g_option_context_set_main_group (option_context, gtk_group);
851 if (!g_option_context_parse (option_context, argc, argv, &error))
853 g_warning ("%s", error->message);
854 g_error_free (error);
857 g_option_context_free (option_context);
862 #ifdef G_PLATFORM_WIN32
863 #undef gtk_init_check
868 * @argc: Address of the <parameter>argc</parameter> parameter of your
869 * main() function. Changed if any arguments were handled.
870 * @argv: Address of the <parameter>argv</parameter> parameter of main().
871 * Any parameters understood by gtk_init() are stripped before return.
873 * This function does the same work as gtk_init() with only
874 * a single change: It does not terminate the program if the GUI can't be
875 * initialized. Instead it returns %FALSE on failure.
877 * This way the application can fall back to some other means of communication
878 * with the user - for example a curses or command line interface.
880 * Return value: %TRUE if the GUI has been successfully initialized,
884 gtk_init_check (int *argc,
887 if (!gtk_parse_args (argc, argv))
890 return gdk_display_open_default_libgtk_only () != NULL;
893 #ifdef G_PLATFORM_WIN32
899 * @argc: Address of the <parameter>argc</parameter> parameter of your
900 * main() function. Changed if any arguments were handled.
901 * @argv: Address of the <parameter>argv</parameter> parameter of main().
902 * Any parameters understood by gtk_init() are stripped before return.
904 * Call this function before using any other GTK+ functions in your GUI
905 * applications. It will initialize everything needed to operate the
906 * toolkit and parses some standard command line options. @argc and
907 * @argv are adjusted accordingly so your own code will
908 * never see those standard arguments.
910 * Note that there are some alternative ways to initialize GTK+:
911 * if you are calling gtk_parse_args(), gtk_init_check(),
912 * gtk_init_with_args() or g_option_context_parse() with
913 * the option group returned by gtk_get_option_group(), you
914 * <emphasis>don't</emphasis> have to call gtk_init().
917 * This function will terminate your program if it was unable to initialize
918 * the GUI for some reason. If you want your program to fall back to a
919 * textual interface you want to call gtk_init_check() instead.
923 gtk_init (int *argc, char ***argv)
925 if (!gtk_init_check (argc, argv))
927 const char *display_name_arg = gdk_get_display_arg_name ();
928 g_warning ("cannot open display: %s", display_name_arg ? display_name_arg : " ");
933 #ifdef G_PLATFORM_WIN32
936 check_sizeof_GtkWindow (size_t sizeof_GtkWindow)
938 if (sizeof_GtkWindow != sizeof (GtkWindow))
939 g_error ("Incompatible build!\n"
940 "The code using GTK+ thinks GtkWindow is of different\n"
941 "size than it actually is in this build of GTK+.\n"
942 "On Windows, this probably means that you have compiled\n"
943 "your code with gcc without the -mms-bitfields switch,\n"
944 "or that you are using an unsupported compiler.");
947 /* In GTK+ 2.0 the GtkWindow struct actually is the same size in
948 * gcc-compiled code on Win32 whether compiled with -fnative-struct or
949 * not. Unfortunately this wan't noticed until after GTK+ 2.0.1. So,
950 * from GTK+ 2.0.2 on, check some other struct, too, where the use of
951 * -fnative-struct still matters. GtkBox is one such.
954 check_sizeof_GtkBox (size_t sizeof_GtkBox)
956 if (sizeof_GtkBox != sizeof (GtkBox))
957 g_error ("Incompatible build!\n"
958 "The code using GTK+ thinks GtkBox is of different\n"
959 "size than it actually is in this build of GTK+.\n"
960 "On Windows, this probably means that you have compiled\n"
961 "your code with gcc without the -mms-bitfields switch,\n"
962 "or that you are using an unsupported compiler.");
965 /* These two functions might get more checks added later, thus pass
966 * in the number of extra args.
969 gtk_init_abi_check (int *argc, char ***argv, int num_checks, size_t sizeof_GtkWindow, size_t sizeof_GtkBox)
971 check_sizeof_GtkWindow (sizeof_GtkWindow);
973 check_sizeof_GtkBox (sizeof_GtkBox);
974 gtk_init (argc, argv);
978 gtk_init_check_abi_check (int *argc, char ***argv, int num_checks, size_t sizeof_GtkWindow, size_t sizeof_GtkBox)
980 check_sizeof_GtkWindow (sizeof_GtkWindow);
982 check_sizeof_GtkBox (sizeof_GtkBox);
983 return gtk_init_check (argc, argv);
989 gtk_exit (gint errorcode)
998 * Initializes internationalization support for GTK+. gtk_init()
999 * automatically does this, so there is typically no point
1000 * in calling this function.
1002 * If you are calling this function because you changed the locale
1003 * after GTK+ is was initialized, then calling this function
1004 * may help a bit. (Note, however, that changing the locale
1005 * after GTK+ is initialized may produce inconsistent results and
1006 * is not really supported.)
1008 * In detail - sets the current locale according to the
1009 * program environment. This is the same as calling the C library function
1010 * <literal>setlocale (LC_ALL, "")</literal> but also takes care of the
1011 * locale specific setup of the windowing system used by GDK.
1013 * Returns: a string corresponding to the locale set, typically in the
1014 * form lang_COUNTRY, where lang is an ISO-639 language code, and
1015 * COUNTRY is an ISO-3166 country code. On Unix, this form matches the
1016 * result of the setlocale(); it is also used on other machines, such as
1017 * Windows, where the C library returns a different result. The string is
1018 * owned by GTK+ and should not be modified or freed.
1021 gtk_set_locale (void)
1023 return gdk_set_locale ();
1027 * _gtk_get_lc_ctype:
1029 * Return the Unix-style locale string for the language currently in
1030 * effect. On Unix systems, this is the return value from
1031 * <literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
1032 * affect this through the environment variables LC_ALL, LC_CTYPE or
1033 * LANG (checked in that order). The locale strings typically is in
1034 * the form lang_COUNTRY, where lang is an ISO-639 language code, and
1035 * COUNTRY is an ISO-3166 country code. For instance, sv_FI for
1036 * Swedish as written in Finland or pt_BR for Portuguese as written in
1039 * On Windows, the C library doesn't use any such environment
1040 * variables, and setting them won't affect the behaviour of functions
1041 * like ctime(). The user sets the locale through the Regional Options
1042 * in the Control Panel. The C library (in the setlocale() function)
1043 * does not use country and language codes, but country and language
1044 * names spelled out in English.
1045 * However, this function does check the above environment
1046 * variables, and does return a Unix-style locale string based on
1047 * either said environment variables or the thread's current locale.
1049 * Return value: a dynamically allocated string, free with g_free().
1053 _gtk_get_lc_ctype (void)
1056 /* Somebody might try to set the locale for this process using the
1057 * LANG or LC_ environment variables. The Microsoft C library
1058 * doesn't know anything about them. You set the locale in the
1059 * Control Panel. Setting these env vars won't have any affect on
1060 * locale-dependent C library functions like ctime(). But just for
1061 * kicks, do obey LC_ALL, LC_CTYPE and LANG in GTK. (This also makes
1062 * it easier to test GTK and Pango in various default languages, you
1063 * don't have to clickety-click in the Control Panel, you can simply
1064 * start the program with LC_ALL=something on the command line.)
1068 p = getenv ("LC_ALL");
1070 return g_strdup (p);
1072 p = getenv ("LC_CTYPE");
1074 return g_strdup (p);
1076 p = getenv ("LANG");
1078 return g_strdup (p);
1080 return g_win32_getlocale ();
1082 return g_strdup (setlocale (LC_CTYPE, NULL));
1087 * gtk_get_default_language:
1089 * Returns the #PangoLanguage for the default language currently in
1090 * effect. (Note that this can change over the life of an
1091 * application.) The default language is derived from the current
1092 * locale. It determines, for example, whether GTK+ uses the
1093 * right-to-left or left-to-right text direction.
1095 * This function is equivalent to pango_language_get_default(). See
1096 * that function for details.
1098 * Return value: the default language as a #PangoLanguage, must not be
1102 gtk_get_default_language (void)
1104 return pango_language_get_default ();
1112 GtkInitFunction *init;
1115 gtk_main_loop_level++;
1117 loop = g_main_loop_new (NULL, TRUE);
1118 main_loops = g_slist_prepend (main_loops, loop);
1120 tmp_list = functions = init_functions;
1121 init_functions = NULL;
1125 init = tmp_list->data;
1126 tmp_list = tmp_list->next;
1128 (* init->function) (init->data);
1131 g_list_free (functions);
1133 if (g_main_loop_is_running (main_loops->data))
1135 GDK_THREADS_LEAVE ();
1136 g_main_loop_run (loop);
1137 GDK_THREADS_ENTER ();
1143 GList *reinvoke_list = NULL;
1144 GtkQuitFunction *quitf;
1146 while (quit_functions)
1148 quitf = quit_functions->data;
1150 tmp_list = quit_functions;
1151 quit_functions = g_list_remove_link (quit_functions, quit_functions);
1152 g_list_free_1 (tmp_list);
1154 if ((quitf->main_level && quitf->main_level != gtk_main_loop_level) ||
1155 gtk_quit_invoke_function (quitf))
1157 reinvoke_list = g_list_prepend (reinvoke_list, quitf);
1161 gtk_quit_destroy (quitf);
1168 work = g_list_last (reinvoke_list);
1170 quit_functions->prev = work;
1171 work->next = quit_functions;
1172 quit_functions = work;
1178 main_loops = g_slist_remove (main_loops, loop);
1180 g_main_loop_unref (loop);
1182 gtk_main_loop_level--;
1184 /* Try storing all clipboard data we have */
1185 if (gtk_main_loop_level == 0)
1186 _gtk_clipboard_store_all ();
1190 gtk_main_level (void)
1192 return gtk_main_loop_level;
1196 gtk_main_quit (void)
1198 g_return_if_fail (main_loops != NULL);
1200 g_main_loop_quit (main_loops->data);
1204 gtk_events_pending (void)
1208 GDK_THREADS_LEAVE ();
1209 result = g_main_context_pending (NULL);
1210 GDK_THREADS_ENTER ();
1216 gtk_main_iteration (void)
1218 GDK_THREADS_LEAVE ();
1219 g_main_context_iteration (NULL, TRUE);
1220 GDK_THREADS_ENTER ();
1223 return !g_main_loop_is_running (main_loops->data);
1229 gtk_main_iteration_do (gboolean blocking)
1231 GDK_THREADS_LEAVE ();
1232 g_main_context_iteration (NULL, blocking);
1233 GDK_THREADS_ENTER ();
1236 return !g_main_loop_is_running (main_loops->data);
1241 /* private libgtk to libgdk interfaces
1243 gboolean gdk_pointer_grab_info_libgtk_only (GdkDisplay *display,
1244 GdkWindow **grab_window,
1245 gboolean *owner_events);
1246 gboolean gdk_keyboard_grab_info_libgtk_only (GdkDisplay *display,
1247 GdkWindow **grab_window,
1248 gboolean *owner_events);
1251 rewrite_events_translate (GdkWindow *old_window,
1252 GdkWindow *new_window,
1256 gint old_origin_x, old_origin_y;
1257 gint new_origin_x, new_origin_y;
1259 gdk_window_get_origin (old_window, &old_origin_x, &old_origin_y);
1260 gdk_window_get_origin (new_window, &new_origin_x, &new_origin_y);
1262 *x += old_origin_x - new_origin_x;
1263 *y += old_origin_y - new_origin_y;
1267 rewrite_event_for_window (GdkEvent *event,
1268 GdkWindow *new_window)
1270 event = gdk_event_copy (event);
1272 switch (event->type)
1275 rewrite_events_translate (event->any.window,
1277 &event->scroll.x, &event->scroll.y);
1279 case GDK_BUTTON_PRESS:
1280 case GDK_2BUTTON_PRESS:
1281 case GDK_3BUTTON_PRESS:
1282 case GDK_BUTTON_RELEASE:
1283 rewrite_events_translate (event->any.window,
1285 &event->button.x, &event->button.y);
1287 case GDK_MOTION_NOTIFY:
1288 rewrite_events_translate (event->any.window,
1290 &event->motion.x, &event->motion.y);
1293 case GDK_KEY_RELEASE:
1294 case GDK_PROXIMITY_IN:
1295 case GDK_PROXIMITY_OUT:
1302 g_object_unref (event->any.window);
1303 event->any.window = g_object_ref (new_window);
1308 /* If there is a pointer or keyboard grab in effect with owner_events = TRUE,
1309 * then what X11 does is deliver the event normally if it was going to this
1310 * client, otherwise, delivers it in terms of the grab window. This function
1311 * rewrites events to the effect that events going to the same window group
1312 * are delivered normally, otherwise, the event is delivered in terms of the
1316 rewrite_event_for_grabs (GdkEvent *event)
1318 GdkWindow *grab_window;
1319 GtkWidget *event_widget, *grab_widget;
1320 gboolean owner_events;
1321 GdkDisplay *display;
1323 switch (event->type)
1326 case GDK_BUTTON_PRESS:
1327 case GDK_2BUTTON_PRESS:
1328 case GDK_3BUTTON_PRESS:
1329 case GDK_BUTTON_RELEASE:
1330 case GDK_MOTION_NOTIFY:
1331 case GDK_PROXIMITY_IN:
1332 case GDK_PROXIMITY_OUT:
1333 display = gdk_drawable_get_display (event->proximity.window);
1334 if (!gdk_pointer_grab_info_libgtk_only (display, &grab_window, &owner_events) ||
1340 case GDK_KEY_RELEASE:
1341 display = gdk_drawable_get_display (event->key.window);
1342 if (!gdk_keyboard_grab_info_libgtk_only (display, &grab_window, &owner_events) ||
1351 event_widget = gtk_get_event_widget (event);
1352 gdk_window_get_user_data (grab_window, (void**) &grab_widget);
1355 gtk_main_get_window_group (grab_widget) != gtk_main_get_window_group (event_widget))
1356 return rewrite_event_for_window (event, grab_window);
1362 gtk_main_do_event (GdkEvent *event)
1364 GtkWidget *event_widget;
1365 GtkWidget *grab_widget;
1366 GtkWindowGroup *window_group;
1367 GdkEvent *next_event;
1368 GdkEvent *rewritten_event = NULL;
1371 /* If there are any events pending then get the next one.
1373 next_event = gdk_event_peek ();
1375 /* Try to compress enter/leave notify events. These event
1376 * pairs occur when the mouse is dragged quickly across
1377 * a window with many buttons (or through a menu). Instead
1378 * of highlighting and de-highlighting each widget that
1379 * is crossed it is better to simply de-highlight the widget
1380 * which contained the mouse initially and highlight the
1381 * widget which ends up containing the mouse.
1384 if (((event->type == GDK_ENTER_NOTIFY) ||
1385 (event->type == GDK_LEAVE_NOTIFY)) &&
1386 ((next_event->type == GDK_ENTER_NOTIFY) ||
1387 (next_event->type == GDK_LEAVE_NOTIFY)) &&
1388 (next_event->type != event->type) &&
1389 (next_event->any.window == event->any.window))
1391 /* Throw both the peeked copy and the queued copy away
1393 gdk_event_free (next_event);
1394 next_event = gdk_event_get ();
1395 gdk_event_free (next_event);
1401 gdk_event_free (next_event);
1403 if (event->type == GDK_SETTING)
1405 _gtk_settings_handle_event (&event->setting);
1409 if (event->type == GDK_OWNER_CHANGE)
1411 _gtk_clipboard_handle_event (&event->owner_change);
1415 /* Find the widget which got the event. We store the widget
1416 * in the user_data field of GdkWindow's.
1417 * Ignore the event if we don't have a widget for it, except
1418 * for GDK_PROPERTY_NOTIFY events which are handled specialy.
1419 * Though this happens rarely, bogus events can occour
1420 * for e.g. destroyed GdkWindows.
1422 event_widget = gtk_get_event_widget (event);
1425 /* To handle selection INCR transactions, we select
1426 * PropertyNotify events on the requestor window and create
1427 * a corresponding (fake) GdkWindow so that events get
1428 * here. There won't be a widget though, so we have to handle
1431 if (event->type == GDK_PROPERTY_NOTIFY)
1432 _gtk_selection_incr_event (event->any.window,
1438 /* If pointer or keyboard grabs are in effect, munge the events
1439 * so that each window group looks like a separate app.
1441 rewritten_event = rewrite_event_for_grabs (event);
1442 if (rewritten_event)
1444 event = rewritten_event;
1445 event_widget = gtk_get_event_widget (event);
1448 window_group = gtk_main_get_window_group (event_widget);
1450 /* Push the event onto a stack of current events for
1451 * gtk_current_event_get().
1453 current_events = g_list_prepend (current_events, event);
1455 /* If there is a grab in effect...
1457 if (window_group->grabs)
1459 grab_widget = window_group->grabs->data;
1461 /* If the grab widget is an ancestor of the event widget
1462 * then we send the event to the original event widget.
1463 * This is the key to implementing modality.
1465 if (GTK_WIDGET_IS_SENSITIVE (event_widget) &&
1466 gtk_widget_is_ancestor (event_widget, grab_widget))
1467 grab_widget = event_widget;
1471 grab_widget = event_widget;
1474 /* Not all events get sent to the grabbing widget.
1475 * The delete, destroy, expose, focus change and resize
1476 * events still get sent to the event widget because
1477 * 1) these events have no meaning for the grabbing widget
1478 * and 2) redirecting these events to the grabbing widget
1479 * could cause the display to be messed up.
1481 * Drag events are also not redirected, since it isn't
1482 * clear what the semantics of that would be.
1484 switch (event->type)
1490 g_object_ref (event_widget);
1491 if ((!window_group->grabs || gtk_widget_get_toplevel (window_group->grabs->data) == event_widget) &&
1492 !gtk_widget_event (event_widget, event))
1493 gtk_widget_destroy (event_widget);
1494 g_object_unref (event_widget);
1498 /* Unexpected GDK_DESTROY from the outside, ignore for
1499 * child windows, handle like a GDK_DELETE for toplevels
1501 if (!event_widget->parent)
1503 g_object_ref (event_widget);
1504 if (!gtk_widget_event (event_widget, event) &&
1505 GTK_WIDGET_REALIZED (event_widget))
1506 gtk_widget_destroy (event_widget);
1507 g_object_unref (event_widget);
1512 if (event->any.window && GTK_WIDGET_DOUBLE_BUFFERED (event_widget))
1514 gdk_window_begin_paint_region (event->any.window, event->expose.region);
1515 gtk_widget_send_expose (event_widget, event);
1516 gdk_window_end_paint (event->any.window);
1519 gtk_widget_send_expose (event_widget, event);
1522 case GDK_PROPERTY_NOTIFY:
1524 case GDK_FOCUS_CHANGE:
1528 case GDK_SELECTION_CLEAR:
1529 case GDK_SELECTION_REQUEST:
1530 case GDK_SELECTION_NOTIFY:
1531 case GDK_CLIENT_EVENT:
1532 case GDK_VISIBILITY_NOTIFY:
1533 case GDK_WINDOW_STATE:
1534 case GDK_GRAB_BROKEN:
1535 gtk_widget_event (event_widget, event);
1539 case GDK_BUTTON_PRESS:
1540 case GDK_2BUTTON_PRESS:
1541 case GDK_3BUTTON_PRESS:
1542 gtk_propagate_event (grab_widget, event);
1546 case GDK_KEY_RELEASE:
1549 if (gtk_invoke_key_snoopers (grab_widget, event))
1552 /* else fall through */
1553 case GDK_MOTION_NOTIFY:
1554 case GDK_BUTTON_RELEASE:
1555 case GDK_PROXIMITY_IN:
1556 case GDK_PROXIMITY_OUT:
1557 gtk_propagate_event (grab_widget, event);
1560 case GDK_ENTER_NOTIFY:
1561 if (GTK_WIDGET_IS_SENSITIVE (grab_widget))
1563 g_object_ref (event_widget);
1565 gtk_widget_event (grab_widget, event);
1566 if (event_widget == grab_widget)
1567 GTK_PRIVATE_SET_FLAG (event_widget, GTK_LEAVE_PENDING);
1569 g_object_unref (event_widget);
1573 case GDK_LEAVE_NOTIFY:
1574 if (GTK_WIDGET_LEAVE_PENDING (event_widget))
1576 GTK_PRIVATE_UNSET_FLAG (event_widget, GTK_LEAVE_PENDING);
1577 gtk_widget_event (event_widget, event);
1579 else if (GTK_WIDGET_IS_SENSITIVE (grab_widget))
1580 gtk_widget_event (grab_widget, event);
1583 case GDK_DRAG_STATUS:
1584 case GDK_DROP_FINISHED:
1585 _gtk_drag_source_handle_event (event_widget, event);
1587 case GDK_DRAG_ENTER:
1588 case GDK_DRAG_LEAVE:
1589 case GDK_DRAG_MOTION:
1590 case GDK_DROP_START:
1591 _gtk_drag_dest_handle_event (event_widget, event);
1594 g_assert_not_reached ();
1598 if (event->type == GDK_ENTER_NOTIFY
1599 || event->type == GDK_LEAVE_NOTIFY
1600 || event->type == GDK_BUTTON_PRESS
1601 || event->type == GDK_2BUTTON_PRESS
1602 || event->type == GDK_3BUTTON_PRESS
1603 || event->type == GDK_KEY_PRESS
1604 || event->type == GDK_DRAG_ENTER
1605 || event->type == GDK_GRAB_BROKEN
1606 || event->type == GDK_MOTION_NOTIFY
1607 || event->type == GDK_SCROLL)
1609 _gtk_tooltip_handle_event (event);
1612 tmp_list = current_events;
1613 current_events = g_list_remove_link (current_events, tmp_list);
1614 g_list_free_1 (tmp_list);
1616 if (rewritten_event)
1617 gdk_event_free (rewritten_event);
1632 static GtkWindowGroup *
1633 gtk_main_get_window_group (GtkWidget *widget)
1635 GtkWidget *toplevel = NULL;
1638 toplevel = gtk_widget_get_toplevel (widget);
1640 if (toplevel && GTK_IS_WINDOW (toplevel))
1641 return gtk_window_get_group (GTK_WINDOW (toplevel));
1643 return gtk_window_get_group (NULL);
1648 GtkWidget *old_grab_widget;
1649 GtkWidget *new_grab_widget;
1650 gboolean was_grabbed;
1651 gboolean is_grabbed;
1655 gtk_grab_notify_foreach (GtkWidget *child,
1659 GrabNotifyInfo *info = data;
1661 gboolean was_grabbed, is_grabbed, was_shadowed, is_shadowed;
1663 was_grabbed = info->was_grabbed;
1664 is_grabbed = info->is_grabbed;
1666 info->was_grabbed = info->was_grabbed || (child == info->old_grab_widget);
1667 info->is_grabbed = info->is_grabbed || (child == info->new_grab_widget);
1669 was_shadowed = info->old_grab_widget && !info->was_grabbed;
1670 is_shadowed = info->new_grab_widget && !info->is_grabbed;
1672 g_object_ref (child);
1674 if (was_shadowed != is_shadowed)
1675 _gtk_widget_grab_notify (child, was_shadowed);
1677 if ((was_shadowed || is_shadowed) && GTK_IS_CONTAINER (child))
1678 gtk_container_forall (GTK_CONTAINER (child), gtk_grab_notify_foreach, info);
1680 g_object_unref (child);
1682 info->was_grabbed = was_grabbed;
1683 info->is_grabbed = is_grabbed;
1687 gtk_grab_notify (GtkWindowGroup *group,
1688 GtkWidget *old_grab_widget,
1689 GtkWidget *new_grab_widget)
1692 GrabNotifyInfo info;
1694 if (old_grab_widget == new_grab_widget)
1697 info.old_grab_widget = old_grab_widget;
1698 info.new_grab_widget = new_grab_widget;
1700 g_object_ref (group);
1702 toplevels = gtk_window_list_toplevels ();
1703 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
1707 GtkWindow *toplevel = toplevels->data;
1708 toplevels = g_list_delete_link (toplevels, toplevels);
1710 info.was_grabbed = FALSE;
1711 info.is_grabbed = FALSE;
1713 if (group == gtk_window_get_group (toplevel))
1714 gtk_grab_notify_foreach (GTK_WIDGET (toplevel), &info);
1715 g_object_unref (toplevel);
1718 g_object_unref (group);
1722 gtk_grab_add (GtkWidget *widget)
1724 GtkWindowGroup *group;
1725 GtkWidget *old_grab_widget;
1727 g_return_if_fail (widget != NULL);
1729 if (!GTK_WIDGET_HAS_GRAB (widget) && GTK_WIDGET_IS_SENSITIVE (widget))
1731 GTK_WIDGET_SET_FLAGS (widget, GTK_HAS_GRAB);
1733 group = gtk_main_get_window_group (widget);
1736 old_grab_widget = (GtkWidget *)group->grabs->data;
1738 old_grab_widget = NULL;
1740 g_object_ref (widget);
1741 group->grabs = g_slist_prepend (group->grabs, widget);
1743 gtk_grab_notify (group, old_grab_widget, widget);
1748 gtk_grab_get_current (void)
1750 GtkWindowGroup *group;
1752 group = gtk_main_get_window_group (NULL);
1755 return GTK_WIDGET (group->grabs->data);
1760 gtk_grab_remove (GtkWidget *widget)
1762 GtkWindowGroup *group;
1763 GtkWidget *new_grab_widget;
1765 g_return_if_fail (widget != NULL);
1767 if (GTK_WIDGET_HAS_GRAB (widget))
1769 GTK_WIDGET_UNSET_FLAGS (widget, GTK_HAS_GRAB);
1771 group = gtk_main_get_window_group (widget);
1772 group->grabs = g_slist_remove (group->grabs, widget);
1775 new_grab_widget = (GtkWidget *)group->grabs->data;
1777 new_grab_widget = NULL;
1779 gtk_grab_notify (group, widget, new_grab_widget);
1781 g_object_unref (widget);
1786 gtk_init_add (GtkFunction function,
1789 GtkInitFunction *init;
1791 init = g_new (GtkInitFunction, 1);
1792 init->function = function;
1795 init_functions = g_list_prepend (init_functions, init);
1799 gtk_key_snooper_install (GtkKeySnoopFunc snooper,
1802 GtkKeySnooperData *data;
1803 static guint snooper_id = 1;
1805 g_return_val_if_fail (snooper != NULL, 0);
1807 data = g_new (GtkKeySnooperData, 1);
1808 data->func = snooper;
1809 data->func_data = func_data;
1810 data->id = snooper_id++;
1811 key_snoopers = g_slist_prepend (key_snoopers, data);
1817 gtk_key_snooper_remove (guint snooper_id)
1819 GtkKeySnooperData *data = NULL;
1822 slist = key_snoopers;
1826 if (data->id == snooper_id)
1829 slist = slist->next;
1834 key_snoopers = g_slist_remove (key_snoopers, data);
1840 gtk_invoke_key_snoopers (GtkWidget *grab_widget,
1844 gint return_val = FALSE;
1846 slist = key_snoopers;
1847 while (slist && !return_val)
1849 GtkKeySnooperData *data;
1852 slist = slist->next;
1853 return_val = (*data->func) (grab_widget, (GdkEventKey*) event, data->func_data);
1860 gtk_quit_add_full (guint main_level,
1861 GtkFunction function,
1862 GtkCallbackMarshal marshal,
1864 GtkDestroyNotify destroy)
1866 static guint quit_id = 1;
1867 GtkQuitFunction *quitf;
1869 g_return_val_if_fail ((function != NULL) || (marshal != NULL), 0);
1871 quitf = g_slice_new (GtkQuitFunction);
1873 quitf->id = quit_id++;
1874 quitf->main_level = main_level;
1875 quitf->function = function;
1876 quitf->marshal = marshal;
1878 quitf->destroy = destroy;
1880 quit_functions = g_list_prepend (quit_functions, quitf);
1886 gtk_quit_destroy (GtkQuitFunction *quitf)
1889 quitf->destroy (quitf->data);
1890 g_slice_free (GtkQuitFunction, quitf);
1894 gtk_quit_destructor (GtkObject **object_p)
1897 gtk_object_destroy (*object_p);
1904 gtk_quit_add_destroy (guint main_level,
1907 GtkObject **object_p;
1909 g_return_if_fail (main_level > 0);
1910 g_return_if_fail (GTK_IS_OBJECT (object));
1912 object_p = g_new (GtkObject*, 1);
1914 g_signal_connect (object,
1916 G_CALLBACK (gtk_widget_destroyed),
1918 gtk_quit_add (main_level, (GtkFunction) gtk_quit_destructor, object_p);
1922 gtk_quit_add (guint main_level,
1923 GtkFunction function,
1926 return gtk_quit_add_full (main_level, function, NULL, data, NULL);
1930 gtk_quit_remove (guint id)
1932 GtkQuitFunction *quitf;
1935 tmp_list = quit_functions;
1938 quitf = tmp_list->data;
1940 if (quitf->id == id)
1942 quit_functions = g_list_remove_link (quit_functions, tmp_list);
1943 g_list_free (tmp_list);
1944 gtk_quit_destroy (quitf);
1949 tmp_list = tmp_list->next;
1954 gtk_quit_remove_by_data (gpointer data)
1956 GtkQuitFunction *quitf;
1959 tmp_list = quit_functions;
1962 quitf = tmp_list->data;
1964 if (quitf->data == data)
1966 quit_functions = g_list_remove_link (quit_functions, tmp_list);
1967 g_list_free (tmp_list);
1968 gtk_quit_destroy (quitf);
1973 tmp_list = tmp_list->next;
1978 gtk_timeout_add_full (guint32 interval,
1979 GtkFunction function,
1980 GtkCallbackMarshal marshal,
1982 GtkDestroyNotify destroy)
1986 GtkClosure *closure;
1988 closure = g_new (GtkClosure, 1);
1989 closure->marshal = marshal;
1990 closure->data = data;
1991 closure->destroy = destroy;
1993 return g_timeout_add_full (0, interval,
1994 gtk_invoke_idle_timeout,
1996 gtk_destroy_closure);
1999 return g_timeout_add_full (0, interval, function, data, destroy);
2003 gtk_timeout_add (guint32 interval,
2004 GtkFunction function,
2007 return g_timeout_add_full (0, interval, function, data, NULL);
2011 gtk_timeout_remove (guint tag)
2013 g_source_remove (tag);
2017 gtk_idle_add_full (gint priority,
2018 GtkFunction function,
2019 GtkCallbackMarshal marshal,
2021 GtkDestroyNotify destroy)
2025 GtkClosure *closure;
2027 closure = g_new (GtkClosure, 1);
2028 closure->marshal = marshal;
2029 closure->data = data;
2030 closure->destroy = destroy;
2032 return g_idle_add_full (priority,
2033 gtk_invoke_idle_timeout,
2035 gtk_destroy_closure);
2038 return g_idle_add_full (priority, function, data, destroy);
2042 gtk_idle_add (GtkFunction function,
2045 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
2049 gtk_idle_add_priority (gint priority,
2050 GtkFunction function,
2053 return g_idle_add_full (priority, function, data, NULL);
2057 gtk_idle_remove (guint tag)
2059 g_source_remove (tag);
2063 gtk_idle_remove_by_data (gpointer data)
2065 if (!g_idle_remove_by_data (data))
2066 g_warning ("gtk_idle_remove_by_data(%p): no such idle", data);
2070 gtk_input_add_full (gint source,
2071 GdkInputCondition condition,
2072 GdkInputFunction function,
2073 GtkCallbackMarshal marshal,
2075 GtkDestroyNotify destroy)
2079 GtkClosure *closure;
2081 closure = g_new (GtkClosure, 1);
2082 closure->marshal = marshal;
2083 closure->data = data;
2084 closure->destroy = destroy;
2086 return gdk_input_add_full (source,
2088 (GdkInputFunction) gtk_invoke_input,
2090 (GdkDestroyNotify) gtk_destroy_closure);
2093 return gdk_input_add_full (source, condition, function, data, destroy);
2097 gtk_input_remove (guint tag)
2099 g_source_remove (tag);
2103 gtk_destroy_closure (gpointer data)
2105 GtkClosure *closure = data;
2107 if (closure->destroy)
2108 (closure->destroy) (closure->data);
2113 gtk_invoke_idle_timeout (gpointer data)
2115 GtkClosure *closure = data;
2118 gint ret_val = FALSE;
2119 args[0].name = NULL;
2120 args[0].type = G_TYPE_BOOLEAN;
2121 args[0].d.pointer_data = &ret_val;
2122 closure->marshal (NULL, closure->data, 0, args);
2127 gtk_invoke_input (gpointer data,
2129 GdkInputCondition condition)
2131 GtkClosure *closure = data;
2134 args[0].type = G_TYPE_INT;
2135 args[0].name = NULL;
2136 GTK_VALUE_INT (args[0]) = source;
2137 args[1].type = GDK_TYPE_INPUT_CONDITION;
2138 args[1].name = NULL;
2139 GTK_VALUE_FLAGS (args[1]) = condition;
2140 args[2].type = G_TYPE_NONE;
2141 args[2].name = NULL;
2143 closure->marshal (NULL, closure->data, 2, args);
2147 * gtk_get_current_event:
2149 * Obtains a copy of the event currently being processed by GTK+. For
2150 * example, if you get a "clicked" signal from #GtkButton, the current
2151 * event will be the #GdkEventButton that triggered the "clicked"
2152 * signal. The returned event must be freed with gdk_event_free().
2153 * If there is no current event, the function returns %NULL.
2155 * Return value: a copy of the current event, or %NULL if no current event.
2158 gtk_get_current_event (void)
2161 return gdk_event_copy (current_events->data);
2167 * gtk_get_current_event_time:
2169 * If there is a current event and it has a timestamp, return that
2170 * timestamp, otherwise return %GDK_CURRENT_TIME.
2172 * Return value: the timestamp from the current event, or %GDK_CURRENT_TIME.
2175 gtk_get_current_event_time (void)
2178 return gdk_event_get_time (current_events->data);
2180 return GDK_CURRENT_TIME;
2184 * gtk_get_current_event_state:
2185 * @state: a location to store the state of the current event
2187 * If there is a current event and it has a state field, place
2188 * that state field in @state and return %TRUE, otherwise return
2191 * Return value: %TRUE if there was a current event and it had a state field
2194 gtk_get_current_event_state (GdkModifierType *state)
2196 g_return_val_if_fail (state != NULL, FALSE);
2199 return gdk_event_get_state (current_events->data, state);
2208 * gtk_get_event_widget:
2209 * @event: a #GdkEvent
2211 * If @event is %NULL or the event was not associated with any widget,
2212 * returns %NULL, otherwise returns the widget that received the event
2215 * Return value: the widget that originally received @event, or %NULL
2218 gtk_get_event_widget (GdkEvent *event)
2223 if (event && event->any.window &&
2224 (event->type == GDK_DESTROY || !GDK_WINDOW_DESTROYED (event->any.window)))
2225 gdk_window_get_user_data (event->any.window, (void**) &widget);
2231 gtk_quit_invoke_function (GtkQuitFunction *quitf)
2233 if (!quitf->marshal)
2234 return quitf->function (quitf->data);
2238 gint ret_val = FALSE;
2240 args[0].name = NULL;
2241 args[0].type = G_TYPE_BOOLEAN;
2242 args[0].d.pointer_data = &ret_val;
2243 ((GtkCallbackMarshal) quitf->marshal) (NULL,
2251 * gtk_propagate_event:
2252 * @widget: a #GtkWidget
2255 * Sends an event to a widget, propagating the event to parent widgets
2256 * if the event remains unhandled. Events received by GTK+ from GDK
2257 * normally begin in gtk_main_do_event(). Depending on the type of
2258 * event, existence of modal dialogs, grabs, etc., the event may be
2259 * propagated; if so, this function is used. gtk_propagate_event()
2260 * calls gtk_widget_event() on each widget it decides to send the
2261 * event to. So gtk_widget_event() is the lowest-level function; it
2262 * simply emits the "event" and possibly an event-specific signal on a
2263 * widget. gtk_propagate_event() is a bit higher-level, and
2264 * gtk_main_do_event() is the highest level.
2266 * All that said, you most likely don't want to use any of these
2267 * functions; synthesizing events is rarely needed. Consider asking on
2268 * the mailing list for better ways to achieve your goals. For
2269 * example, use gdk_window_invalidate_rect() or
2270 * gtk_widget_queue_draw() instead of making up expose events.
2274 gtk_propagate_event (GtkWidget *widget,
2279 g_return_if_fail (GTK_IS_WIDGET (widget));
2280 g_return_if_fail (event != NULL);
2282 handled_event = FALSE;
2284 g_object_ref (widget);
2286 if ((event->type == GDK_KEY_PRESS) ||
2287 (event->type == GDK_KEY_RELEASE))
2289 /* Only send key events within Window widgets to the Window
2290 * The Window widget will in turn pass the
2291 * key event on to the currently focused widget
2296 window = gtk_widget_get_toplevel (widget);
2297 if (window && GTK_IS_WINDOW (window))
2299 /* If there is a grab within the window, give the grab widget
2300 * a first crack at the key event
2302 if (widget != window && GTK_WIDGET_HAS_GRAB (widget))
2303 handled_event = gtk_widget_event (widget, event);
2307 window = gtk_widget_get_toplevel (widget);
2308 if (window && GTK_IS_WINDOW (window))
2310 if (GTK_WIDGET_IS_SENSITIVE (window))
2311 gtk_widget_event (window, event);
2315 handled_event = TRUE; /* don't send to widget */
2319 /* Other events get propagated up the widget tree
2320 * so that parents can see the button and motion
2321 * events of the children.
2329 /* Scroll events are special cased here because it
2330 * feels wrong when scrolling a GtkViewport, say,
2331 * to have children of the viewport eat the scroll
2334 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2335 handled_event = event->type != GDK_SCROLL;
2337 handled_event = gtk_widget_event (widget, event);
2339 tmp = widget->parent;
2340 g_object_unref (widget);
2344 if (!handled_event && widget)
2345 g_object_ref (widget);
2351 g_object_unref (widget);
2356 gtk_error (gchar *str)
2362 gtk_warning (gchar *str)
2368 gtk_message (gchar *str)
2374 gtk_print (gchar *str)
2376 static GtkWidget *window = NULL;
2377 static GtkWidget *text;
2378 static int level = 0;
2382 GtkWidget *hscrollbar;
2383 GtkWidget *vscrollbar;
2384 GtkWidget *separator;
2389 fputs (str, stdout);
2396 window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
2398 gtk_signal_connect (GTK_OBJECT (window), "destroy",
2399 (GtkSignalFunc) gtk_widget_destroyed,
2402 gtk_window_set_title (GTK_WINDOW (window), "Messages");
2404 box1 = gtk_vbox_new (FALSE, 0);
2405 gtk_container_add (GTK_CONTAINER (window), box1);
2406 gtk_widget_show (box1);
2409 box2 = gtk_vbox_new (FALSE, 10);
2410 gtk_container_set_border_width (GTK_CONTAINER (box2), 10);
2411 gtk_box_pack_start (GTK_BOX (box1), box2, TRUE, TRUE, 0);
2412 gtk_widget_show (box2);
2415 table = gtk_table_new (2, 2, FALSE);
2416 gtk_table_set_row_spacing (GTK_TABLE (table), 0, 2);
2417 gtk_table_set_col_spacing (GTK_TABLE (table), 0, 2);
2418 gtk_box_pack_start (GTK_BOX (box2), table, TRUE, TRUE, 0);
2419 gtk_widget_show (table);
2421 text = gtk_text_new (NULL, NULL);
2422 gtk_text_set_editable (GTK_TEXT (text), FALSE);
2423 gtk_table_attach_defaults (GTK_TABLE (table), text, 0, 1, 0, 1);
2424 gtk_widget_show (text);
2425 gtk_widget_realize (text);
2427 hscrollbar = gtk_hscrollbar_new (GTK_TEXT (text)->hadj);
2428 gtk_table_attach (GTK_TABLE (table), hscrollbar, 0, 1, 1, 2,
2429 GTK_EXPAND | GTK_FILL, GTK_FILL, 0, 0);
2430 gtk_widget_show (hscrollbar);
2432 vscrollbar = gtk_vscrollbar_new (GTK_TEXT (text)->vadj);
2433 gtk_table_attach (GTK_TABLE (table), vscrollbar, 1, 2, 0, 1,
2434 GTK_FILL, GTK_EXPAND | GTK_FILL, 0, 0);
2435 gtk_widget_show (vscrollbar);
2437 separator = gtk_hseparator_new ();
2438 gtk_box_pack_start (GTK_BOX (box1), separator, FALSE, TRUE, 0);
2439 gtk_widget_show (separator);
2442 box2 = gtk_vbox_new (FALSE, 10);
2443 gtk_container_set_border_width (GTK_CONTAINER (box2), 10);
2444 gtk_box_pack_start (GTK_BOX (box1), box2, FALSE, TRUE, 0);
2445 gtk_widget_show (box2);
2448 button = gtk_button_new_with_label ("close");
2449 gtk_signal_connect_object (GTK_OBJECT (button), "clicked",
2450 (GtkSignalFunc) gtk_widget_hide,
2451 GTK_OBJECT (window));
2452 gtk_box_pack_start (GTK_BOX (box2), button, TRUE, TRUE, 0);
2453 GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
2454 gtk_widget_grab_default (button);
2455 gtk_widget_show (button);
2459 gtk_text_insert (GTK_TEXT (text), NULL, NULL, NULL, str, -1);
2462 if (!GTK_WIDGET_VISIBLE (window))
2463 gtk_widget_show (window);
2468 _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
2469 GValue *return_accu,
2470 const GValue *handler_return,
2473 gboolean continue_emission;
2474 gboolean signal_handled;
2476 signal_handled = g_value_get_boolean (handler_return);
2477 g_value_set_boolean (return_accu, signal_handled);
2478 continue_emission = !signal_handled;
2480 return continue_emission;
2483 #define __GTK_MAIN_C__
2484 #include "gtkaliasdef.c"