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/.
29 * @Short_description: Library initialization, main event loop, and events
30 * @Title: Main loop and Events
31 * @See_also:See the GLib manual, especially #GMainLoop and signal-related
32 * functions such as g_signal_connect()
34 * Before using GTK+, you need to initialize it; initialization connects to the
35 * window system display, and parses some standard command line arguments. The
36 * gtk_init() macro initializes GTK+. gtk_init() exits the application if errors
37 * occur; to avoid this, use gtk_init_check(). gtk_init_check() allows you to
38 * recover from a failed GTK+ initialization - you might start up your
39 * application in text mode instead.
41 * Like all GUI toolkits, GTK+ uses an event-driven programming model. When the
42 * user is doing nothing, GTK+ sits in the <firstterm>main loop</firstterm> and
43 * waits for input. If the user performs some action - say, a mouse click - then
44 * the main loop "wakes up" and delivers an event to GTK+. GTK+ forwards the
45 * event to one or more widgets.
47 * When widgets receive an event, they frequently emit one or more
48 * <firstterm>signals</firstterm>. Signals notify your program that "something
49 * interesting happened" by invoking functions you've connected to the signal
50 * with g_signal_connect(). Functions connected to a signal are often termed
51 * <firstterm>callbacks</firstterm>.
53 * When your callbacks are invoked, you would typically take some action - for
54 * example, when an Open button is clicked you might display a
55 * #GtkFileChooserDialog. After a callback finishes, GTK+ will return to the
56 * main loop and await more user input.
59 * <title>Typical <function>main()</function> function for a GTK+ application</title>
62 * main (int argc, char **argv)
64 * /* Initialize i18n support */
67 * /* Initialize the widget set */
68 * gtk_init (&argc, &argv);
70 * /* Create the main window */
71 * mainwin = gtk_window_new (GTK_WINDOW_TOPLEVEL);
73 * /* Set up our GUI elements */
76 * /* Show the application window */
77 * gtk_widget_show_all (mainwin);
79 * /* Enter the main event loop, and wait for user interaction */
82 * /* The user lost interest */
88 * It's OK to use the GLib main loop directly instead of gtk_main(), though it
89 * involves slightly more typing. See #GMainLoop in the GLib documentation.
94 #include "gtkmainprivate.h"
107 #include <sys/types.h> /* For uid_t, gid_t */
117 #include "gtkaccelmap.h"
119 #include "gtkclipboard.h"
121 #include "gtkversion.h"
122 #include "gtkmodules.h"
124 #include "gtkrecentmanager.h"
125 #include "gtkselectionprivate.h"
126 #include "gtksettingsprivate.h"
127 #include "gtkwidgetprivate.h"
128 #include "gtkwindowprivate.h"
129 #include "gtktooltip.h"
130 #include "gtkdebug.h"
135 static HMODULE gtk_dll;
138 DllMain (HINSTANCE hinstDLL,
144 case DLL_PROCESS_ATTACH:
145 gtk_dll = (HMODULE) hinstDLL;
152 /* These here before inclusion of gtkprivate.h so that the original
153 * GTK_LIBDIR and GTK_LOCALEDIR definitions are seen. Yeah, this is a
157 _gtk_get_libdir (void)
159 static char *gtk_libdir = NULL;
160 if (gtk_libdir == NULL)
162 gchar *root = g_win32_get_package_installation_directory_of_module (gtk_dll);
163 gchar *slash = strrchr (root, '\\');
164 if (g_ascii_strcasecmp (slash + 1, ".libs") == 0)
165 gtk_libdir = GTK_LIBDIR;
167 gtk_libdir = g_build_filename (root, "lib", NULL);
175 _gtk_get_localedir (void)
177 static char *gtk_localedir = NULL;
178 if (gtk_localedir == NULL)
183 /* GTK_LOCALEDIR ends in either /lib/locale or
184 * /share/locale. Scan for that slash.
186 p = GTK_LOCALEDIR + strlen (GTK_LOCALEDIR);
192 root = g_win32_get_package_installation_directory_of_module (gtk_dll);
193 temp = g_build_filename (root, p, NULL);
196 /* gtk_localedir is passed to bindtextdomain() which isn't
199 gtk_localedir = g_win32_locale_filename_from_utf8 (temp);
202 return gtk_localedir;
207 #include "gtkprivate.h"
209 /* Private type definitions
211 typedef struct _GtkKeySnooperData GtkKeySnooperData;
213 struct _GtkKeySnooperData
215 GtkKeySnoopFunc func;
220 static gint gtk_invoke_key_snoopers (GtkWidget *grab_widget,
223 static GtkWindowGroup *gtk_main_get_window_group (GtkWidget *widget);
225 static guint gtk_main_loop_level = 0;
226 static gint pre_initialized = FALSE;
227 static gint gtk_initialized = FALSE;
228 static GList *current_events = NULL;
230 static GSList *main_loops = NULL; /* stack of currently executing main loops */
232 static GSList *key_snoopers = NULL;
234 static guint debug_flags = 0; /* Global GTK debug flag */
236 #ifdef G_ENABLE_DEBUG
237 static const GDebugKey gtk_debug_keys[] = {
238 {"misc", GTK_DEBUG_MISC},
239 {"plugsocket", GTK_DEBUG_PLUGSOCKET},
240 {"text", GTK_DEBUG_TEXT},
241 {"tree", GTK_DEBUG_TREE},
242 {"updates", GTK_DEBUG_UPDATES},
243 {"keybindings", GTK_DEBUG_KEYBINDINGS},
244 {"multihead", GTK_DEBUG_MULTIHEAD},
245 {"modules", GTK_DEBUG_MODULES},
246 {"geometry", GTK_DEBUG_GEOMETRY},
247 {"icontheme", GTK_DEBUG_ICONTHEME},
248 {"printing", GTK_DEBUG_PRINTING},
249 {"builder", GTK_DEBUG_BUILDER},
250 {"size-request", GTK_DEBUG_SIZE_REQUEST},
252 #endif /* G_ENABLE_DEBUG */
255 * gtk_get_major_version:
257 * Returns the major version number of the GTK+ library.
258 * (e.g. in GTK+ version 3.1.5 this is 3.)
260 * This function is in the library, so it represents the GTK+ library
261 * your code is running against. Contrast with the #GTK_MAJOR_VERSION
262 * macro, which represents the major version of the GTK+ headers you
263 * have included when compiling your code.
265 * Returns: the major version number of the GTK+ library
270 gtk_get_major_version (void)
272 return GTK_MAJOR_VERSION;
276 * gtk_get_minor_version:
278 * Returns the minor version number of the GTK+ library.
279 * (e.g. in GTK+ version 3.1.5 this is 1.)
281 * This function is in the library, so it represents the GTK+ library
282 * your code is are running against. Contrast with the
283 * #GTK_MINOR_VERSION macro, which represents the minor version of the
284 * GTK+ headers you have included when compiling your code.
286 * Returns: the minor version number of the GTK+ library
291 gtk_get_minor_version (void)
293 return GTK_MINOR_VERSION;
297 * gtk_get_micro_version:
299 * Returns the micro version number of the GTK+ library.
300 * (e.g. in GTK+ version 3.1.5 this is 5.)
302 * This function is in the library, so it represents the GTK+ library
303 * your code is are running against. Contrast with the
304 * #GTK_MICRO_VERSION macro, which represents the micro version of the
305 * GTK+ headers you have included when compiling your code.
307 * Returns: the micro version number of the GTK+ library
312 gtk_get_micro_version (void)
314 return GTK_MICRO_VERSION;
318 * gtk_get_binary_age:
320 * Returns the binary age as passed to <application>libtool</application>
321 * when building the GTK+ library the process is running against.
322 * If <application>libtool</application> means nothing to you, don't
325 * Returns: the binary age of the GTK+ library
330 gtk_get_binary_age (void)
332 return GTK_BINARY_AGE;
336 * gtk_get_interface_age:
338 * Returns the interface age as passed to <application>libtool</application>
339 * when building the GTK+ library the process is running against.
340 * If <application>libtool</application> means nothing to you, don't
343 * Returns: the interface age of the GTK+ library
348 gtk_get_interface_age (void)
350 return GTK_INTERFACE_AGE;
355 * @required_major: the required major version
356 * @required_minor: the required minor version
357 * @required_micro: the required micro version
359 * Checks that the GTK+ library in use is compatible with the
360 * given version. Generally you would pass in the constants
361 * #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION
362 * as the three arguments to this function; that produces
363 * a check that the library in use is compatible with
364 * the version of GTK+ the application or module was compiled
367 * Compatibility is defined by two things: first the version
368 * of the running library is newer than the version
369 * @required_major.required_minor.@required_micro. Second
370 * the running library must be binary compatible with the
371 * version @required_major.required_minor.@required_micro
372 * (same major version.)
374 * This function is primarily for GTK+ modules; the module
375 * can call this function to check that it wasn't loaded
376 * into an incompatible version of GTK+. However, such a
377 * check isn't completely reliable, since the module may be
378 * linked against an old version of GTK+ and calling the
379 * old version of gtk_check_version(), but still get loaded
380 * into an application using a newer version of GTK+.
382 * Return value: %NULL if the GTK+ library is compatible with the
383 * given version, or a string describing the version mismatch.
384 * The returned string is owned by GTK+ and should not be modified
388 gtk_check_version (guint required_major,
389 guint required_minor,
390 guint required_micro)
392 gint gtk_effective_micro = 100 * GTK_MINOR_VERSION + GTK_MICRO_VERSION;
393 gint required_effective_micro = 100 * required_minor + required_micro;
395 if (required_major > GTK_MAJOR_VERSION)
396 return "GTK+ version too old (major mismatch)";
397 if (required_major < GTK_MAJOR_VERSION)
398 return "GTK+ version too new (major mismatch)";
399 if (required_effective_micro < gtk_effective_micro - GTK_BINARY_AGE)
400 return "GTK+ version too new (micro mismatch)";
401 if (required_effective_micro > gtk_effective_micro)
402 return "GTK+ version too old (micro mismatch)";
406 /* This checks to see if the process is running suid or sgid
407 * at the current time. If so, we don't allow GTK+ to be initialized.
408 * This is meant to be a mild check - we only error out if we
409 * can prove the programmer is doing something wrong, not if
410 * they could be doing something wrong. For this reason, we
411 * don't use issetugid() on BSD or prctl (PR_GET_DUMPABLE).
416 /* this isn't at all relevant on MS Windows and doesn't compile ... --hb */
418 uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
419 gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
421 #ifdef HAVE_GETRESUID
422 /* These aren't in the header files, so we prototype them here.
424 int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
425 int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
427 if (getresuid (&ruid, &euid, &suid) != 0 ||
428 getresgid (&rgid, &egid, &sgid) != 0)
429 #endif /* HAVE_GETRESUID */
431 suid = ruid = getuid ();
432 sgid = rgid = getgid ();
437 if (ruid != euid || ruid != suid ||
438 rgid != egid || rgid != sgid)
440 g_warning ("This process is currently running setuid or setgid.\n"
441 "This is not a supported use of GTK+. You must create a helper\n"
442 "program instead. For further details, see:\n\n"
443 " http://www.gtk.org/setuid.html\n\n"
444 "Refusing to initialize GTK+.");
454 _gtk_get_datadir (void)
456 static char *gtk_datadir = NULL;
457 if (gtk_datadir == NULL)
459 gchar *root = g_win32_get_package_installation_directory_of_module (gtk_dll);
460 gtk_datadir = g_build_filename (root, "share", NULL);
468 _gtk_get_sysconfdir (void)
470 static char *gtk_sysconfdir = NULL;
471 if (gtk_sysconfdir == NULL)
473 gchar *root = g_win32_get_package_installation_directory_of_module (gtk_dll);
474 gtk_sysconfdir = g_build_filename (root, "etc", NULL);
478 return gtk_sysconfdir;
482 _gtk_get_data_prefix (void)
484 static char *gtk_data_prefix = NULL;
485 if (gtk_data_prefix == NULL)
486 gtk_data_prefix = g_win32_get_package_installation_directory_of_module (gtk_dll);
488 return gtk_data_prefix;
491 #endif /* G_OS_WIN32 */
493 static gboolean do_setlocale = TRUE;
496 * gtk_disable_setlocale:
498 * Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and
499 * gtk_parse_args() from automatically
500 * calling <literal>setlocale (LC_ALL, "")</literal>. You would
501 * want to use this function if you wanted to set the locale for
502 * your program to something other than the user's locale, or if
503 * you wanted to set different values for different locale categories.
505 * Most programs should not need to call this function.
508 gtk_disable_setlocale (void)
511 g_warning ("gtk_disable_setlocale() must be called before gtk_init()");
513 do_setlocale = FALSE;
516 #ifdef G_PLATFORM_WIN32
517 #undef gtk_init_check
520 static GString *gtk_modules_string = NULL;
521 static gboolean g_fatal_warnings = FALSE;
523 #ifdef G_ENABLE_DEBUG
525 gtk_arg_debug_cb (const char *key, const char *value, gpointer user_data)
527 debug_flags |= g_parse_debug_string (value,
529 G_N_ELEMENTS (gtk_debug_keys));
535 gtk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data)
537 debug_flags &= ~g_parse_debug_string (value,
539 G_N_ELEMENTS (gtk_debug_keys));
543 #endif /* G_ENABLE_DEBUG */
546 gtk_arg_module_cb (const char *key, const char *value, gpointer user_data)
550 if (gtk_modules_string)
551 g_string_append_c (gtk_modules_string, G_SEARCHPATH_SEPARATOR);
553 gtk_modules_string = g_string_new (NULL);
555 g_string_append (gtk_modules_string, value);
561 static const GOptionEntry gtk_args[] = {
562 { "gtk-module", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_module_cb,
563 /* Description of --gtk-module=MODULES in --help output */ N_("Load additional GTK+ modules"),
564 /* Placeholder in --gtk-module=MODULES in --help output */ N_("MODULES") },
565 { "g-fatal-warnings", 0, 0, G_OPTION_ARG_NONE, &g_fatal_warnings,
566 /* Description of --g-fatal-warnings in --help output */ N_("Make all warnings fatal"), NULL },
567 #ifdef G_ENABLE_DEBUG
568 { "gtk-debug", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_debug_cb,
569 /* Description of --gtk-debug=FLAGS in --help output */ N_("GTK+ debugging flags to set"),
570 /* Placeholder in --gtk-debug=FLAGS in --help output */ N_("FLAGS") },
571 { "gtk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_no_debug_cb,
572 /* Description of --gtk-no-debug=FLAGS in --help output */ N_("GTK+ debugging flags to unset"),
573 /* Placeholder in --gtk-no-debug=FLAGS in --help output */ N_("FLAGS") },
580 static char *iso639_to_check = NULL;
581 static char *iso3166_to_check = NULL;
582 static char *script_to_check = NULL;
583 static gboolean setlocale_called = FALSE;
586 enum_locale_proc (LPTSTR locale)
594 lcid = strtoul (locale, &endptr, 16);
595 if (*endptr == '\0' &&
596 GetLocaleInfo (lcid, LOCALE_SISO639LANGNAME, iso639, sizeof (iso639)) &&
597 GetLocaleInfo (lcid, LOCALE_SISO3166CTRYNAME, iso3166, sizeof (iso3166)))
599 if (strcmp (iso639, iso639_to_check) == 0 &&
600 ((iso3166_to_check != NULL &&
601 strcmp (iso3166, iso3166_to_check) == 0) ||
602 (iso3166_to_check == NULL &&
603 SUBLANGID (LANGIDFROMLCID (lcid)) == SUBLANG_DEFAULT)))
605 char language[100], country[100];
608 if (script_to_check != NULL)
610 /* If lcid is the "other" script for this language,
611 * return TRUE, i.e. continue looking.
613 if (strcmp (script_to_check, "Latn") == 0)
615 switch (LANGIDFROMLCID (lcid))
617 case MAKELANGID (LANG_AZERI, SUBLANG_AZERI_CYRILLIC):
619 case MAKELANGID (LANG_UZBEK, SUBLANG_UZBEK_CYRILLIC):
621 case MAKELANGID (LANG_SERBIAN, SUBLANG_SERBIAN_CYRILLIC):
623 case MAKELANGID (LANG_SERBIAN, 0x07):
624 /* Serbian in Bosnia and Herzegovina, Cyrillic */
628 else if (strcmp (script_to_check, "Cyrl") == 0)
630 switch (LANGIDFROMLCID (lcid))
632 case MAKELANGID (LANG_AZERI, SUBLANG_AZERI_LATIN):
634 case MAKELANGID (LANG_UZBEK, SUBLANG_UZBEK_LATIN):
636 case MAKELANGID (LANG_SERBIAN, SUBLANG_SERBIAN_LATIN):
638 case MAKELANGID (LANG_SERBIAN, 0x06):
639 /* Serbian in Bosnia and Herzegovina, Latin */
645 SetThreadLocale (lcid);
647 if (GetLocaleInfo (lcid, LOCALE_SENGLANGUAGE, language, sizeof (language)) &&
648 GetLocaleInfo (lcid, LOCALE_SENGCOUNTRY, country, sizeof (country)))
650 strcpy (locale, language);
651 strcat (locale, "_");
652 strcat (locale, country);
654 if (setlocale (LC_ALL, locale) != NULL)
655 setlocale_called = TRUE;
668 setlocale_initialization (void)
670 static gboolean initialized = FALSE;
679 /* If some of the POSIXish environment variables are set, set
680 * the Win32 thread locale correspondingly.
682 char *p = getenv ("LC_ALL");
689 if (strcmp (p, "C") == 0)
690 SetThreadLocale (LOCALE_SYSTEM_DEFAULT);
693 /* Check if one of the supported locales match the
694 * environment variable. If so, use that locale.
697 iso3166_to_check = strchr (iso639_to_check, '_');
698 if (iso3166_to_check != NULL)
700 *iso3166_to_check++ = '\0';
702 script_to_check = strchr (iso3166_to_check, '@');
703 if (script_to_check != NULL)
704 *script_to_check++ = '\0';
706 /* Handle special cases. */
708 /* The standard code for Serbia and Montenegro was
709 * "CS", but MSFT uses for some reason "SP". By now
710 * (October 2006), SP has split into two, "RS" and
711 * "ME", but don't bother trying to handle those
712 * yet. Do handle the even older "YU", though.
714 if (strcmp (iso3166_to_check, "CS") == 0 ||
715 strcmp (iso3166_to_check, "YU") == 0)
716 iso3166_to_check = "SP";
720 script_to_check = strchr (iso639_to_check, '@');
721 if (script_to_check != NULL)
722 *script_to_check++ = '\0';
723 /* LANG_SERBIAN == LANG_CROATIAN, recognize just "sr" */
724 if (strcmp (iso639_to_check, "sr") == 0)
725 iso3166_to_check = "SP";
728 EnumSystemLocales (enum_locale_proc, LCID_SUPPORTED);
732 if (!setlocale_called)
733 setlocale (LC_ALL, "");
735 if (!setlocale (LC_ALL, ""))
736 g_warning ("Locale not supported by C library.\n\tUsing the fallback 'C' locale.");
742 check_mixed_deps (void)
747 module = g_module_open (NULL, 0);
749 if (g_module_symbol (module, "gtk_progress_get_type", &func))
751 g_error ("GTK+ 2.x symbols detected. Using GTK+ 2.x and GTK+ 3 in the same process is not supported");
754 g_module_close (module);
758 do_pre_parse_initialization (int *argc,
761 const gchar *env_string;
766 pre_initialized = TRUE;
770 gdk_pre_parse_libgtk_only ();
771 gdk_event_handler_set ((GdkEventFunc)gtk_main_do_event, NULL, NULL);
773 #ifdef G_ENABLE_DEBUG
774 env_string = g_getenv ("GTK_DEBUG");
775 if (env_string != NULL)
777 debug_flags = g_parse_debug_string (env_string,
779 G_N_ELEMENTS (gtk_debug_keys));
782 #endif /* G_ENABLE_DEBUG */
784 env_string = g_getenv ("GTK_MODULES");
786 gtk_modules_string = g_string_new (env_string);
790 gettext_initialization (void)
792 setlocale_initialization ();
795 bindtextdomain (GETTEXT_PACKAGE, GTK_LOCALEDIR);
796 bindtextdomain (GETTEXT_PACKAGE "-properties", GTK_LOCALEDIR);
797 # ifdef HAVE_BIND_TEXTDOMAIN_CODESET
798 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
799 bind_textdomain_codeset (GETTEXT_PACKAGE "-properties", "UTF-8");
805 do_post_parse_initialization (int *argc,
811 gettext_initialization ();
814 signal (SIGPIPE, SIG_IGN);
817 if (g_fatal_warnings)
819 GLogLevelFlags fatal_mask;
821 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
822 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
823 g_log_set_always_fatal (fatal_mask);
826 if (debug_flags & GTK_DEBUG_UPDATES)
827 gdk_window_set_debug_updates (TRUE);
830 /* Translate to default:RTL if you want your widgets
831 * to be RTL, otherwise translate to default:LTR.
832 * Do *not* translate it to "predefinito:LTR", if it
833 * it isn't default:LTR or default:RTL it will not work
835 char *e = _("default:LTR");
836 if (strcmp (e, "default:RTL")==0)
837 gtk_widget_set_default_direction (GTK_TEXT_DIR_RTL);
838 else if (strcmp (e, "default:LTR"))
839 g_warning ("Whoever translated default:LTR did so wrongly.\n");
842 /* do what the call to gtk_type_init() used to do */
845 _gtk_accel_map_init ();
847 /* Set the 'initialized' flag.
849 gtk_initialized = TRUE;
851 /* load gtk modules */
852 if (gtk_modules_string)
854 _gtk_modules_init (argc, argv, gtk_modules_string->str);
855 g_string_free (gtk_modules_string, TRUE);
859 _gtk_modules_init (argc, argv, NULL);
866 gboolean open_default_display;
870 pre_parse_hook (GOptionContext *context,
875 do_pre_parse_initialization (NULL, NULL);
881 post_parse_hook (GOptionContext *context,
886 OptionGroupInfo *info = data;
889 do_post_parse_initialization (NULL, NULL);
891 if (info->open_default_display)
893 if (gdk_display_open_default_libgtk_only () == NULL)
895 const char *display_name = gdk_get_display_arg_name ();
898 G_OPTION_ERROR_FAILED,
899 _("Cannot open display: %s"),
900 display_name ? display_name : "" );
911 * gtk_get_debug_flags:
913 * Returns the GTK+ debug flags.
915 * This function is intended for GTK+ modules that want
916 * to adjust their debug output based on GTK+ debug flags.
918 * Returns: the GTK+ debug flags.
921 gtk_get_debug_flags (void)
927 * gtk_set_debug_flags:
929 * Sets the GTK+ debug flags.
932 gtk_set_debug_flags (guint flags)
938 * gtk_get_option_group:
939 * @open_default_display: whether to open the default display
940 * when parsing the commandline arguments
942 * Returns a #GOptionGroup for the commandline arguments recognized
945 * You should add this group to your #GOptionContext
946 * with g_option_context_add_group(), if you are using
947 * g_option_context_parse() to parse your commandline arguments.
949 * Returns: a #GOptionGroup for the commandline arguments recognized
955 gtk_get_option_group (gboolean open_default_display)
958 OptionGroupInfo *info;
960 gettext_initialization ();
962 info = g_new0 (OptionGroupInfo, 1);
963 info->open_default_display = open_default_display;
965 group = g_option_group_new ("gtk", _("GTK+ Options"), _("Show GTK+ Options"), info, g_free);
966 g_option_group_set_parse_hooks (group, pre_parse_hook, post_parse_hook);
968 gdk_add_option_entries_libgtk_only (group);
969 g_option_group_add_entries (group, gtk_args);
970 g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
976 * gtk_init_with_args:
977 * @argc: a pointer to the number of command line arguments
978 * @argv: a pointer to the array of command line arguments
979 * @parameter_string: a string which is displayed in
980 * the first line of <option>--help</option> output, after
981 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
982 * @entries: a %NULL-terminated array of #GOptionEntrys
983 * describing the options of your program
984 * @translation_domain: a translation domain to use for translating
985 * the <option>--help</option> output for the options in @entries
986 * and the @parameter_string with gettext(), or %NULL
987 * @error: a return location for errors
989 * This function does the same work as gtk_init_check().
990 * Additionally, it allows you to add your own commandline options,
991 * and it automatically generates nicely formatted
992 * <option>--help</option> output. Note that your program will
993 * be terminated after writing out the help output.
995 * Returns: %TRUE if the windowing system has been successfully
996 * initialized, %FALSE otherwise
1001 gtk_init_with_args (gint *argc,
1003 const gchar *parameter_string,
1004 const GOptionEntry *entries,
1005 const gchar *translation_domain,
1008 GOptionContext *context;
1009 GOptionGroup *gtk_group;
1012 if (gtk_initialized)
1013 return gdk_display_open_default_libgtk_only () != NULL;
1015 gettext_initialization ();
1017 if (!check_setugid ())
1020 gtk_group = gtk_get_option_group (TRUE);
1022 context = g_option_context_new (parameter_string);
1023 g_option_context_add_group (context, gtk_group);
1024 g_option_context_set_translation_domain (context, translation_domain);
1027 g_option_context_add_main_entries (context, entries, translation_domain);
1028 retval = g_option_context_parse (context, argc, argv, error);
1030 g_option_context_free (context);
1038 * @argc: (inout): a pointer to the number of command line arguments
1039 * @argv: (array) (inout): a pointer to the array of command line arguments
1041 * Parses command line arguments, and initializes global
1042 * attributes of GTK+, but does not actually open a connection
1043 * to a display. (See gdk_display_open(), gdk_get_display_arg_name())
1045 * Any arguments used by GTK+ or GDK are removed from the array and
1046 * @argc and @argv are updated accordingly.
1048 * There is no need to call this function explicitely if you are using
1049 * gtk_init(), or gtk_init_check().
1051 * Return value: %TRUE if initialization succeeded, otherwise %FALSE
1054 gtk_parse_args (int *argc,
1057 GOptionContext *option_context;
1058 GOptionGroup *gtk_group;
1059 GError *error = NULL;
1061 if (gtk_initialized)
1064 gettext_initialization ();
1066 if (!check_setugid ())
1069 option_context = g_option_context_new (NULL);
1070 g_option_context_set_ignore_unknown_options (option_context, TRUE);
1071 g_option_context_set_help_enabled (option_context, FALSE);
1072 gtk_group = gtk_get_option_group (FALSE);
1073 g_option_context_set_main_group (option_context, gtk_group);
1074 if (!g_option_context_parse (option_context, argc, argv, &error))
1076 g_warning ("%s", error->message);
1077 g_error_free (error);
1080 g_option_context_free (option_context);
1085 #ifdef G_PLATFORM_WIN32
1086 #undef gtk_init_check
1091 * @argc: (inout): Address of the <parameter>argc</parameter> parameter of
1092 * your main() function. Changed if any arguments were handled
1093 * @argv: (array length=argc) (inout) (allow-none): Address of the
1094 * <parameter>argv</parameter> parameter of main()
1095 * Any parameters understood by gtk_init() are stripped before return
1097 * This function does the same work as gtk_init() with only a single
1098 * change: It does not terminate the program if the windowing system
1099 * can't be initialized. Instead it returns %FALSE on failure.
1101 * This way the application can fall back to some other means of
1102 * communication with the user - for example a curses or command line
1105 * Return value: %TRUE if the windowing system has been successfully
1106 * initialized, %FALSE otherwise
1109 gtk_init_check (int *argc,
1112 if (!gtk_parse_args (argc, argv))
1115 return gdk_display_open_default_libgtk_only () != NULL;
1118 #ifdef G_PLATFORM_WIN32
1124 * @argc: (inout): Address of the <parameter>argc</parameter> parameter of
1125 * your main() function. Changed if any arguments were handled
1126 * @argv: (array length=argc) (inout) (allow-none): Address of the
1127 * <parameter>argv</parameter> parameter of main(). Any options
1128 * understood by GTK+ are stripped before return.
1130 * Call this function before using any other GTK+ functions in your GUI
1131 * applications. It will initialize everything needed to operate the
1132 * toolkit and parses some standard command line options.
1134 * @argc and @argv are adjusted accordingly so your own code will
1135 * never see those standard arguments.
1137 * Note that there are some alternative ways to initialize GTK+:
1138 * if you are calling gtk_parse_args(), gtk_init_check(),
1139 * gtk_init_with_args() or g_option_context_parse() with
1140 * the option group returned by gtk_get_option_group(),
1141 * you <emphasis>don't</emphasis> have to call gtk_init().
1144 * This function will terminate your program if it was unable to
1145 * initialize the windowing system for some reason. If you want
1146 * your program to fall back to a textual interface you want to
1147 * call gtk_init_check() instead.
1151 * Since 2.18, GTK+ calls <literal>signal (SIGPIPE, SIG_IGN)</literal>
1152 * during initialization, to ignore SIGPIPE signals, since these are
1153 * almost never wanted in graphical applications. If you do need to
1154 * handle SIGPIPE for some reason, reset the handler after gtk_init(),
1155 * but notice that other libraries (e.g. libdbus or gvfs) might do
1160 gtk_init (int *argc, char ***argv)
1162 if (!gtk_init_check (argc, argv))
1164 const char *display_name_arg = gdk_get_display_arg_name ();
1165 if (display_name_arg == NULL)
1166 display_name_arg = getenv("DISPLAY");
1167 g_warning ("cannot open display: %s", display_name_arg ? display_name_arg : "");
1174 /* This is relevant when building with gcc for Windows (MinGW),
1175 * where we want to be struct packing compatible with MSVC,
1176 * i.e. use the -mms-bitfields switch.
1177 * For Cygwin there should be no need to be compatible with MSVC,
1178 * so no need to use G_PLATFORM_WIN32.
1182 check_sizeof_GtkWindow (size_t sizeof_GtkWindow)
1184 if (sizeof_GtkWindow != sizeof (GtkWindow))
1185 g_error ("Incompatible build!\n"
1186 "The code using GTK+ thinks GtkWindow is of different\n"
1187 "size than it actually is in this build of GTK+.\n"
1188 "On Windows, this probably means that you have compiled\n"
1189 "your code with gcc without the -mms-bitfields switch,\n"
1190 "or that you are using an unsupported compiler.");
1193 /* In GTK+ 2.0 the GtkWindow struct actually is the same size in
1194 * gcc-compiled code on Win32 whether compiled with -fnative-struct or
1195 * not. Unfortunately this wan't noticed until after GTK+ 2.0.1. So,
1196 * from GTK+ 2.0.2 on, check some other struct, too, where the use of
1197 * -fnative-struct still matters. GtkBox is one such.
1200 check_sizeof_GtkBox (size_t sizeof_GtkBox)
1202 if (sizeof_GtkBox != sizeof (GtkBox))
1203 g_error ("Incompatible build!\n"
1204 "The code using GTK+ thinks GtkBox is of different\n"
1205 "size than it actually is in this build of GTK+.\n"
1206 "On Windows, this probably means that you have compiled\n"
1207 "your code with gcc without the -mms-bitfields switch,\n"
1208 "or that you are using an unsupported compiler.");
1211 /* These two functions might get more checks added later, thus pass
1212 * in the number of extra args.
1215 gtk_init_abi_check (int *argc, char ***argv, int num_checks, size_t sizeof_GtkWindow, size_t sizeof_GtkBox)
1217 check_sizeof_GtkWindow (sizeof_GtkWindow);
1218 if (num_checks >= 2)
1219 check_sizeof_GtkBox (sizeof_GtkBox);
1220 gtk_init (argc, argv);
1224 gtk_init_check_abi_check (int *argc, char ***argv, int num_checks, size_t sizeof_GtkWindow, size_t sizeof_GtkBox)
1226 check_sizeof_GtkWindow (sizeof_GtkWindow);
1227 if (num_checks >= 2)
1228 check_sizeof_GtkBox (sizeof_GtkBox);
1229 return gtk_init_check (argc, argv);
1235 * _gtk_get_lc_ctype:
1237 * Return the Unix-style locale string for the language currently in
1238 * effect. On Unix systems, this is the return value from
1239 * <literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
1240 * affect this through the environment variables LC_ALL, LC_CTYPE or
1241 * LANG (checked in that order). The locale strings typically is in
1242 * the form lang_COUNTRY, where lang is an ISO-639 language code, and
1243 * COUNTRY is an ISO-3166 country code. For instance, sv_FI for
1244 * Swedish as written in Finland or pt_BR for Portuguese as written in
1247 * On Windows, the C library doesn't use any such environment
1248 * variables, and setting them won't affect the behaviour of functions
1249 * like ctime(). The user sets the locale through the Regional Options
1250 * in the Control Panel. The C library (in the setlocale() function)
1251 * does not use country and language codes, but country and language
1252 * names spelled out in English.
1253 * However, this function does check the above environment
1254 * variables, and does return a Unix-style locale string based on
1255 * either said environment variables or the thread's current locale.
1257 * Return value: a dynamically allocated string, free with g_free().
1261 _gtk_get_lc_ctype (void)
1264 /* Somebody might try to set the locale for this process using the
1265 * LANG or LC_ environment variables. The Microsoft C library
1266 * doesn't know anything about them. You set the locale in the
1267 * Control Panel. Setting these env vars won't have any affect on
1268 * locale-dependent C library functions like ctime(). But just for
1269 * kicks, do obey LC_ALL, LC_CTYPE and LANG in GTK. (This also makes
1270 * it easier to test GTK and Pango in various default languages, you
1271 * don't have to clickety-click in the Control Panel, you can simply
1272 * start the program with LC_ALL=something on the command line.)
1276 p = getenv ("LC_ALL");
1278 return g_strdup (p);
1280 p = getenv ("LC_CTYPE");
1282 return g_strdup (p);
1284 p = getenv ("LANG");
1286 return g_strdup (p);
1288 return g_win32_getlocale ();
1290 return g_strdup (setlocale (LC_CTYPE, NULL));
1295 * gtk_get_default_language:
1297 * Returns the #PangoLanguage for the default language currently in
1298 * effect. (Note that this can change over the life of an
1299 * application.) The default language is derived from the current
1300 * locale. It determines, for example, whether GTK+ uses the
1301 * right-to-left or left-to-right text direction.
1303 * This function is equivalent to pango_language_get_default().
1304 * See that function for details.
1306 * Return value: the default language as a #PangoLanguage,
1310 gtk_get_default_language (void)
1312 return pango_language_get_default ();
1318 * Runs the main loop until gtk_main_quit() is called.
1320 * You can nest calls to gtk_main(). In that case gtk_main_quit()
1321 * will make the innermost invocation of the main loop return.
1328 gtk_main_loop_level++;
1330 loop = g_main_loop_new (NULL, TRUE);
1331 main_loops = g_slist_prepend (main_loops, loop);
1333 if (g_main_loop_is_running (main_loops->data))
1335 GDK_THREADS_LEAVE ();
1336 g_main_loop_run (loop);
1337 GDK_THREADS_ENTER ();
1341 main_loops = g_slist_remove (main_loops, loop);
1343 g_main_loop_unref (loop);
1345 gtk_main_loop_level--;
1347 if (gtk_main_loop_level == 0)
1349 /* Try storing all clipboard data we have */
1350 _gtk_clipboard_store_all ();
1352 /* Synchronize the recent manager singleton */
1353 _gtk_recent_manager_sync ();
1360 * Asks for the current nesting level of the main loop.
1362 * Returns: the nesting level of the current invocation
1366 gtk_main_level (void)
1368 return gtk_main_loop_level;
1374 * Makes the innermost invocation of the main loop return
1375 * when it regains control.
1378 gtk_main_quit (void)
1380 g_return_if_fail (main_loops != NULL);
1382 g_main_loop_quit (main_loops->data);
1386 * gtk_events_pending:
1388 * Checks if any events are pending.
1390 * This can be used to update the UI and invoke timeouts etc.
1391 * while doing some time intensive computation.
1394 * <title>Updating the UI during a long computation</title>
1396 * /* computation going on... */
1398 * while (gtk_events_pending ())
1399 * gtk_main_iteration ();
1401 * /* ...computation continued */
1405 * Returns: %TRUE if any events are pending, %FALSE otherwise
1408 gtk_events_pending (void)
1412 GDK_THREADS_LEAVE ();
1413 result = g_main_context_pending (NULL);
1414 GDK_THREADS_ENTER ();
1420 * gtk_main_iteration:
1422 * Runs a single iteration of the mainloop.
1424 * If no events are waiting to be processed GTK+ will block
1425 * until the next event is noticed. If you don't want to block
1426 * look at gtk_main_iteration_do() or check if any events are
1427 * pending with gtk_events_pending() first.
1429 * Returns: %TRUE if gtk_main_quit() has been called for the
1430 * innermost mainloop
1433 gtk_main_iteration (void)
1435 GDK_THREADS_LEAVE ();
1436 g_main_context_iteration (NULL, TRUE);
1437 GDK_THREADS_ENTER ();
1440 return !g_main_loop_is_running (main_loops->data);
1446 * gtk_main_iteration_do:
1447 * @blocking: %TRUE if you want GTK+ to block if no events are pending
1449 * Runs a single iteration of the mainloop.
1450 * If no events are available either return or block depending on
1451 * the value of @blocking.
1453 * Returns: %TRUE if gtk_main_quit() has been called for the
1454 * innermost mainloop
1457 gtk_main_iteration_do (gboolean blocking)
1459 GDK_THREADS_LEAVE ();
1460 g_main_context_iteration (NULL, blocking);
1461 GDK_THREADS_ENTER ();
1464 return !g_main_loop_is_running (main_loops->data);
1469 /* private libgtk to libgdk interfaces */
1470 gboolean gdk_device_grab_info_libgtk_only (GdkDisplay *display,
1472 GdkWindow **grab_window,
1473 gboolean *owner_events);
1476 rewrite_events_translate (GdkWindow *old_window,
1477 GdkWindow *new_window,
1481 gint old_origin_x, old_origin_y;
1482 gint new_origin_x, new_origin_y;
1484 gdk_window_get_origin (old_window, &old_origin_x, &old_origin_y);
1485 gdk_window_get_origin (new_window, &new_origin_x, &new_origin_y);
1487 *x += old_origin_x - new_origin_x;
1488 *y += old_origin_y - new_origin_y;
1492 rewrite_event_for_window (GdkEvent *event,
1493 GdkWindow *new_window)
1495 event = gdk_event_copy (event);
1497 switch (event->type)
1500 rewrite_events_translate (event->any.window,
1502 &event->scroll.x, &event->scroll.y);
1504 case GDK_BUTTON_PRESS:
1505 case GDK_2BUTTON_PRESS:
1506 case GDK_3BUTTON_PRESS:
1507 case GDK_BUTTON_RELEASE:
1508 rewrite_events_translate (event->any.window,
1510 &event->button.x, &event->button.y);
1512 case GDK_MOTION_NOTIFY:
1513 rewrite_events_translate (event->any.window,
1515 &event->motion.x, &event->motion.y);
1518 case GDK_KEY_RELEASE:
1519 case GDK_PROXIMITY_IN:
1520 case GDK_PROXIMITY_OUT:
1527 g_object_unref (event->any.window);
1528 event->any.window = g_object_ref (new_window);
1533 /* If there is a pointer or keyboard grab in effect with owner_events = TRUE,
1534 * then what X11 does is deliver the event normally if it was going to this
1535 * client, otherwise, delivers it in terms of the grab window. This function
1536 * rewrites events to the effect that events going to the same window group
1537 * are delivered normally, otherwise, the event is delivered in terms of the
1541 rewrite_event_for_grabs (GdkEvent *event)
1543 GdkWindow *grab_window;
1544 GtkWidget *event_widget, *grab_widget;
1545 gpointer grab_widget_ptr;
1546 gboolean owner_events;
1547 GdkDisplay *display;
1550 switch (event->type)
1553 case GDK_BUTTON_PRESS:
1554 case GDK_2BUTTON_PRESS:
1555 case GDK_3BUTTON_PRESS:
1556 case GDK_BUTTON_RELEASE:
1557 case GDK_MOTION_NOTIFY:
1558 case GDK_PROXIMITY_IN:
1559 case GDK_PROXIMITY_OUT:
1561 case GDK_KEY_RELEASE:
1562 display = gdk_window_get_display (event->any.window);
1563 device = gdk_event_get_device (event);
1565 if (!gdk_device_grab_info_libgtk_only (display, device, &grab_window, &owner_events) ||
1573 event_widget = gtk_get_event_widget (event);
1574 gdk_window_get_user_data (grab_window, &grab_widget_ptr);
1575 grab_widget = grab_widget_ptr;
1578 gtk_main_get_window_group (grab_widget) != gtk_main_get_window_group (event_widget))
1579 return rewrite_event_for_window (event, grab_window);
1585 * gtk_main_do_event:
1586 * @event: An event to process (normally passed by GDK)
1588 * Processes a single GDK event.
1590 * This is public only to allow filtering of events between GDK and GTK+.
1591 * You will not usually need to call this function directly.
1593 * While you should not call this function directly, you might want to
1594 * know how exactly events are handled. So here is what this function
1595 * does with the event:
1599 * Compress enter/leave notify events. If the event passed build an
1600 * enter/leave pair together with the next event (peeked from GDK), both
1601 * events are thrown away. This is to avoid a backlog of (de-)highlighting
1602 * widgets crossed by the pointer.
1603 * </para></listitem>
1605 * Find the widget which got the event. If the widget can't be determined
1606 * the event is thrown away unless it belongs to a INCR transaction. In that
1607 * case it is passed to gtk_selection_incr_event().
1608 * </para></listitem>
1610 * Then the event is pushed onto a stack so you can query the currently
1611 * handled event with gtk_get_current_event().
1612 * </para></listitem>
1614 * The event is sent to a widget. If a grab is active all events for widgets
1615 * that are not in the contained in the grab widget are sent to the latter
1616 * with a few exceptions:
1619 * Deletion and destruction events are still sent to the event widget for
1621 * </para></listitem>
1623 * Events which directly relate to the visual representation of the event
1625 * </para></listitem>
1627 * Leave events are delivered to the event widget if there was an enter
1628 * event delivered to it before without the paired leave event.
1629 * </para></listitem>
1631 * Drag events are not redirected because it is unclear what the semantics
1633 * </para></listitem>
1635 * Another point of interest might be that all key events are first passed
1636 * through the key snooper functions if there are any. Read the description
1637 * of gtk_key_snooper_install() if you need this feature.
1638 * </para></listitem>
1640 * After finishing the delivery the event is popped from the event stack.
1641 * </para></listitem>
1645 gtk_main_do_event (GdkEvent *event)
1647 GtkWidget *event_widget;
1648 GtkWidget *grab_widget = NULL;
1649 GtkWindowGroup *window_group;
1650 GdkEvent *rewritten_event = NULL;
1654 if (event->type == GDK_SETTING)
1656 _gtk_settings_handle_event (&event->setting);
1660 if (event->type == GDK_OWNER_CHANGE)
1662 _gtk_clipboard_handle_event (&event->owner_change);
1666 /* Find the widget which got the event. We store the widget
1667 * in the user_data field of GdkWindow's. Ignore the event
1668 * if we don't have a widget for it, except for GDK_PROPERTY_NOTIFY
1669 * events which are handled specially. Though this happens rarely,
1670 * bogus events can occur for e.g. destroyed GdkWindows.
1672 event_widget = gtk_get_event_widget (event);
1675 /* To handle selection INCR transactions, we select
1676 * PropertyNotify events on the requestor window and create
1677 * a corresponding (fake) GdkWindow so that events get here.
1678 * There won't be a widget though, so we have to handle
1681 if (event->type == GDK_PROPERTY_NOTIFY)
1682 _gtk_selection_incr_event (event->any.window,
1688 /* If pointer or keyboard grabs are in effect, munge the events
1689 * so that each window group looks like a separate app.
1691 rewritten_event = rewrite_event_for_grabs (event);
1692 if (rewritten_event)
1694 event = rewritten_event;
1695 event_widget = gtk_get_event_widget (event);
1698 window_group = gtk_main_get_window_group (event_widget);
1699 device = gdk_event_get_device (event);
1701 /* check whether there is a (device) grab in effect... */
1703 grab_widget = gtk_window_group_get_current_device_grab (window_group, device);
1706 grab_widget = gtk_window_group_get_current_grab (window_group);
1708 /* If the grab widget is an ancestor of the event widget
1709 * then we send the event to the original event widget.
1710 * This is the key to implementing modality.
1713 (gtk_widget_is_sensitive (event_widget) &&
1714 gtk_widget_is_ancestor (event_widget, grab_widget)))
1715 grab_widget = event_widget;
1717 /* If the widget receiving events is actually blocked by another
1721 _gtk_window_group_widget_is_blocked_for_device (window_group, grab_widget, device))
1723 if (rewritten_event)
1724 gdk_event_free (rewritten_event);
1729 /* Push the event onto a stack of current events for
1730 * gtk_current_event_get().
1732 current_events = g_list_prepend (current_events, event);
1734 /* Not all events get sent to the grabbing widget.
1735 * The delete, destroy, expose, focus change and resize
1736 * events still get sent to the event widget because
1737 * 1) these events have no meaning for the grabbing widget
1738 * and 2) redirecting these events to the grabbing widget
1739 * could cause the display to be messed up.
1741 * Drag events are also not redirected, since it isn't
1742 * clear what the semantics of that would be.
1744 switch (event->type)
1750 g_object_ref (event_widget);
1751 if ((!gtk_window_group_get_current_grab (window_group) || gtk_widget_get_toplevel (gtk_window_group_get_current_grab (window_group)) == event_widget) &&
1752 !gtk_widget_event (event_widget, event))
1753 gtk_widget_destroy (event_widget);
1754 g_object_unref (event_widget);
1758 /* Unexpected GDK_DESTROY from the outside, ignore for
1759 * child windows, handle like a GDK_DELETE for toplevels
1761 if (!gtk_widget_get_parent (event_widget))
1763 g_object_ref (event_widget);
1764 if (!gtk_widget_event (event_widget, event) &&
1765 gtk_widget_get_realized (event_widget))
1766 gtk_widget_destroy (event_widget);
1767 g_object_unref (event_widget);
1772 if (event->any.window && gtk_widget_get_double_buffered (event_widget))
1774 gdk_window_begin_paint_region (event->any.window, event->expose.region);
1775 gtk_widget_send_expose (event_widget, event);
1776 gdk_window_end_paint (event->any.window);
1780 /* The app may paint with a previously allocated cairo_t,
1781 * which will draw directly to the window. We can't catch cairo
1782 * draw operations to automatically flush the window, thus we
1783 * need to explicitly flush any outstanding moves or double
1786 gdk_window_flush (event->any.window);
1787 gtk_widget_send_expose (event_widget, event);
1791 case GDK_PROPERTY_NOTIFY:
1792 case GDK_FOCUS_CHANGE:
1796 case GDK_SELECTION_CLEAR:
1797 case GDK_SELECTION_REQUEST:
1798 case GDK_SELECTION_NOTIFY:
1799 case GDK_CLIENT_EVENT:
1800 case GDK_VISIBILITY_NOTIFY:
1801 case GDK_WINDOW_STATE:
1802 case GDK_GRAB_BROKEN:
1804 gtk_widget_event (event_widget, event);
1808 case GDK_BUTTON_PRESS:
1809 case GDK_2BUTTON_PRESS:
1810 case GDK_3BUTTON_PRESS:
1811 gtk_propagate_event (grab_widget, event);
1815 case GDK_KEY_RELEASE:
1818 if (gtk_invoke_key_snoopers (grab_widget, event))
1821 /* Catch alt press to enable auto-mnemonics;
1822 * menus are handled elsewhere
1824 if ((event->key.keyval == GDK_KEY_Alt_L || event->key.keyval == GDK_KEY_Alt_R) &&
1825 !GTK_IS_MENU_SHELL (grab_widget))
1827 gboolean auto_mnemonics;
1829 g_object_get (gtk_widget_get_settings (grab_widget),
1830 "gtk-auto-mnemonics", &auto_mnemonics, NULL);
1834 gboolean mnemonics_visible;
1837 mnemonics_visible = (event->type == GDK_KEY_PRESS);
1839 window = gtk_widget_get_toplevel (grab_widget);
1841 if (GTK_IS_WINDOW (window))
1842 gtk_window_set_mnemonics_visible (GTK_WINDOW (window), mnemonics_visible);
1845 /* else fall through */
1846 case GDK_MOTION_NOTIFY:
1847 case GDK_BUTTON_RELEASE:
1848 case GDK_PROXIMITY_IN:
1849 case GDK_PROXIMITY_OUT:
1850 gtk_propagate_event (grab_widget, event);
1853 case GDK_ENTER_NOTIFY:
1854 _gtk_widget_set_device_window (event_widget,
1855 gdk_event_get_device (event),
1857 if (gtk_widget_is_sensitive (grab_widget))
1858 gtk_widget_event (grab_widget, event);
1861 case GDK_LEAVE_NOTIFY:
1862 _gtk_widget_set_device_window (event_widget,
1863 gdk_event_get_device (event),
1865 if (gtk_widget_is_sensitive (grab_widget))
1866 gtk_widget_event (grab_widget, event);
1869 case GDK_DRAG_STATUS:
1870 case GDK_DROP_FINISHED:
1871 _gtk_drag_source_handle_event (event_widget, event);
1873 case GDK_DRAG_ENTER:
1874 case GDK_DRAG_LEAVE:
1875 case GDK_DRAG_MOTION:
1876 case GDK_DROP_START:
1877 _gtk_drag_dest_handle_event (event_widget, event);
1880 g_assert_not_reached ();
1884 if (event->type == GDK_ENTER_NOTIFY
1885 || event->type == GDK_LEAVE_NOTIFY
1886 || event->type == GDK_BUTTON_PRESS
1887 || event->type == GDK_2BUTTON_PRESS
1888 || event->type == GDK_3BUTTON_PRESS
1889 || event->type == GDK_KEY_PRESS
1890 || event->type == GDK_DRAG_ENTER
1891 || event->type == GDK_GRAB_BROKEN
1892 || event->type == GDK_MOTION_NOTIFY
1893 || event->type == GDK_SCROLL)
1895 _gtk_tooltip_handle_event (event);
1898 tmp_list = current_events;
1899 current_events = g_list_remove_link (current_events, tmp_list);
1900 g_list_free_1 (tmp_list);
1902 if (rewritten_event)
1903 gdk_event_free (rewritten_event);
1909 * All this function does it to return %TRUE.
1911 * This can be useful for example if you want to inhibit the deletion
1912 * of a window. Of course you should not do this as the user expects
1913 * a reaction from clicking the close icon of the window...
1916 * <title>A persistent window</title>
1918 * #include <gtk/gtk.h><
1921 * main (int argc, char **argv)
1923 * GtkWidget *win, *but;
1925 * gtk_init (&argc, &argv);
1927 * win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1928 * g_signal_connect (win, "delete-event",
1929 * G_CALLBACK (gtk_true), NULL);
1930 * g_signal_connect (win, "destroy",
1931 * G_CALLBACK (gtk_main_quit), NULL);
1933 * but = gtk_button_new_with_label ("Close yourself. I mean it!");
1934 * g_signal_connect_swapped (but, "clicked",
1935 * G_CALLBACK (gtk_object_destroy), win);
1936 * gtk_container_add (GTK_CONTAINER (win), but);
1938 * gtk_widget_show_all (win);
1958 * Analogical to gtk_true(), this function does nothing
1959 * but always returns %FALSE.
1969 static GtkWindowGroup *
1970 gtk_main_get_window_group (GtkWidget *widget)
1972 GtkWidget *toplevel = NULL;
1975 toplevel = gtk_widget_get_toplevel (widget);
1977 if (GTK_IS_WINDOW (toplevel))
1978 return gtk_window_get_group (GTK_WINDOW (toplevel));
1980 return gtk_window_get_group (NULL);
1985 GtkWidget *old_grab_widget;
1986 GtkWidget *new_grab_widget;
1987 gboolean was_grabbed;
1988 gboolean is_grabbed;
1990 GList *notified_windows;
1995 synth_crossing_for_grab_notify (GtkWidget *from,
1997 GrabNotifyInfo *info,
1999 GdkCrossingMode mode)
2003 GdkDevice *device = devices->data;
2004 GdkWindow *from_window, *to_window;
2006 /* Do not propagate events more than once to
2007 * the same windows if non-multidevice aware.
2013 from_window = _gtk_widget_get_device_window (from, device);
2016 !gdk_window_get_support_multidevice (from_window) &&
2017 g_list_find (info->notified_windows, from_window))
2025 to_window = _gtk_widget_get_device_window (to, device);
2028 !gdk_window_get_support_multidevice (to_window) &&
2029 g_list_find (info->notified_windows, to_window))
2033 if (from_window || to_window)
2035 _gtk_widget_synthesize_crossing ((from_window) ? from : NULL,
2036 (to_window) ? to : NULL,
2040 info->notified_windows = g_list_prepend (info->notified_windows, from_window);
2043 info->notified_windows = g_list_prepend (info->notified_windows, to_window);
2046 devices = devices->next;
2051 gtk_grab_notify_foreach (GtkWidget *child,
2054 GrabNotifyInfo *info = data;
2055 gboolean was_grabbed, is_grabbed, was_shadowed, is_shadowed;
2058 was_grabbed = info->was_grabbed;
2059 is_grabbed = info->is_grabbed;
2061 info->was_grabbed = info->was_grabbed || (child == info->old_grab_widget);
2062 info->is_grabbed = info->is_grabbed || (child == info->new_grab_widget);
2064 was_shadowed = info->old_grab_widget && !info->was_grabbed;
2065 is_shadowed = info->new_grab_widget && !info->is_grabbed;
2067 g_object_ref (child);
2069 if ((was_shadowed || is_shadowed) && GTK_IS_CONTAINER (child))
2070 gtk_container_forall (GTK_CONTAINER (child), gtk_grab_notify_foreach, info);
2073 _gtk_widget_get_device_window (child, info->device))
2075 /* Device specified and is on widget */
2076 devices = g_list_prepend (NULL, info->device);
2079 devices = _gtk_widget_list_devices (child);
2083 _gtk_widget_set_shadowed (child, TRUE);
2084 if (!was_shadowed && devices &&
2085 gtk_widget_is_sensitive (child))
2086 synth_crossing_for_grab_notify (child, info->new_grab_widget,
2088 GDK_CROSSING_GTK_GRAB);
2092 _gtk_widget_set_shadowed (child, FALSE);
2093 if (was_shadowed && devices &&
2094 gtk_widget_is_sensitive (child))
2095 synth_crossing_for_grab_notify (info->old_grab_widget, child,
2097 info->from_grab ? GDK_CROSSING_GTK_GRAB :
2098 GDK_CROSSING_GTK_UNGRAB);
2101 if (was_shadowed != is_shadowed)
2102 _gtk_widget_grab_notify (child, was_shadowed);
2104 g_object_unref (child);
2105 g_list_free (devices);
2107 info->was_grabbed = was_grabbed;
2108 info->is_grabbed = is_grabbed;
2112 gtk_grab_notify (GtkWindowGroup *group,
2114 GtkWidget *old_grab_widget,
2115 GtkWidget *new_grab_widget,
2119 GrabNotifyInfo info = { 0 };
2121 if (old_grab_widget == new_grab_widget)
2124 info.old_grab_widget = old_grab_widget;
2125 info.new_grab_widget = new_grab_widget;
2126 info.from_grab = from_grab;
2127 info.device = device;
2129 g_object_ref (group);
2131 toplevels = gtk_window_list_toplevels ();
2132 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
2136 GtkWindow *toplevel = toplevels->data;
2137 toplevels = g_list_delete_link (toplevels, toplevels);
2139 info.was_grabbed = FALSE;
2140 info.is_grabbed = FALSE;
2142 if (group == gtk_window_get_group (toplevel))
2143 gtk_grab_notify_foreach (GTK_WIDGET (toplevel), &info);
2144 g_object_unref (toplevel);
2147 g_list_free (info.notified_windows);
2148 g_object_unref (group);
2153 * @widget: The widget that grabs keyboard and pointer events
2155 * Makes @widget the current grabbed widget.
2157 * This means that interaction with other widgets in the same
2158 * application is blocked and mouse as well as keyboard events
2159 * are delivered to this widget.
2161 * If @widget is not sensitive, it is not set as the current
2162 * grabbed widget and this function does nothing.
2165 gtk_grab_add (GtkWidget *widget)
2167 GtkWindowGroup *group;
2168 GtkWidget *old_grab_widget;
2170 g_return_if_fail (widget != NULL);
2172 if (!gtk_widget_has_grab (widget) && gtk_widget_is_sensitive (widget))
2174 _gtk_widget_set_has_grab (widget, TRUE);
2176 group = gtk_main_get_window_group (widget);
2178 old_grab_widget = gtk_window_group_get_current_grab (group);
2180 g_object_ref (widget);
2181 _gtk_window_group_add_grab (group, widget);
2183 gtk_grab_notify (group, NULL, old_grab_widget, widget, TRUE);
2188 * gtk_grab_get_current:
2190 * Queries the current grab of the default window group.
2192 * Return value: (transfer none): The widget which currently
2193 * has the grab or %NULL if no grab is active
2196 gtk_grab_get_current (void)
2198 GtkWindowGroup *group;
2200 group = gtk_main_get_window_group (NULL);
2202 return gtk_window_group_get_current_grab (group);
2207 * @widget: The widget which gives up the grab
2209 * Removes the grab from the given widget.
2211 * You have to pair calls to gtk_grab_add() and gtk_grab_remove().
2213 * If @widget does not have the grab, this function does nothing.
2216 gtk_grab_remove (GtkWidget *widget)
2218 GtkWindowGroup *group;
2219 GtkWidget *new_grab_widget;
2221 g_return_if_fail (widget != NULL);
2223 if (gtk_widget_has_grab (widget))
2225 _gtk_widget_set_has_grab (widget, FALSE);
2227 group = gtk_main_get_window_group (widget);
2228 _gtk_window_group_remove_grab (group, widget);
2229 new_grab_widget = gtk_window_group_get_current_grab (group);
2231 gtk_grab_notify (group, NULL, widget, new_grab_widget, FALSE);
2233 g_object_unref (widget);
2238 * gtk_device_grab_add:
2239 * @widget: a #GtkWidget
2240 * @device: a #GtkDevice to grab on.
2241 * @block_others: %TRUE to prevent other devices to interact with @widget.
2243 * Adds a GTK+ grab on @device, so all the events on @device and its
2244 * associated pointer or keyboard (if any) are delivered to @widget.
2245 * If the @block_others parameter is %TRUE, any other devices will be
2246 * unable to interact with @widget during the grab.
2251 gtk_device_grab_add (GtkWidget *widget,
2253 gboolean block_others)
2255 GtkWindowGroup *group;
2256 GtkWidget *old_grab_widget;
2258 g_return_if_fail (GTK_IS_WIDGET (widget));
2259 g_return_if_fail (GDK_IS_DEVICE (device));
2261 group = gtk_main_get_window_group (widget);
2262 old_grab_widget = gtk_window_group_get_current_device_grab (group, device);
2264 if (old_grab_widget != widget)
2265 _gtk_window_group_add_device_grab (group, widget, device, block_others);
2267 gtk_grab_notify (group, device, old_grab_widget, widget, TRUE);
2271 * gtk_device_grab_remove:
2272 * @widget: a #GtkWidget
2273 * @device: a #GdkDevice
2275 * Removes a device grab from the given widget.
2277 * You have to pair calls to gtk_device_grab_add() and
2278 * gtk_device_grab_remove().
2283 gtk_device_grab_remove (GtkWidget *widget,
2286 GtkWindowGroup *group;
2287 GtkWidget *new_grab_widget;
2289 g_return_if_fail (GTK_IS_WIDGET (widget));
2290 g_return_if_fail (GDK_IS_DEVICE (device));
2292 group = gtk_main_get_window_group (widget);
2293 _gtk_window_group_remove_device_grab (group, widget, device);
2294 new_grab_widget = gtk_window_group_get_current_device_grab (group, device);
2296 gtk_grab_notify (group, device, widget, new_grab_widget, FALSE);
2300 * gtk_key_snooper_install:
2301 * @snooper: a #GtkKeySnoopFunc
2302 * @func_data: data to pass to @snooper
2304 * Installs a key snooper function, which will get called on all
2305 * key events before delivering them normally.
2307 * Returns: a unique id for this key snooper for use with
2308 * gtk_key_snooper_remove().
2311 gtk_key_snooper_install (GtkKeySnoopFunc snooper,
2314 GtkKeySnooperData *data;
2315 static guint snooper_id = 1;
2317 g_return_val_if_fail (snooper != NULL, 0);
2319 data = g_new (GtkKeySnooperData, 1);
2320 data->func = snooper;
2321 data->func_data = func_data;
2322 data->id = snooper_id++;
2323 key_snoopers = g_slist_prepend (key_snoopers, data);
2329 * gtk_key_snooper_remove:
2330 * @snooper_handler_id: Identifies the key snooper to remove
2332 * Removes the key snooper function with the given id.
2335 gtk_key_snooper_remove (guint snooper_id)
2337 GtkKeySnooperData *data = NULL;
2340 slist = key_snoopers;
2344 if (data->id == snooper_id)
2347 slist = slist->next;
2352 key_snoopers = g_slist_remove (key_snoopers, data);
2358 gtk_invoke_key_snoopers (GtkWidget *grab_widget,
2362 gint return_val = FALSE;
2364 slist = key_snoopers;
2365 while (slist && !return_val)
2367 GtkKeySnooperData *data;
2370 slist = slist->next;
2371 return_val = (*data->func) (grab_widget, (GdkEventKey*) event, data->func_data);
2378 * gtk_get_current_event:
2380 * Obtains a copy of the event currently being processed by GTK+.
2382 * For example, if you are handling a #GtkButton::clicked signal,
2383 * the current event will be the #GdkEventButton that triggered
2384 * the ::clicked signal.
2386 * Return value: a copy of the current event, or %NULL if there is
2387 * no current event. The returned event must be freed with
2391 gtk_get_current_event (void)
2394 return gdk_event_copy (current_events->data);
2400 * gtk_get_current_event_time:
2402 * If there is a current event and it has a timestamp,
2403 * return that timestamp, otherwise return %GDK_CURRENT_TIME.
2405 * Return value: the timestamp from the current event,
2406 * or %GDK_CURRENT_TIME.
2409 gtk_get_current_event_time (void)
2412 return gdk_event_get_time (current_events->data);
2414 return GDK_CURRENT_TIME;
2418 * gtk_get_current_event_state:
2419 * @state: a location to store the state of the current event
2421 * If there is a current event and it has a state field, place
2422 * that state field in @state and return %TRUE, otherwise return
2425 * Return value: %TRUE if there was a current event and it
2429 gtk_get_current_event_state (GdkModifierType *state)
2431 g_return_val_if_fail (state != NULL, FALSE);
2434 return gdk_event_get_state (current_events->data, state);
2443 * gtk_get_current_event_device:
2445 * If there is a current event and it has a device, return that
2446 * device, otherwise return %NULL.
2448 * Returns: (transfer none): a #GdkDevice, or %NULL
2451 gtk_get_current_event_device (void)
2454 return gdk_event_get_device (current_events->data);
2460 * gtk_get_event_widget:
2461 * @event: a #GdkEvent
2463 * If @event is %NULL or the event was not associated with any widget,
2464 * returns %NULL, otherwise returns the widget that received the event
2467 * Return value: (transfer none): the widget that originally
2468 * received @event, or %NULL
2471 gtk_get_event_widget (GdkEvent *event)
2474 gpointer widget_ptr;
2477 if (event && event->any.window &&
2478 (event->type == GDK_DESTROY || !gdk_window_is_destroyed (event->any.window)))
2480 gdk_window_get_user_data (event->any.window, &widget_ptr);
2481 widget = widget_ptr;
2488 * gtk_propagate_event:
2489 * @widget: a #GtkWidget
2492 * Sends an event to a widget, propagating the event to parent widgets
2493 * if the event remains unhandled.
2495 * Events received by GTK+ from GDK normally begin in gtk_main_do_event().
2496 * Depending on the type of event, existence of modal dialogs, grabs, etc.,
2497 * the event may be propagated; if so, this function is used.
2499 * gtk_propagate_event() calls gtk_widget_event() on each widget it
2500 * decides to send the event to. So gtk_widget_event() is the lowest-level
2501 * function; it simply emits the #GtkWidget::event and possibly an
2502 * event-specific signal on a widget. gtk_propagate_event() is a bit
2503 * higher-level, and gtk_main_do_event() is the highest level.
2505 * All that said, you most likely don't want to use any of these
2506 * functions; synthesizing events is rarely needed. There are almost
2507 * certainly better ways to achieve your goals. For example, use
2508 * gdk_window_invalidate_rect() or gtk_widget_queue_draw() instead
2509 * of making up expose events.
2512 gtk_propagate_event (GtkWidget *widget,
2517 g_return_if_fail (GTK_IS_WIDGET (widget));
2518 g_return_if_fail (event != NULL);
2520 handled_event = FALSE;
2522 g_object_ref (widget);
2524 if ((event->type == GDK_KEY_PRESS) ||
2525 (event->type == GDK_KEY_RELEASE))
2527 /* Only send key events within Window widgets to the Window
2528 * The Window widget will in turn pass the
2529 * key event on to the currently focused widget
2534 window = gtk_widget_get_toplevel (widget);
2535 if (GTK_IS_WINDOW (window))
2537 /* If there is a grab within the window, give the grab widget
2538 * a first crack at the key event
2540 if (widget != window && gtk_widget_has_grab (widget))
2541 handled_event = gtk_widget_event (widget, event);
2545 window = gtk_widget_get_toplevel (widget);
2546 if (GTK_IS_WINDOW (window))
2548 if (gtk_widget_is_sensitive (window))
2549 gtk_widget_event (window, event);
2553 handled_event = TRUE; /* don't send to widget */
2557 /* Other events get propagated up the widget tree
2558 * so that parents can see the button and motion
2559 * events of the children.
2567 /* Scroll events are special cased here because it
2568 * feels wrong when scrolling a GtkViewport, say,
2569 * to have children of the viewport eat the scroll
2572 if (!gtk_widget_is_sensitive (widget))
2573 handled_event = event->type != GDK_SCROLL;
2575 handled_event = gtk_widget_event (widget, event);
2577 tmp = gtk_widget_get_parent (widget);
2578 g_object_unref (widget);
2582 if (!handled_event && widget)
2583 g_object_ref (widget);
2589 g_object_unref (widget);
2593 _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
2594 GValue *return_accu,
2595 const GValue *handler_return,
2598 gboolean continue_emission;
2599 gboolean signal_handled;
2601 signal_handled = g_value_get_boolean (handler_return);
2602 g_value_set_boolean (return_accu, signal_handled);
2603 continue_emission = !signal_handled;
2605 return continue_emission;