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 "gtkprivate.h"
72 #include "gdk/gdkprivate.h" /* for GDK_WINDOW_DESTROYED */
74 /* Private type definitions
76 typedef struct _GtkInitFunction GtkInitFunction;
77 typedef struct _GtkQuitFunction GtkQuitFunction;
78 typedef struct _GtkClosure GtkClosure;
79 typedef struct _GtkKeySnooperData GtkKeySnooperData;
81 struct _GtkInitFunction
87 struct _GtkQuitFunction
91 GtkCallbackMarshal marshal;
94 GtkDestroyNotify destroy;
99 GtkCallbackMarshal marshal;
101 GtkDestroyNotify destroy;
104 struct _GtkKeySnooperData
106 GtkKeySnoopFunc func;
111 static gint gtk_quit_invoke_function (GtkQuitFunction *quitf);
112 static void gtk_quit_destroy (GtkQuitFunction *quitf);
113 static gint gtk_invoke_key_snoopers (GtkWidget *grab_widget,
116 static void gtk_destroy_closure (gpointer data);
117 static gboolean gtk_invoke_idle_timeout (gpointer data);
118 static void gtk_invoke_input (gpointer data,
120 GdkInputCondition condition);
123 static void gtk_error (gchar *str);
124 static void gtk_warning (gchar *str);
125 static void gtk_message (gchar *str);
126 static void gtk_print (gchar *str);
129 static GtkWindowGroup *gtk_main_get_window_group (GtkWidget *widget);
131 const guint gtk_major_version = GTK_MAJOR_VERSION;
132 const guint gtk_minor_version = GTK_MINOR_VERSION;
133 const guint gtk_micro_version = GTK_MICRO_VERSION;
134 const guint gtk_binary_age = GTK_BINARY_AGE;
135 const guint gtk_interface_age = GTK_INTERFACE_AGE;
137 static guint gtk_main_loop_level = 0;
138 static gint gtk_initialized = FALSE;
139 static GList *current_events = NULL;
141 static GSList *main_loops = NULL; /* stack of currently executing main loops */
143 static GList *init_functions = NULL; /* A list of init functions.
145 static GList *quit_functions = NULL; /* A list of quit functions.
147 static GSList *key_snoopers = NULL;
149 guint gtk_debug_flags = 0; /* Global GTK debug flag */
151 #ifdef G_ENABLE_DEBUG
152 static const GDebugKey gtk_debug_keys[] = {
153 {"misc", GTK_DEBUG_MISC},
154 {"plugsocket", GTK_DEBUG_PLUGSOCKET},
155 {"text", GTK_DEBUG_TEXT},
156 {"tree", GTK_DEBUG_TREE},
157 {"updates", GTK_DEBUG_UPDATES},
158 {"keybindings", GTK_DEBUG_KEYBINDINGS},
159 {"multihead", GTK_DEBUG_MULTIHEAD},
160 {"modules", GTK_DEBUG_MODULES},
161 {"geometry", GTK_DEBUG_GEOMETRY},
162 {"icontheme", GTK_DEBUG_ICONTHEME}
164 #endif /* G_ENABLE_DEBUG */
168 * @required_major: the required major version.
169 * @required_minor: the required major version.
170 * @required_micro: the required major version.
172 * Checks that the GTK+ library in use is compatible with the
173 * given version. Generally you would pass in the constants
174 * #GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION
175 * as the three arguments to this function; that produces
176 * a check that the library in use is compatible with
177 * the version of GTK+ the application or module was compiled
180 * Compatibility is defined by two things: first the version
181 * of the running library is newer than the version
182 * @required_major.required_minor.@required_micro. Second
183 * the running library must be binary compatible with the
184 * version @required_major.required_minor.@required_micro
185 * (same major version.)
187 * This function is primarily for GTK+ modules; the module
188 * can call this function to check that it wasn't loaded
189 * into an incompatible version of GTK+. However, such a
190 * a check isn't completely reliable, since the module may be
191 * linked against an old version of GTK+ and calling the
192 * old version of gtk_check_version(), but still get loaded
193 * into an application using a newer version of GTK+.
195 * Return value: %NULL if the GTK+ library is compatible with the
196 * given version, or a string describing the version mismatch.
197 * The returned string is owned by GTK+ and should not be modified
201 gtk_check_version (guint required_major,
202 guint required_minor,
203 guint required_micro)
205 gint gtk_effective_micro = 100 * GTK_MINOR_VERSION + GTK_MICRO_VERSION;
206 gint required_effective_micro = 100 * required_minor + required_micro;
208 if (required_major > GTK_MAJOR_VERSION)
209 return "Gtk+ version too old (major mismatch)";
210 if (required_major < GTK_MAJOR_VERSION)
211 return "Gtk+ version too new (major mismatch)";
212 if (required_effective_micro < gtk_effective_micro - GTK_BINARY_AGE)
213 return "Gtk+ version too new (micro mismatch)";
214 if (required_effective_micro > gtk_effective_micro)
215 return "Gtk+ version too old (micro mismatch)";
219 /* This checks to see if the process is running suid or sgid
220 * at the current time. If so, we don't allow GTK+ to be initialized.
221 * This is meant to be a mild check - we only error out if we
222 * can prove the programmer is doing something wrong, not if
223 * they could be doing something wrong. For this reason, we
224 * don't use issetugid() on BSD or prctl (PR_GET_DUMPABLE).
229 /* this isn't at all relevant on MS Windows and doesn't compile ... --hb */
231 uid_t ruid, euid, suid; /* Real, effective and saved user ID's */
232 gid_t rgid, egid, sgid; /* Real, effective and saved group ID's */
234 #ifdef HAVE_GETRESUID
235 /* These aren't in the header files, so we prototype them here.
237 int getresuid(uid_t *ruid, uid_t *euid, uid_t *suid);
238 int getresgid(gid_t *rgid, gid_t *egid, gid_t *sgid);
240 if (getresuid (&ruid, &euid, &suid) != 0 ||
241 getresgid (&rgid, &egid, &sgid) != 0)
242 #endif /* HAVE_GETRESUID */
244 suid = ruid = getuid ();
245 sgid = rgid = getgid ();
250 if (ruid != euid || ruid != suid ||
251 rgid != egid || rgid != sgid)
253 g_warning ("This process is currently running setuid or setgid.\n"
254 "This is not a supported use of GTK+. You must create a helper\n"
255 "program instead. For further details, see:\n\n"
256 " http://www.gtk.org/setuid.html\n\n"
257 "Refusing to initialize GTK+.");
266 G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name)
269 _gtk_get_datadir (void)
271 static char *gtk_datadir = NULL;
272 if (gtk_datadir == NULL)
273 gtk_datadir = g_win32_get_package_installation_subdirectory
274 (GETTEXT_PACKAGE, dll_name, "share");
280 _gtk_get_libdir (void)
282 static char *gtk_libdir = NULL;
283 if (gtk_libdir == NULL)
284 gtk_libdir = g_win32_get_package_installation_subdirectory
285 (GETTEXT_PACKAGE, dll_name, "lib");
291 _gtk_get_localedir (void)
293 static char *gtk_localedir = NULL;
294 if (gtk_localedir == NULL)
298 temp = g_win32_get_package_installation_subdirectory
299 (GETTEXT_PACKAGE, dll_name, "lib\\locale");
301 /* gtk_localedir is passed to bindtextdomain() which isn't
304 gtk_localedir = g_win32_locale_filename_from_utf8 (temp);
307 return gtk_localedir;
311 _gtk_get_sysconfdir (void)
313 static char *gtk_sysconfdir = NULL;
314 if (gtk_sysconfdir == NULL)
315 gtk_sysconfdir = g_win32_get_package_installation_subdirectory
316 (GETTEXT_PACKAGE, dll_name, "etc");
318 return gtk_sysconfdir;
322 _gtk_get_data_prefix (void)
324 static char *gtk_data_prefix = NULL;
325 if (gtk_data_prefix == NULL)
326 gtk_data_prefix = g_win32_get_package_installation_directory
327 (GETTEXT_PACKAGE, dll_name);
329 return gtk_data_prefix;
332 #endif /* G_OS_WIN32 */
334 static gboolean do_setlocale = TRUE;
337 * gtk_disable_setlocale:
339 * Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and
340 * gtk_parse_args() from automatically
341 * calling <literal>setlocale (LC_ALL, "")</literal>. You would
342 * want to use this function if you wanted to set the locale for
343 * your program to something other than the user's locale, or if
344 * you wanted to set different values for different locale categories.
346 * Most programs should not need to call this function.
349 gtk_disable_setlocale (void)
352 g_warning ("gtk_disable_setlocale() must be called before gtk_init()");
354 do_setlocale = FALSE;
357 #ifdef G_PLATFORM_WIN32
358 #undef gtk_init_check
361 static GString *gtk_modules_string = NULL;
362 static gboolean g_fatal_warnings = FALSE;
364 #ifdef G_ENABLE_DEBUG
366 gtk_arg_debug_cb (const char *key, const char *value, gpointer user_data)
368 gtk_debug_flags |= g_parse_debug_string (value,
370 G_N_ELEMENTS (gtk_debug_keys));
376 gtk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data)
378 gtk_debug_flags &= ~g_parse_debug_string (value,
380 G_N_ELEMENTS (gtk_debug_keys));
384 #endif /* G_ENABLE_DEBUG */
387 gtk_arg_module_cb (const char *key, const char *value, gpointer user_data)
391 if (gtk_modules_string)
392 g_string_append_c (gtk_modules_string, G_SEARCHPATH_SEPARATOR);
394 gtk_modules_string = g_string_new (NULL);
396 g_string_append (gtk_modules_string, value);
402 static const GOptionEntry gtk_args[] = {
403 { "gtk-module", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_module_cb,
404 /* Description of --gtk-module=MODULES in --help output */ N_("Load additional GTK+ modules"),
405 /* Placeholder in --gtk-module=MODULES in --help output */ N_("MODULES") },
406 { "g-fatal-warnings", 0, 0, G_OPTION_ARG_NONE, &g_fatal_warnings,
407 /* Description of --g-fatal-warnings in --help output */ N_("Make all warnings fatal"), NULL },
408 #ifdef G_ENABLE_DEBUG
409 { "gtk-debug", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_debug_cb,
410 /* Description of --gtk-debug=FLAGS in --help output */ N_("GTK+ debugging flags to set"),
411 /* Placeholder in --gtk-debug=FLAGS in --help output */ N_("FLAGS") },
412 { "gtk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gtk_arg_no_debug_cb,
413 /* Description of --gtk-no-debug=FLAGS in --help output */ N_("GTK+ debugging flags to unset"),
414 /* Placeholder in --gtk-no-debug=FLAGS in --help output */ N_("FLAGS") },
420 do_pre_parse_initialization (int *argc,
423 const gchar *env_string;
426 g_set_error_handler (gtk_error);
427 g_set_warning_handler (gtk_warning);
428 g_set_message_handler (gtk_message);
429 g_set_print_handler (gtk_print);
434 if (!setlocale (LC_ALL, ""))
435 g_warning ("Locale not supported by C library.\n\tUsing the fallback 'C' locale.");
438 gdk_pre_parse_libgtk_only ();
439 gdk_event_handler_set ((GdkEventFunc)gtk_main_do_event, NULL, NULL);
441 #ifdef G_ENABLE_DEBUG
442 env_string = g_getenv ("GTK_DEBUG");
443 if (env_string != NULL)
445 gtk_debug_flags = g_parse_debug_string (env_string,
447 G_N_ELEMENTS (gtk_debug_keys));
450 #endif /* G_ENABLE_DEBUG */
452 env_string = g_getenv ("GTK_MODULES");
454 gtk_modules_string = g_string_new (env_string);
458 gettext_initialization (void)
461 bindtextdomain (GETTEXT_PACKAGE, GTK_LOCALEDIR);
462 bindtextdomain (GETTEXT_PACKAGE "-properties", GTK_LOCALEDIR);
463 # ifdef HAVE_BIND_TEXTDOMAIN_CODESET
464 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
465 bind_textdomain_codeset (GETTEXT_PACKAGE "-properties", "UTF-8");
471 do_post_parse_initialization (int *argc,
477 gettext_initialization ();
479 if (g_fatal_warnings)
481 GLogLevelFlags fatal_mask;
483 fatal_mask = g_log_set_always_fatal (G_LOG_FATAL_MASK);
484 fatal_mask |= G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL;
485 g_log_set_always_fatal (fatal_mask);
488 if (gtk_debug_flags & GTK_DEBUG_UPDATES)
489 gdk_window_set_debug_updates (TRUE);
492 /* Translate to default:RTL if you want your widgets
493 * to be RTL, otherwise translate to default:LTR.
494 * Do *not* translate it to "predefinito:LTR", if it
495 * it isn't default:LTR or default:RTL it will not work
497 char *e = _("default:LTR");
498 if (strcmp (e, "default:RTL")==0) {
499 gtk_widget_set_default_direction (GTK_TEXT_DIR_RTL);
500 } else if (strcmp (e, "default:LTR")) {
501 g_warning ("Whoever translated default:LTR did so wrongly.\n");
506 _gtk_accel_map_init ();
509 /* Set the 'initialized' flag.
511 gtk_initialized = TRUE;
513 /* load gtk modules */
514 if (gtk_modules_string)
516 _gtk_modules_init (argc, argv, gtk_modules_string->str);
517 g_string_free (gtk_modules_string, TRUE);
524 gboolean open_default_display;
528 pre_parse_hook (GOptionContext *context,
533 do_pre_parse_initialization (NULL, NULL);
539 post_parse_hook (GOptionContext *context,
544 OptionGroupInfo *info = data;
547 do_post_parse_initialization (NULL, NULL);
549 if (info->open_default_display)
551 if (gdk_display_open_default_libgtk_only () == NULL)
555 G_OPTION_ERROR_FAILED,
556 "cannot open display: %s",
557 gdk_get_display_arg_name ());
568 * gtk_get_option_group:
569 * @open_default_display: whether to open the default display
570 * when parsing the commandline arguments
572 * Returns a #GOptionGroup for the commandline arguments recognized
573 * by GTK+ and GDK. You should add this group to your #GOptionContext
574 * with g_option_context_add_group(), if you are using
575 * g_option_context_parse() to parse your commandline arguments.
577 * Returns a #GOptionGroup for the commandline arguments recognized
583 gtk_get_option_group (gboolean open_default_display)
586 OptionGroupInfo *info;
588 gettext_initialization ();
590 info = g_new0 (OptionGroupInfo, 1);
591 info->open_default_display = open_default_display;
593 group = g_option_group_new ("gtk", _("GTK+ Options"), _("Show GTK+ Options"), info, g_free);
594 g_option_group_set_parse_hooks (group, pre_parse_hook, post_parse_hook);
596 gdk_add_option_entries_libgtk_only (group);
597 g_option_group_add_entries (group, gtk_args);
598 g_option_group_set_translation_domain (group, GETTEXT_PACKAGE);
604 * gtk_init_with_args:
605 * @argc: a pointer to the number of command line arguments.
606 * @argv: a pointer to the array of command line arguments.
607 * @parameter_string: a string which is displayed in
608 * the first line of <option>--help</option> output, after
609 * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
610 * @entries: a %NULL-terminated array of #GOptionEntry<!-- -->s
611 * describing the options of your program
612 * @translation_domain: a translation domain to use for translating
613 * the <option>--help</option> output for the options in @entries
614 * with gettext(), or %NULL
615 * @error: a return location for errors
617 * This function does the same work as gtk_init_check().
618 * Additionally, it allows you to add your own commandline options,
619 * and it automatically generates nicely formatted
620 * <option>--help</option> output. Note that your program will
621 * be terminated after writing out the help output.
623 * Returns: %TRUE if the GUI has been successfully initialized,
629 gtk_init_with_args (int *argc,
631 char *parameter_string,
632 GOptionEntry *entries,
633 char *translation_domain,
636 GOptionContext *context;
637 GOptionGroup *gtk_group;
643 gettext_initialization ();
645 if (!check_setugid ())
648 gtk_group = gtk_get_option_group (TRUE);
650 context = g_option_context_new (parameter_string);
651 g_option_context_add_group (context, gtk_group);
654 g_option_context_add_main_entries (context, entries, translation_domain);
655 retval = g_option_context_parse (context, argc, argv, error);
657 g_option_context_free (context);
665 * @argc: a pointer to the number of command line arguments.
666 * @argv: a pointer to the array of command line arguments.
668 * Parses command line arguments, and initializes global
669 * attributes of GTK+, but does not actually open a connection
670 * to a display. (See gdk_display_open(), gdk_get_display_arg_name())
672 * Any arguments used by GTK+ or GDK are removed from the array and
673 * @argc and @argv are updated accordingly.
675 * You shouldn't call this function explicitely if you are using
676 * gtk_init(), or gtk_init_check().
678 * Return value: %TRUE if initialization succeeded, otherwise %FALSE.
681 gtk_parse_args (int *argc,
684 GOptionContext *option_context;
685 GOptionGroup *gtk_group;
686 GError *error = NULL;
691 gettext_initialization ();
693 if (!check_setugid ())
696 option_context = g_option_context_new (NULL);
697 g_option_context_set_ignore_unknown_options (option_context, TRUE);
698 g_option_context_set_help_enabled (option_context, FALSE);
699 gtk_group = gtk_get_option_group (FALSE);
700 g_option_context_set_main_group (option_context, gtk_group);
701 if (!g_option_context_parse (option_context, argc, argv, &error))
703 g_warning ("%s", error->message);
704 g_error_free (error);
707 g_option_context_free (option_context);
712 #ifdef G_PLATFORM_WIN32
713 #undef gtk_init_check
718 * @argc: Address of the <parameter>argc</parameter> parameter of your
719 * main() function. Changed if any arguments were handled.
720 * @argv: Address of the <parameter>argv</parameter> parameter of main().
721 * Any parameters understood by gtk_init() are stripped before return.
723 * This function does the same work as gtk_init() with only
724 * a single change: It does not terminate the program if the GUI can't be
725 * initialized. Instead it returns %FALSE on failure.
727 * This way the application can fall back to some other means of communication
728 * with the user - for example a curses or command line interface.
730 * Return value: %TRUE if the GUI has been successfully initialized,
734 gtk_init_check (int *argc,
737 if (!gtk_parse_args (argc, argv))
740 return gdk_display_open_default_libgtk_only () != NULL;
743 #ifdef G_PLATFORM_WIN32
749 * @argc: Address of the <parameter>argc</parameter> parameter of your
750 * main() function. Changed if any arguments were handled.
751 * @argv: Address of the <parameter>argv</parameter> parameter of main().
752 * Any parameters understood by gtk_init() are stripped before return.
754 * Call this function before using any other GTK+ functions in your GUI
755 * applications. It will initialize everything needed to operate the
756 * toolkit and parses some standard command line options. @argc and
757 * @argv are adjusted accordingly so your own code will
758 * never see those standard arguments.
760 * Note that there are some alternative ways to initialize GTK+:
761 * if you are calling gtk_parse_args(), gtk_init_check(),
762 * gtk_init_with_args() or g_option_context_parse() with
763 * the option group returned by gtk_get_option_group(), you
764 * <emphasis>don't</emphasis> have to call gtk_init().
767 * This function will terminate your program if it was unable to initialize
768 * the GUI for some reason. If you want your program to fall back to a
769 * textual interface you want to call gtk_init_check() instead.
773 gtk_init (int *argc, char ***argv)
775 if (!gtk_init_check (argc, argv))
777 const char *display_name_arg = gdk_get_display_arg_name ();
778 g_warning ("cannot open display: %s", display_name_arg ? display_name_arg : " ");
783 #ifdef G_PLATFORM_WIN32
786 check_sizeof_GtkWindow (size_t sizeof_GtkWindow)
788 if (sizeof_GtkWindow != sizeof (GtkWindow))
789 g_error ("Incompatible build!\n"
790 "The code using GTK+ thinks GtkWindow is of different\n"
791 "size than it actually is in this build of GTK+.\n"
792 "On Windows, this probably means that you have compiled\n"
793 "your code with gcc without the -mms-bitfields switch,\n"
794 "or that you are using an unsupported compiler.");
797 /* In GTK+ 2.0 the GtkWindow struct actually is the same size in
798 * gcc-compiled code on Win32 whether compiled with -fnative-struct or
799 * not. Unfortunately this wan't noticed until after GTK+ 2.0.1. So,
800 * from GTK+ 2.0.2 on, check some other struct, too, where the use of
801 * -fnative-struct still matters. GtkBox is one such.
804 check_sizeof_GtkBox (size_t sizeof_GtkBox)
806 if (sizeof_GtkBox != sizeof (GtkBox))
807 g_error ("Incompatible build!\n"
808 "The code using GTK+ thinks GtkBox is of different\n"
809 "size than it actually is in this build of GTK+.\n"
810 "On Windows, this probably means that you have compiled\n"
811 "your code with gcc without the -mms-bitfields switch,\n"
812 "or that you are using an unsupported compiler.");
815 /* These two functions might get more checks added later, thus pass
816 * in the number of extra args.
819 gtk_init_abi_check (int *argc, char ***argv, int num_checks, size_t sizeof_GtkWindow, size_t sizeof_GtkBox)
821 check_sizeof_GtkWindow (sizeof_GtkWindow);
823 check_sizeof_GtkBox (sizeof_GtkBox);
824 gtk_init (argc, argv);
828 gtk_init_check_abi_check (int *argc, char ***argv, int num_checks, size_t sizeof_GtkWindow, size_t sizeof_GtkBox)
830 check_sizeof_GtkWindow (sizeof_GtkWindow);
832 check_sizeof_GtkBox (sizeof_GtkBox);
833 return gtk_init_check (argc, argv);
839 gtk_exit (gint errorcode)
848 * Initializes internationalization support for GTK+. gtk_init()
849 * automatically does this, so there is typically no point
850 * in calling this function.
852 * If you are calling this function because you changed the locale
853 * after GTK+ is was initialized, then calling this function
854 * may help a bit. (Note, however, that changing the locale
855 * after GTK+ is initialized may produce inconsistent results and
856 * is not really supported.)
858 * In detail - sets the current locale according to the
859 * program environment. This is the same as calling the C library function
860 * <literal>setlocale (LC_ALL, "")</literal> but also takes care of the
861 * locale specific setup of the windowing system used by GDK.
863 * Returns: a string corresponding to the locale set, typically in the
864 * form lang_COUNTRY, where lang is an ISO-639 language code, and
865 * COUNTRY is an ISO-3166 country code. On Unix, this form matches the
866 * result of the setlocale(); it is also used on other machines, such as
867 * Windows, where the C library returns a different result. The string is
868 * owned by GTK+ and should not be modified or freed.
871 gtk_set_locale (void)
873 return gdk_set_locale ();
879 * Return the Unix-style locale string for the language currently in
880 * effect. On Unix systems, this is the return value from
881 * <literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
882 * affect this through the environment variables LC_ALL, LC_CTYPE or
883 * LANG (checked in that order). The locale strings typically is in
884 * the form lang_COUNTRY, where lang is an ISO-639 language code, and
885 * COUNTRY is an ISO-3166 country code. For instance, sv_FI for
886 * Swedish as written in Finland or pt_BR for Portuguese as written in
889 * On Windows, the C library doesn't use any such environment
890 * variables, and setting them won't affect the behaviour of functions
891 * like ctime(). The user sets the locale through the Regional Options
892 * in the Control Panel. The C library (in the setlocale() function)
893 * does not use country and language codes, but country and language
894 * names spelled out in English.
895 * However, this function does check the above environment
896 * variables, and does return a Unix-style locale string based on
897 * either said environment variables or the thread's current locale.
899 * Return value: a dynamically allocated string, free with g_free().
903 _gtk_get_lc_ctype (void)
906 /* Somebody might try to set the locale for this process using the
907 * LANG or LC_ environment variables. The Microsoft C library
908 * doesn't know anything about them. You set the locale in the
909 * Control Panel. Setting these env vars won't have any affect on
910 * locale-dependent C library functions like ctime(). But just for
911 * kicks, do obey LC_ALL, LC_CTYPE and LANG in GTK. (This also makes
912 * it easier to test GTK and Pango in various default languages, you
913 * don't have to clickety-click in the Control Panel, you can simply
914 * start the program with LC_ALL=something on the command line.)
918 p = getenv ("LC_ALL");
922 p = getenv ("LC_CTYPE");
930 return g_win32_getlocale ();
932 return g_strdup (setlocale (LC_CTYPE, NULL));
937 * gtk_get_default_language:
939 * Returns the #PangoLanguage for the default language currently in
940 * effect. (Note that this can change over the life of an
941 * application.) The default language is derived from the current
942 * locale. It determines, for example, whether GTK+ uses the
943 * right-to-left or left-to-right text direction. See
944 * _gtk_get_lc_ctype() for notes on behaviour on Windows.
946 * Return value: the default language as a #PangoLanguage, must not be
950 gtk_get_default_language (void)
953 PangoLanguage *result;
956 lang = _gtk_get_lc_ctype ();
957 p = strchr (lang, '.');
960 p = strchr (lang, '@');
964 result = pango_language_from_string (lang);
975 GtkInitFunction *init;
978 gtk_main_loop_level++;
980 loop = g_main_loop_new (NULL, TRUE);
981 main_loops = g_slist_prepend (main_loops, loop);
983 tmp_list = functions = init_functions;
984 init_functions = NULL;
988 init = tmp_list->data;
989 tmp_list = tmp_list->next;
991 (* init->function) (init->data);
994 g_list_free (functions);
996 if (g_main_loop_is_running (main_loops->data))
998 GDK_THREADS_LEAVE ();
999 g_main_loop_run (loop);
1000 GDK_THREADS_ENTER ();
1006 GList *reinvoke_list = NULL;
1007 GtkQuitFunction *quitf;
1009 while (quit_functions)
1011 quitf = quit_functions->data;
1013 tmp_list = quit_functions;
1014 quit_functions = g_list_remove_link (quit_functions, quit_functions);
1015 g_list_free_1 (tmp_list);
1017 if ((quitf->main_level && quitf->main_level != gtk_main_loop_level) ||
1018 gtk_quit_invoke_function (quitf))
1020 reinvoke_list = g_list_prepend (reinvoke_list, quitf);
1024 gtk_quit_destroy (quitf);
1031 work = g_list_last (reinvoke_list);
1033 quit_functions->prev = work;
1034 work->next = quit_functions;
1035 quit_functions = work;
1041 main_loops = g_slist_remove (main_loops, loop);
1043 g_main_loop_unref (loop);
1045 gtk_main_loop_level--;
1047 /* Try storing all clipboard data we have */
1048 if (gtk_main_loop_level == 0)
1049 _gtk_clipboard_store_all ();
1053 gtk_main_level (void)
1055 return gtk_main_loop_level;
1059 gtk_main_quit (void)
1061 g_return_if_fail (main_loops != NULL);
1063 g_main_loop_quit (main_loops->data);
1067 gtk_events_pending (void)
1071 GDK_THREADS_LEAVE ();
1072 result = g_main_context_pending (NULL);
1073 GDK_THREADS_ENTER ();
1079 gtk_main_iteration (void)
1081 GDK_THREADS_LEAVE ();
1082 g_main_context_iteration (NULL, TRUE);
1083 GDK_THREADS_ENTER ();
1086 return !g_main_loop_is_running (main_loops->data);
1092 gtk_main_iteration_do (gboolean blocking)
1094 GDK_THREADS_LEAVE ();
1095 g_main_context_iteration (NULL, blocking);
1096 GDK_THREADS_ENTER ();
1099 return !g_main_loop_is_running (main_loops->data);
1104 /* private libgtk to libgdk interfaces
1106 gboolean gdk_pointer_grab_info_libgtk_only (GdkDisplay *display,
1107 GdkWindow **grab_window,
1108 gboolean *owner_events);
1109 gboolean gdk_keyboard_grab_info_libgtk_only (GdkDisplay *display,
1110 GdkWindow **grab_window,
1111 gboolean *owner_events);
1114 rewrite_events_translate (GdkWindow *old_window,
1115 GdkWindow *new_window,
1119 gint old_origin_x, old_origin_y;
1120 gint new_origin_x, new_origin_y;
1122 gdk_window_get_origin (old_window, &old_origin_x, &old_origin_y);
1123 gdk_window_get_origin (new_window, &new_origin_x, &new_origin_y);
1125 *x += old_origin_x - new_origin_x;
1126 *y += old_origin_y - new_origin_y;
1130 rewrite_event_for_window (GdkEvent *event,
1131 GdkWindow *new_window)
1133 event = gdk_event_copy (event);
1135 switch (event->type)
1138 rewrite_events_translate (event->any.window,
1140 &event->scroll.x, &event->scroll.y);
1142 case GDK_BUTTON_PRESS:
1143 case GDK_2BUTTON_PRESS:
1144 case GDK_3BUTTON_PRESS:
1145 case GDK_BUTTON_RELEASE:
1146 rewrite_events_translate (event->any.window,
1148 &event->button.x, &event->button.y);
1150 case GDK_MOTION_NOTIFY:
1151 rewrite_events_translate (event->any.window,
1153 &event->motion.x, &event->motion.y);
1156 case GDK_KEY_RELEASE:
1157 case GDK_PROXIMITY_IN:
1158 case GDK_PROXIMITY_OUT:
1165 g_object_unref (event->any.window);
1166 event->any.window = g_object_ref (new_window);
1171 /* If there is a pointer or keyboard grab in effect with owner_events = TRUE,
1172 * then what X11 does is deliver the event normally if it was going to this
1173 * client, otherwise, delivers it in terms of the grab window. This function
1174 * rewrites events to the effect that events going to the same window group
1175 * are delivered normally, otherwise, the event is delivered in terms of the
1179 rewrite_event_for_grabs (GdkEvent *event)
1181 GdkWindow *grab_window;
1182 GtkWidget *event_widget, *grab_widget;
1183 gboolean owner_events;
1184 GdkDisplay *display;
1186 switch (event->type)
1189 case GDK_BUTTON_PRESS:
1190 case GDK_2BUTTON_PRESS:
1191 case GDK_3BUTTON_PRESS:
1192 case GDK_BUTTON_RELEASE:
1193 case GDK_MOTION_NOTIFY:
1194 case GDK_PROXIMITY_IN:
1195 case GDK_PROXIMITY_OUT:
1196 display = gdk_drawable_get_display (event->proximity.window);
1197 if (!gdk_pointer_grab_info_libgtk_only (display, &grab_window, &owner_events) ||
1203 case GDK_KEY_RELEASE:
1204 display = gdk_drawable_get_display (event->key.window);
1205 if (!gdk_keyboard_grab_info_libgtk_only (display, &grab_window, &owner_events) ||
1214 event_widget = gtk_get_event_widget (event);
1215 gdk_window_get_user_data (grab_window, (void**) &grab_widget);
1218 gtk_main_get_window_group (grab_widget) != gtk_main_get_window_group (event_widget))
1219 return rewrite_event_for_window (event, grab_window);
1225 gtk_main_do_event (GdkEvent *event)
1227 GtkWidget *event_widget;
1228 GtkWidget *grab_widget;
1229 GtkWindowGroup *window_group;
1230 GdkEvent *next_event;
1231 GdkEvent *rewritten_event = NULL;
1234 /* If there are any events pending then get the next one.
1236 next_event = gdk_event_peek ();
1238 /* Try to compress enter/leave notify events. These event
1239 * pairs occur when the mouse is dragged quickly across
1240 * a window with many buttons (or through a menu). Instead
1241 * of highlighting and de-highlighting each widget that
1242 * is crossed it is better to simply de-highlight the widget
1243 * which contained the mouse initially and highlight the
1244 * widget which ends up containing the mouse.
1247 if (((event->type == GDK_ENTER_NOTIFY) ||
1248 (event->type == GDK_LEAVE_NOTIFY)) &&
1249 ((next_event->type == GDK_ENTER_NOTIFY) ||
1250 (next_event->type == GDK_LEAVE_NOTIFY)) &&
1251 (next_event->type != event->type) &&
1252 (next_event->any.window == event->any.window))
1254 /* Throw both the peeked copy and the queued copy away
1256 gdk_event_free (next_event);
1257 next_event = gdk_event_get ();
1258 gdk_event_free (next_event);
1264 gdk_event_free (next_event);
1266 if (event->type == GDK_SETTING)
1268 _gtk_settings_handle_event (&event->setting);
1272 if (event->type == GDK_OWNER_CHANGE)
1274 _gtk_clipboard_handle_event (&event->owner_change);
1278 /* Find the widget which got the event. We store the widget
1279 * in the user_data field of GdkWindow's.
1280 * Ignore the event if we don't have a widget for it, except
1281 * for GDK_PROPERTY_NOTIFY events which are handled specialy.
1282 * Though this happens rarely, bogus events can occour
1283 * for e.g. destroyed GdkWindows.
1285 event_widget = gtk_get_event_widget (event);
1288 /* To handle selection INCR transactions, we select
1289 * PropertyNotify events on the requestor window and create
1290 * a corresponding (fake) GdkWindow so that events get
1291 * here. There won't be a widget though, so we have to handle
1294 if (event->type == GDK_PROPERTY_NOTIFY)
1295 _gtk_selection_incr_event (event->any.window,
1301 /* If pointer or keyboard grabs are in effect, munge the events
1302 * so that each window group looks like a separate app.
1304 rewritten_event = rewrite_event_for_grabs (event);
1305 if (rewritten_event)
1307 event = rewritten_event;
1308 event_widget = gtk_get_event_widget (event);
1311 window_group = gtk_main_get_window_group (event_widget);
1313 /* Push the event onto a stack of current events for
1314 * gtk_current_event_get().
1316 current_events = g_list_prepend (current_events, event);
1318 /* If there is a grab in effect...
1320 if (window_group->grabs)
1322 grab_widget = window_group->grabs->data;
1324 /* If the grab widget is an ancestor of the event widget
1325 * then we send the event to the original event widget.
1326 * This is the key to implementing modality.
1328 if (GTK_WIDGET_IS_SENSITIVE (event_widget) &&
1329 gtk_widget_is_ancestor (event_widget, grab_widget))
1330 grab_widget = event_widget;
1334 grab_widget = event_widget;
1337 /* Not all events get sent to the grabbing widget.
1338 * The delete, destroy, expose, focus change and resize
1339 * events still get sent to the event widget because
1340 * 1) these events have no meaning for the grabbing widget
1341 * and 2) redirecting these events to the grabbing widget
1342 * could cause the display to be messed up.
1344 * Drag events are also not redirected, since it isn't
1345 * clear what the semantics of that would be.
1347 switch (event->type)
1353 g_object_ref (event_widget);
1354 if ((!window_group->grabs || gtk_widget_get_toplevel (window_group->grabs->data) == event_widget) &&
1355 !gtk_widget_event (event_widget, event))
1356 gtk_widget_destroy (event_widget);
1357 g_object_unref (event_widget);
1361 /* Unexpected GDK_DESTROY from the outside, ignore for
1362 * child windows, handle like a GDK_DELETE for toplevels
1364 if (!event_widget->parent)
1366 g_object_ref (event_widget);
1367 if (!gtk_widget_event (event_widget, event) &&
1368 GTK_WIDGET_REALIZED (event_widget))
1369 gtk_widget_destroy (event_widget);
1370 g_object_unref (event_widget);
1375 if (event->any.window && GTK_WIDGET_DOUBLE_BUFFERED (event_widget))
1377 gdk_window_begin_paint_region (event->any.window, event->expose.region);
1378 gtk_widget_send_expose (event_widget, event);
1379 gdk_window_end_paint (event->any.window);
1382 gtk_widget_send_expose (event_widget, event);
1385 case GDK_PROPERTY_NOTIFY:
1387 case GDK_FOCUS_CHANGE:
1391 case GDK_SELECTION_CLEAR:
1392 case GDK_SELECTION_REQUEST:
1393 case GDK_SELECTION_NOTIFY:
1394 case GDK_CLIENT_EVENT:
1395 case GDK_VISIBILITY_NOTIFY:
1396 case GDK_WINDOW_STATE:
1397 case GDK_GRAB_BROKEN:
1398 gtk_widget_event (event_widget, event);
1402 case GDK_BUTTON_PRESS:
1403 case GDK_2BUTTON_PRESS:
1404 case GDK_3BUTTON_PRESS:
1405 gtk_propagate_event (grab_widget, event);
1409 case GDK_KEY_RELEASE:
1412 if (gtk_invoke_key_snoopers (grab_widget, event))
1415 /* else fall through */
1416 case GDK_MOTION_NOTIFY:
1417 case GDK_BUTTON_RELEASE:
1418 case GDK_PROXIMITY_IN:
1419 case GDK_PROXIMITY_OUT:
1420 gtk_propagate_event (grab_widget, event);
1423 case GDK_ENTER_NOTIFY:
1424 if (GTK_WIDGET_IS_SENSITIVE (grab_widget))
1426 g_object_ref (event_widget);
1428 gtk_widget_event (grab_widget, event);
1429 if (event_widget == grab_widget)
1430 GTK_PRIVATE_SET_FLAG (event_widget, GTK_LEAVE_PENDING);
1432 g_object_unref (event_widget);
1436 case GDK_LEAVE_NOTIFY:
1437 if (GTK_WIDGET_LEAVE_PENDING (event_widget))
1439 GTK_PRIVATE_UNSET_FLAG (event_widget, GTK_LEAVE_PENDING);
1440 gtk_widget_event (event_widget, event);
1442 else if (GTK_WIDGET_IS_SENSITIVE (grab_widget))
1443 gtk_widget_event (grab_widget, event);
1446 case GDK_DRAG_STATUS:
1447 case GDK_DROP_FINISHED:
1448 _gtk_drag_source_handle_event (event_widget, event);
1450 case GDK_DRAG_ENTER:
1451 case GDK_DRAG_LEAVE:
1452 case GDK_DRAG_MOTION:
1453 case GDK_DROP_START:
1454 _gtk_drag_dest_handle_event (event_widget, event);
1457 g_assert_not_reached ();
1461 tmp_list = current_events;
1462 current_events = g_list_remove_link (current_events, tmp_list);
1463 g_list_free_1 (tmp_list);
1465 if (rewritten_event)
1466 gdk_event_free (rewritten_event);
1481 static GtkWindowGroup *
1482 gtk_main_get_window_group (GtkWidget *widget)
1484 GtkWidget *toplevel = NULL;
1487 toplevel = gtk_widget_get_toplevel (widget);
1489 if (toplevel && GTK_IS_WINDOW (toplevel))
1490 return gtk_window_get_group (GTK_WINDOW (toplevel));
1492 return gtk_window_get_group (NULL);
1497 GtkWidget *old_grab_widget;
1498 GtkWidget *new_grab_widget;
1499 gboolean was_grabbed;
1500 gboolean is_grabbed;
1504 gtk_grab_notify_foreach (GtkWidget *child,
1508 GrabNotifyInfo *info = data;
1510 gboolean was_grabbed, is_grabbed, was_shadowed, is_shadowed;
1512 was_grabbed = info->was_grabbed;
1513 is_grabbed = info->is_grabbed;
1515 info->was_grabbed = info->was_grabbed || (child == info->old_grab_widget);
1516 info->is_grabbed = info->is_grabbed || (child == info->new_grab_widget);
1518 was_shadowed = info->old_grab_widget && !info->was_grabbed;
1519 is_shadowed = info->new_grab_widget && !info->is_grabbed;
1521 g_object_ref (child);
1523 if (was_shadowed != is_shadowed)
1524 _gtk_widget_grab_notify (child, was_shadowed);
1526 if ((was_shadowed || is_shadowed) && GTK_IS_CONTAINER (child))
1527 gtk_container_forall (GTK_CONTAINER (child), gtk_grab_notify_foreach, info);
1529 g_object_unref (child);
1531 info->was_grabbed = was_grabbed;
1532 info->is_grabbed = is_grabbed;
1536 gtk_grab_notify (GtkWindowGroup *group,
1537 GtkWidget *old_grab_widget,
1538 GtkWidget *new_grab_widget)
1541 GrabNotifyInfo info;
1543 if (old_grab_widget == new_grab_widget)
1546 info.old_grab_widget = old_grab_widget;
1547 info.new_grab_widget = new_grab_widget;
1549 g_object_ref (group);
1551 toplevels = gtk_window_list_toplevels ();
1552 g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
1556 GtkWindow *toplevel = toplevels->data;
1557 toplevels = g_list_delete_link (toplevels, toplevels);
1559 info.was_grabbed = FALSE;
1560 info.is_grabbed = FALSE;
1562 if (group == gtk_window_get_group (toplevel))
1563 gtk_grab_notify_foreach (GTK_WIDGET (toplevel), &info);
1564 g_object_unref (toplevel);
1567 g_object_unref (group);
1571 gtk_grab_add (GtkWidget *widget)
1573 GtkWindowGroup *group;
1574 GtkWidget *old_grab_widget;
1576 g_return_if_fail (widget != NULL);
1578 if (!GTK_WIDGET_HAS_GRAB (widget) && GTK_WIDGET_IS_SENSITIVE (widget))
1580 GTK_WIDGET_SET_FLAGS (widget, GTK_HAS_GRAB);
1582 group = gtk_main_get_window_group (widget);
1585 old_grab_widget = (GtkWidget *)group->grabs->data;
1587 old_grab_widget = NULL;
1589 g_object_ref (widget);
1590 group->grabs = g_slist_prepend (group->grabs, widget);
1592 gtk_grab_notify (group, old_grab_widget, widget);
1597 gtk_grab_get_current (void)
1599 GtkWindowGroup *group;
1601 group = gtk_main_get_window_group (NULL);
1604 return GTK_WIDGET (group->grabs->data);
1609 gtk_grab_remove (GtkWidget *widget)
1611 GtkWindowGroup *group;
1612 GtkWidget *new_grab_widget;
1614 g_return_if_fail (widget != NULL);
1616 if (GTK_WIDGET_HAS_GRAB (widget))
1618 GTK_WIDGET_UNSET_FLAGS (widget, GTK_HAS_GRAB);
1620 group = gtk_main_get_window_group (widget);
1621 group->grabs = g_slist_remove (group->grabs, widget);
1624 new_grab_widget = (GtkWidget *)group->grabs->data;
1626 new_grab_widget = NULL;
1628 gtk_grab_notify (group, widget, new_grab_widget);
1630 g_object_unref (widget);
1635 gtk_init_add (GtkFunction function,
1638 GtkInitFunction *init;
1640 init = g_new (GtkInitFunction, 1);
1641 init->function = function;
1644 init_functions = g_list_prepend (init_functions, init);
1648 gtk_key_snooper_install (GtkKeySnoopFunc snooper,
1651 GtkKeySnooperData *data;
1652 static guint snooper_id = 1;
1654 g_return_val_if_fail (snooper != NULL, 0);
1656 data = g_new (GtkKeySnooperData, 1);
1657 data->func = snooper;
1658 data->func_data = func_data;
1659 data->id = snooper_id++;
1660 key_snoopers = g_slist_prepend (key_snoopers, data);
1666 gtk_key_snooper_remove (guint snooper_id)
1668 GtkKeySnooperData *data = NULL;
1671 slist = key_snoopers;
1675 if (data->id == snooper_id)
1678 slist = slist->next;
1683 key_snoopers = g_slist_remove (key_snoopers, data);
1689 gtk_invoke_key_snoopers (GtkWidget *grab_widget,
1693 gint return_val = FALSE;
1695 slist = key_snoopers;
1696 while (slist && !return_val)
1698 GtkKeySnooperData *data;
1701 slist = slist->next;
1702 return_val = (*data->func) (grab_widget, (GdkEventKey*) event, data->func_data);
1709 gtk_quit_add_full (guint main_level,
1710 GtkFunction function,
1711 GtkCallbackMarshal marshal,
1713 GtkDestroyNotify destroy)
1715 static guint quit_id = 1;
1716 GtkQuitFunction *quitf;
1718 g_return_val_if_fail ((function != NULL) || (marshal != NULL), 0);
1720 quitf = g_slice_new (GtkQuitFunction);
1722 quitf->id = quit_id++;
1723 quitf->main_level = main_level;
1724 quitf->function = function;
1725 quitf->marshal = marshal;
1727 quitf->destroy = destroy;
1729 quit_functions = g_list_prepend (quit_functions, quitf);
1735 gtk_quit_destroy (GtkQuitFunction *quitf)
1738 quitf->destroy (quitf->data);
1739 g_slice_free (GtkQuitFunction, quitf);
1743 gtk_quit_destructor (GtkObject **object_p)
1746 gtk_object_destroy (*object_p);
1753 gtk_quit_add_destroy (guint main_level,
1756 GtkObject **object_p;
1758 g_return_if_fail (main_level > 0);
1759 g_return_if_fail (GTK_IS_OBJECT (object));
1761 object_p = g_new (GtkObject*, 1);
1763 g_signal_connect (object,
1765 G_CALLBACK (gtk_widget_destroyed),
1767 gtk_quit_add (main_level, (GtkFunction) gtk_quit_destructor, object_p);
1771 gtk_quit_add (guint main_level,
1772 GtkFunction function,
1775 return gtk_quit_add_full (main_level, function, NULL, data, NULL);
1779 gtk_quit_remove (guint id)
1781 GtkQuitFunction *quitf;
1784 tmp_list = quit_functions;
1787 quitf = tmp_list->data;
1789 if (quitf->id == id)
1791 quit_functions = g_list_remove_link (quit_functions, tmp_list);
1792 g_list_free (tmp_list);
1793 gtk_quit_destroy (quitf);
1798 tmp_list = tmp_list->next;
1803 gtk_quit_remove_by_data (gpointer data)
1805 GtkQuitFunction *quitf;
1808 tmp_list = quit_functions;
1811 quitf = tmp_list->data;
1813 if (quitf->data == data)
1815 quit_functions = g_list_remove_link (quit_functions, tmp_list);
1816 g_list_free (tmp_list);
1817 gtk_quit_destroy (quitf);
1822 tmp_list = tmp_list->next;
1827 gtk_timeout_add_full (guint32 interval,
1828 GtkFunction function,
1829 GtkCallbackMarshal marshal,
1831 GtkDestroyNotify destroy)
1835 GtkClosure *closure;
1837 closure = g_new (GtkClosure, 1);
1838 closure->marshal = marshal;
1839 closure->data = data;
1840 closure->destroy = destroy;
1842 return g_timeout_add_full (0, interval,
1843 gtk_invoke_idle_timeout,
1845 gtk_destroy_closure);
1848 return g_timeout_add_full (0, interval, function, data, destroy);
1852 gtk_timeout_add (guint32 interval,
1853 GtkFunction function,
1856 return g_timeout_add_full (0, interval, function, data, NULL);
1860 gtk_timeout_remove (guint tag)
1862 g_source_remove (tag);
1866 gtk_idle_add_full (gint priority,
1867 GtkFunction function,
1868 GtkCallbackMarshal marshal,
1870 GtkDestroyNotify destroy)
1874 GtkClosure *closure;
1876 closure = g_new (GtkClosure, 1);
1877 closure->marshal = marshal;
1878 closure->data = data;
1879 closure->destroy = destroy;
1881 return g_idle_add_full (priority,
1882 gtk_invoke_idle_timeout,
1884 gtk_destroy_closure);
1887 return g_idle_add_full (priority, function, data, destroy);
1891 gtk_idle_add (GtkFunction function,
1894 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
1898 gtk_idle_add_priority (gint priority,
1899 GtkFunction function,
1902 return g_idle_add_full (priority, function, data, NULL);
1906 gtk_idle_remove (guint tag)
1908 g_source_remove (tag);
1912 gtk_idle_remove_by_data (gpointer data)
1914 if (!g_idle_remove_by_data (data))
1915 g_warning ("gtk_idle_remove_by_data(%p): no such idle", data);
1919 gtk_input_add_full (gint source,
1920 GdkInputCondition condition,
1921 GdkInputFunction function,
1922 GtkCallbackMarshal marshal,
1924 GtkDestroyNotify destroy)
1928 GtkClosure *closure;
1930 closure = g_new (GtkClosure, 1);
1931 closure->marshal = marshal;
1932 closure->data = data;
1933 closure->destroy = destroy;
1935 return gdk_input_add_full (source,
1937 (GdkInputFunction) gtk_invoke_input,
1939 (GdkDestroyNotify) gtk_destroy_closure);
1942 return gdk_input_add_full (source, condition, function, data, destroy);
1946 gtk_input_remove (guint tag)
1948 g_source_remove (tag);
1952 gtk_destroy_closure (gpointer data)
1954 GtkClosure *closure = data;
1956 if (closure->destroy)
1957 (closure->destroy) (closure->data);
1962 gtk_invoke_idle_timeout (gpointer data)
1964 GtkClosure *closure = data;
1967 gint ret_val = FALSE;
1968 args[0].name = NULL;
1969 args[0].type = G_TYPE_BOOLEAN;
1970 args[0].d.pointer_data = &ret_val;
1971 closure->marshal (NULL, closure->data, 0, args);
1976 gtk_invoke_input (gpointer data,
1978 GdkInputCondition condition)
1980 GtkClosure *closure = data;
1983 args[0].type = G_TYPE_INT;
1984 args[0].name = NULL;
1985 GTK_VALUE_INT (args[0]) = source;
1986 args[1].type = GDK_TYPE_INPUT_CONDITION;
1987 args[1].name = NULL;
1988 GTK_VALUE_FLAGS (args[1]) = condition;
1989 args[2].type = G_TYPE_NONE;
1990 args[2].name = NULL;
1992 closure->marshal (NULL, closure->data, 2, args);
1996 * gtk_get_current_event:
1998 * Obtains a copy of the event currently being processed by GTK+. For
1999 * example, if you get a "clicked" signal from #GtkButton, the current
2000 * event will be the #GdkEventButton that triggered the "clicked"
2001 * signal. The returned event must be freed with gdk_event_free().
2002 * If there is no current event, the function returns %NULL.
2004 * Return value: a copy of the current event, or %NULL if no current event.
2007 gtk_get_current_event (void)
2010 return gdk_event_copy (current_events->data);
2016 * gtk_get_current_event_time:
2018 * If there is a current event and it has a timestamp, return that
2019 * timestamp, otherwise return %GDK_CURRENT_TIME.
2021 * Return value: the timestamp from the current event, or %GDK_CURRENT_TIME.
2024 gtk_get_current_event_time (void)
2027 return gdk_event_get_time (current_events->data);
2029 return GDK_CURRENT_TIME;
2033 * gtk_get_current_event_state:
2034 * @state: a location to store the state of the current event
2036 * If there is a current event and it has a state field, place
2037 * that state field in @state and return %TRUE, otherwise return
2040 * Return value: %TRUE if there was a current event and it had a state field
2043 gtk_get_current_event_state (GdkModifierType *state)
2045 g_return_val_if_fail (state != NULL, FALSE);
2048 return gdk_event_get_state (current_events->data, state);
2057 * gtk_get_event_widget:
2058 * @event: a #GdkEvent
2060 * If @event is %NULL or the event was not associated with any widget,
2061 * returns %NULL, otherwise returns the widget that received the event
2064 * Return value: the widget that originally received @event, or %NULL
2067 gtk_get_event_widget (GdkEvent *event)
2072 if (event && event->any.window &&
2073 (event->type == GDK_DESTROY || !GDK_WINDOW_DESTROYED (event->any.window)))
2074 gdk_window_get_user_data (event->any.window, (void**) &widget);
2080 gtk_quit_invoke_function (GtkQuitFunction *quitf)
2082 if (!quitf->marshal)
2083 return quitf->function (quitf->data);
2087 gint ret_val = FALSE;
2089 args[0].name = NULL;
2090 args[0].type = G_TYPE_BOOLEAN;
2091 args[0].d.pointer_data = &ret_val;
2092 ((GtkCallbackMarshal) quitf->marshal) (NULL,
2100 * gtk_propagate_event:
2101 * @widget: a #GtkWidget
2104 * Sends an event to a widget, propagating the event to parent widgets
2105 * if the event remains unhandled. Events received by GTK+ from GDK
2106 * normally begin in gtk_main_do_event(). Depending on the type of
2107 * event, existence of modal dialogs, grabs, etc., the event may be
2108 * propagated; if so, this function is used. gtk_propagate_event()
2109 * calls gtk_widget_event() on each widget it decides to send the
2110 * event to. So gtk_widget_event() is the lowest-level function; it
2111 * simply emits the "event" and possibly an event-specific signal on a
2112 * widget. gtk_propagate_event() is a bit higher-level, and
2113 * gtk_main_do_event() is the highest level.
2115 * All that said, you most likely don't want to use any of these
2116 * functions; synthesizing events is rarely needed. Consider asking on
2117 * the mailing list for better ways to achieve your goals. For
2118 * example, use gdk_window_invalidate_rect() or
2119 * gtk_widget_queue_draw() instead of making up expose events.
2123 gtk_propagate_event (GtkWidget *widget,
2128 g_return_if_fail (GTK_IS_WIDGET (widget));
2129 g_return_if_fail (event != NULL);
2131 handled_event = FALSE;
2133 g_object_ref (widget);
2135 if ((event->type == GDK_KEY_PRESS) ||
2136 (event->type == GDK_KEY_RELEASE))
2138 /* Only send key events within Window widgets to the Window
2139 * The Window widget will in turn pass the
2140 * key event on to the currently focused widget
2145 window = gtk_widget_get_toplevel (widget);
2146 if (window && GTK_IS_WINDOW (window))
2148 /* If there is a grab within the window, give the grab widget
2149 * a first crack at the key event
2151 if (widget != window && GTK_WIDGET_HAS_GRAB (widget))
2152 handled_event = gtk_widget_event (widget, event);
2156 window = gtk_widget_get_toplevel (widget);
2157 if (window && GTK_IS_WINDOW (window))
2159 if (GTK_WIDGET_IS_SENSITIVE (window))
2160 gtk_widget_event (window, event);
2164 handled_event = TRUE; /* don't send to widget */
2168 /* Other events get propagated up the widget tree
2169 * so that parents can see the button and motion
2170 * events of the children.
2178 /* Scroll events are special cased here because it
2179 * feels wrong when scrolling a GtkViewport, say,
2180 * to have children of the viewport eat the scroll
2183 if (!GTK_WIDGET_IS_SENSITIVE (widget))
2184 handled_event = event->type != GDK_SCROLL;
2186 handled_event = gtk_widget_event (widget, event);
2188 tmp = widget->parent;
2189 g_object_unref (widget);
2193 if (!handled_event && widget)
2194 g_object_ref (widget);
2200 g_object_unref (widget);
2205 gtk_error (gchar *str)
2211 gtk_warning (gchar *str)
2217 gtk_message (gchar *str)
2223 gtk_print (gchar *str)
2225 static GtkWidget *window = NULL;
2226 static GtkWidget *text;
2227 static int level = 0;
2231 GtkWidget *hscrollbar;
2232 GtkWidget *vscrollbar;
2233 GtkWidget *separator;
2238 fputs (str, stdout);
2245 window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
2247 gtk_signal_connect (GTK_OBJECT (window), "destroy",
2248 (GtkSignalFunc) gtk_widget_destroyed,
2251 gtk_window_set_title (GTK_WINDOW (window), "Messages");
2253 box1 = gtk_vbox_new (FALSE, 0);
2254 gtk_container_add (GTK_CONTAINER (window), box1);
2255 gtk_widget_show (box1);
2258 box2 = gtk_vbox_new (FALSE, 10);
2259 gtk_container_set_border_width (GTK_CONTAINER (box2), 10);
2260 gtk_box_pack_start (GTK_BOX (box1), box2, TRUE, TRUE, 0);
2261 gtk_widget_show (box2);
2264 table = gtk_table_new (2, 2, FALSE);
2265 gtk_table_set_row_spacing (GTK_TABLE (table), 0, 2);
2266 gtk_table_set_col_spacing (GTK_TABLE (table), 0, 2);
2267 gtk_box_pack_start (GTK_BOX (box2), table, TRUE, TRUE, 0);
2268 gtk_widget_show (table);
2270 text = gtk_text_new (NULL, NULL);
2271 gtk_text_set_editable (GTK_TEXT (text), FALSE);
2272 gtk_table_attach_defaults (GTK_TABLE (table), text, 0, 1, 0, 1);
2273 gtk_widget_show (text);
2274 gtk_widget_realize (text);
2276 hscrollbar = gtk_hscrollbar_new (GTK_TEXT (text)->hadj);
2277 gtk_table_attach (GTK_TABLE (table), hscrollbar, 0, 1, 1, 2,
2278 GTK_EXPAND | GTK_FILL, GTK_FILL, 0, 0);
2279 gtk_widget_show (hscrollbar);
2281 vscrollbar = gtk_vscrollbar_new (GTK_TEXT (text)->vadj);
2282 gtk_table_attach (GTK_TABLE (table), vscrollbar, 1, 2, 0, 1,
2283 GTK_FILL, GTK_EXPAND | GTK_FILL, 0, 0);
2284 gtk_widget_show (vscrollbar);
2286 separator = gtk_hseparator_new ();
2287 gtk_box_pack_start (GTK_BOX (box1), separator, FALSE, TRUE, 0);
2288 gtk_widget_show (separator);
2291 box2 = gtk_vbox_new (FALSE, 10);
2292 gtk_container_set_border_width (GTK_CONTAINER (box2), 10);
2293 gtk_box_pack_start (GTK_BOX (box1), box2, FALSE, TRUE, 0);
2294 gtk_widget_show (box2);
2297 button = gtk_button_new_with_label ("close");
2298 gtk_signal_connect_object (GTK_OBJECT (button), "clicked",
2299 (GtkSignalFunc) gtk_widget_hide,
2300 GTK_OBJECT (window));
2301 gtk_box_pack_start (GTK_BOX (box2), button, TRUE, TRUE, 0);
2302 GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
2303 gtk_widget_grab_default (button);
2304 gtk_widget_show (button);
2308 gtk_text_insert (GTK_TEXT (text), NULL, NULL, NULL, str, -1);
2311 if (!GTK_WIDGET_VISIBLE (window))
2312 gtk_widget_show (window);
2317 _gtk_boolean_handled_accumulator (GSignalInvocationHint *ihint,
2318 GValue *return_accu,
2319 const GValue *handler_return,
2322 gboolean continue_emission;
2323 gboolean signal_handled;
2325 signal_handled = g_value_get_boolean (handler_return);
2326 g_value_set_boolean (return_accu, signal_handled);
2327 continue_emission = !signal_handled;
2329 return continue_emission;
2332 #define __GTK_MAIN_C__
2333 #include "gtkaliasdef.c"