1 /* GDK - The GIMP Drawing Kit
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/.
31 #include "gdkinternals.h"
34 #ifndef HAVE_XCONVERTCASE
35 #include "gdkkeysyms.h"
44 * @Short_description: Library initialization and miscellaneous functions
47 * This section describes the GDK initialization functions and miscellaneous
52 typedef struct _GdkPredicate GdkPredicate;
60 typedef struct _GdkThreadsDispatch GdkThreadsDispatch;
62 struct _GdkThreadsDispatch
66 GDestroyNotify destroy;
70 /* Private variable declarations
72 static int gdk_initialized = 0; /* 1 if the library is initialized,
76 static gchar *gdk_progclass = NULL;
78 static GMutex *gdk_threads_mutex = NULL; /* Global GDK lock */
80 static GCallback gdk_threads_lock = NULL;
81 static GCallback gdk_threads_unlock = NULL;
84 static const GDebugKey gdk_debug_keys[] = {
85 {"events", GDK_DEBUG_EVENTS},
86 {"misc", GDK_DEBUG_MISC},
87 {"dnd", GDK_DEBUG_DND},
88 {"xim", GDK_DEBUG_XIM},
89 {"nograbs", GDK_DEBUG_NOGRABS},
90 {"colormap", GDK_DEBUG_COLORMAP},
91 {"input", GDK_DEBUG_INPUT},
92 {"cursor", GDK_DEBUG_CURSOR},
93 {"multihead", GDK_DEBUG_MULTIHEAD},
94 {"xinerama", GDK_DEBUG_XINERAMA},
95 {"draw", GDK_DEBUG_DRAW},
96 {"eventloop", GDK_DEBUG_EVENTLOOP}
99 static const int gdk_ndebug_keys = G_N_ELEMENTS (gdk_debug_keys);
101 #endif /* G_ENABLE_DEBUG */
103 #ifdef G_ENABLE_DEBUG
105 gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
107 guint debug_value = g_parse_debug_string (value,
108 (GDebugKey *) gdk_debug_keys,
111 if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
114 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
115 _("Error parsing option --gdk-debug"));
119 _gdk_debug_flags |= debug_value;
125 gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
127 guint debug_value = g_parse_debug_string (value,
128 (GDebugKey *) gdk_debug_keys,
131 if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
134 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
135 _("Error parsing option --gdk-no-debug"));
139 _gdk_debug_flags &= ~debug_value;
143 #endif /* G_ENABLE_DEBUG */
146 gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error)
148 gdk_set_program_class (value);
154 gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error)
156 g_set_prgname (value);
161 static const GOptionEntry gdk_args[] = {
162 { "class", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_class_cb,
163 /* Description of --class=CLASS in --help output */ N_("Program class as used by the window manager"),
164 /* Placeholder in --class=CLASS in --help output */ N_("CLASS") },
165 { "name", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_name_cb,
166 /* Description of --name=NAME in --help output */ N_("Program name as used by the window manager"),
167 /* Placeholder in --name=NAME in --help output */ N_("NAME") },
168 { "display", 0, G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING, &_gdk_display_name,
169 /* Description of --display=DISPLAY in --help output */ N_("X display to use"),
170 /* Placeholder in --display=DISPLAY in --help output */ N_("DISPLAY") },
171 { "screen", 0, 0, G_OPTION_ARG_INT, &_gdk_screen_number,
172 /* Description of --screen=SCREEN in --help output */ N_("X screen to use"),
173 /* Placeholder in --screen=SCREEN in --help output */ N_("SCREEN") },
174 #ifdef G_ENABLE_DEBUG
175 { "gdk-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_debug_cb,
176 /* Description of --gdk-debug=FLAGS in --help output */ N_("GDK debugging flags to set"),
177 /* Placeholder in --gdk-debug=FLAGS in --help output */ N_("FLAGS") },
178 { "gdk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_no_debug_cb,
179 /* Description of --gdk-no-debug=FLAGS in --help output */ N_("GDK debugging flags to unset"),
180 /* Placeholder in --gdk-no-debug=FLAGS in --help output */ N_("FLAGS") },
186 * gdk_add_option_entries_libgtk_only:
187 * @group: An option group.
189 * Appends gdk option entries to the passed in option group. This is
190 * not public API and must not be used by applications.
193 gdk_add_option_entries_libgtk_only (GOptionGroup *group)
195 g_option_group_add_entries (group, gdk_args);
196 g_option_group_add_entries (group, _gdk_windowing_args);
200 gdk_pre_parse_libgtk_only (void)
202 gdk_initialized = TRUE;
204 /* We set the fallback program class here, rather than lazily in
205 * gdk_get_program_class, since we don't want -name to override it.
207 gdk_progclass = g_strdup (g_get_prgname ());
208 if (gdk_progclass && gdk_progclass[0])
209 gdk_progclass[0] = g_ascii_toupper (gdk_progclass[0]);
211 #ifdef G_ENABLE_DEBUG
213 gchar *debug_string = getenv("GDK_DEBUG");
214 if (debug_string != NULL)
215 _gdk_debug_flags = g_parse_debug_string (debug_string,
216 (GDebugKey *) gdk_debug_keys,
219 #endif /* G_ENABLE_DEBUG */
221 if (getenv ("GDK_NATIVE_WINDOWS"))
223 _gdk_native_windows = TRUE;
224 /* Ensure that this is not propagated
225 to spawned applications */
226 g_unsetenv ("GDK_NATIVE_WINDOWS");
231 /* Do any setup particular to the windowing system
233 _gdk_windowing_init ();
239 * @argc: the number of command line arguments.
240 * @argv: the array of command line arguments.
242 * Parse command line arguments, and store for future
243 * use by calls to gdk_display_open().
245 * Any arguments used by GDK are removed from the array and @argc and @argv are
246 * updated accordingly.
248 * You shouldn't call this function explicitely if you are using
249 * gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().
254 gdk_parse_args (int *argc,
257 GOptionContext *option_context;
258 GOptionGroup *option_group;
259 GError *error = NULL;
264 gdk_pre_parse_libgtk_only ();
266 option_context = g_option_context_new (NULL);
267 g_option_context_set_ignore_unknown_options (option_context, TRUE);
268 g_option_context_set_help_enabled (option_context, FALSE);
269 option_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
270 g_option_context_set_main_group (option_context, option_group);
272 g_option_group_add_entries (option_group, gdk_args);
273 g_option_group_add_entries (option_group, _gdk_windowing_args);
275 if (!g_option_context_parse (option_context, argc, argv, &error))
277 g_warning ("%s", error->message);
278 g_error_free (error);
280 g_option_context_free (option_context);
282 GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ()));
286 * gdk_get_display_arg_name:
288 * Gets the display name specified in the command line arguments passed
289 * to gdk_init() or gdk_parse_args(), if any.
291 * Returns: the display name, if specified explicitely, otherwise %NULL
292 * this string is owned by GTK+ and must not be modified or freed.
296 G_CONST_RETURN gchar *
297 gdk_get_display_arg_name (void)
299 if (!_gdk_display_arg_name)
301 if (_gdk_screen_number >= 0)
302 _gdk_display_arg_name = _gdk_windowing_substitute_screen_number (_gdk_display_name, _gdk_screen_number);
304 _gdk_display_arg_name = g_strdup (_gdk_display_name);
307 return _gdk_display_arg_name;
311 * gdk_display_open_default_libgtk_only:
313 * Opens the default display specified by command line arguments or
314 * environment variables, sets it as the default display, and returns
315 * it. gdk_parse_args must have been called first. If the default
316 * display has previously been set, simply returns that. An internal
317 * function that should not be used by applications.
319 * Return value: (transfer none): the default display, if it could be
320 * opened, otherwise %NULL.
323 gdk_display_open_default_libgtk_only (void)
327 g_return_val_if_fail (gdk_initialized, NULL);
329 display = gdk_display_get_default ();
333 display = gdk_display_open (gdk_get_display_arg_name ());
335 if (!display && _gdk_screen_number >= 0)
337 g_free (_gdk_display_arg_name);
338 _gdk_display_arg_name = g_strdup (_gdk_display_name);
340 display = gdk_display_open (_gdk_display_name);
344 gdk_display_manager_set_default_display (gdk_display_manager_get (),
352 * @argc: (inout): the number of command line arguments.
353 * @argv: (array length=argc) (inout): the array of command line arguments.
355 * Initializes the GDK library and connects to the X server, returning %TRUE on
358 * Any arguments used by GDK are removed from the array and @argc and @argv are
359 * updated accordingly.
361 * GTK+ initializes GDK in gtk_init() and so this function is not usually needed
362 * by GTK+ applications.
364 * Returns: %TRUE if initialization succeeded.
367 gdk_init_check (int *argc,
370 gdk_parse_args (argc, argv);
372 return gdk_display_open_default_libgtk_only () != NULL;
378 * @argc: (inout): the number of command line arguments.
379 * @argv: (array length=argc) (inout): the array of command line arguments.
381 * Initializes the GDK library and connects to the X server.
382 * If initialization fails, a warning message is output and the application
383 * terminates with a call to <literal>exit(1)</literal>.
385 * Any arguments used by GDK are removed from the array and @argc and @argv are
386 * updated accordingly.
388 * GTK+ initializes GDK in gtk_init() and so this function is not usually needed
389 * by GTK+ applications.
392 gdk_init (int *argc, char ***argv)
394 if (!gdk_init_check (argc, argv))
396 const char *display_name = gdk_get_display_arg_name ();
397 g_warning ("cannot open display: %s", display_name ? display_name : "");
406 * @Short_description: Functions for using GDK in multi-threaded programs
409 * For thread safety, GDK relies on the thread primitives in GLib,
410 * and on the thread-safe GLib main loop.
412 * GLib is completely thread safe (all global data is automatically
413 * locked), but individual data structure instances are not automatically
414 * locked for performance reasons. So e.g. you must coordinate
415 * accesses to the same #GHashTable from multiple threads.
417 * GTK+ is "thread aware" but not thread safe — it provides a
418 * global lock controlled by gdk_threads_enter()/gdk_threads_leave()
419 * which protects all use of GTK+. That is, only one thread can use GTK+
422 * Unfortunately the above holds with the X11 backend only. With the
423 * Win32 backend, GDK calls should not be attempted from multiple threads
426 * You must call g_thread_init() and gdk_threads_init() before executing
427 * any other GTK+ or GDK functions in a threaded GTK+ program.
429 * Idles, timeouts, and input functions from GLib, such as g_idle_add(), are
430 * executed outside of the main GTK+ lock.
431 * So, if you need to call GTK+ inside of such a callback, you must surround
432 * the callback with a gdk_threads_enter()/gdk_threads_leave() pair or use
433 * gdk_threads_add_idle_full() which does this for you.
434 * However, event dispatching from the mainloop is still executed within
435 * the main GTK+ lock, so callback functions connected to event signals
436 * like #GtkWidget::button-press-event, do not need thread protection.
438 * In particular, this means, if you are writing widgets that might
439 * be used in threaded programs, you <emphasis>must</emphasis> surround
440 * timeouts and idle functions in this matter.
442 * As always, you must also surround any calls to GTK+ not made within
443 * a signal handler with a gdk_threads_enter()/gdk_threads_leave() pair.
445 * Before calling gdk_threads_leave() from a thread other
446 * than your main thread, you probably want to call gdk_flush()
447 * to send all pending commands to the windowing system.
448 * (The reason you don't need to do this from the main thread
449 * is that GDK always automatically flushes pending commands
450 * when it runs out of incoming events to process and has
451 * to sleep while waiting for more events.)
453 * A minimal main program for a threaded GTK+ application
456 * <programlisting role="C">
458 * main (int argc, char *argv[])
462 * g_thread_init (NULL);
463 * gdk_threads_init (<!-- -->);
464 * gdk_threads_enter (<!-- -->);
466 * gtk_init (&argc, &argv);
468 * window = create_window (<!-- -->);
469 * gtk_widget_show (window);
471 * gtk_main (<!-- -->);
472 * gdk_threads_leave (<!-- -->);
479 * Callbacks require a bit of attention. Callbacks from GTK+ signals
480 * are made within the GTK+ lock. However callbacks from GLib (timeouts,
481 * IO callbacks, and idle functions) are made outside of the GTK+
482 * lock. So, within a signal handler you do not need to call
483 * gdk_threads_enter(), but within the other types of callbacks, you
486 * Erik Mouw contributed the following code example to
487 * illustrate how to use threads within GTK+ programs.
489 * <programlisting role="C">
490 * /<!---->*-------------------------------------------------------------------------
491 * * Filename: gtk-thread.c
493 * * Copyright: Copyright (C) 1999, Erik Mouw
494 * * Author: Erik Mouw <J.A.K.Mouw@its.tudelft.nl>
495 * * Description: GTK threads example.
496 * * Created at: Sun Oct 17 21:27:09 1999
497 * * Modified by: Erik Mouw <J.A.K.Mouw@its.tudelft.nl>
498 * * Modified at: Sun Oct 24 17:21:41 1999
499 * *-----------------------------------------------------------------------*<!---->/
503 * * cc -o gtk-thread gtk-thread.c `gtk-config --cflags --libs gthread`
505 * * Thanks to Sebastian Wilhelmi and Owen Taylor for pointing out some
511 * #include <stdlib.h>
512 * #include <unistd.h>
514 * #include <gtk/gtk.h>
516 * #include <pthread.h>
518 * #define YES_IT_IS (1)
519 * #define NO_IT_IS_NOT (0)
527 * G_LOCK_DEFINE_STATIC (yes_or_no);
528 * static volatile int yes_or_no = YES_IT_IS;
530 * void destroy (GtkWidget *widget, gpointer data)
532 * gtk_main_quit (<!-- -->);
535 * void *argument_thread (void *args)
537 * yes_or_no_args *data = (yes_or_no_args *)args;
538 * gboolean say_something;
542 * /<!---->* sleep a while *<!---->/
543 * sleep(rand(<!-- -->) / (RAND_MAX / 3) + 1);
545 * /<!---->* lock the yes_or_no_variable *<!---->/
548 * /<!---->* do we have to say something? *<!---->/
549 * say_something = (yes_or_no != data->what);
553 * /<!---->* set the variable *<!---->/
554 * yes_or_no = data->what;
557 * /<!---->* Unlock the yes_or_no variable *<!---->/
558 * G_UNLOCK (yes_or_no);
562 * /<!---->* get GTK thread lock *<!---->/
563 * gdk_threads_enter (<!-- -->);
565 * /<!---->* set label text *<!---->/
566 * if(data->what == YES_IT_IS)
567 * gtk_label_set_text (GTK_LABEL (data->label), "O yes, it is!");
569 * gtk_label_set_text (GTK_LABEL (data->label), "O no, it isn't!");
571 * /<!---->* release GTK thread lock *<!---->/
572 * gdk_threads_leave (<!-- -->);
579 * int main (int argc, char *argv[])
583 * yes_or_no_args yes_args, no_args;
584 * pthread_t no_tid, yes_tid;
586 * /<!---->* init threads *<!---->/
587 * g_thread_init (NULL);
588 * gdk_threads_init (<!-- -->);
589 * gdk_threads_enter (<!-- -->);
591 * /<!---->* init gtk *<!---->/
592 * gtk_init(&argc, &argv);
594 * /<!---->* init random number generator *<!---->/
595 * srand ((unsigned int) time (NULL));
597 * /<!---->* create a window *<!---->/
598 * window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
600 * g_signal_connect (window, "destroy", G_CALLBACK (destroy), NULL);
602 * gtk_container_set_border_width (GTK_CONTAINER (window), 10);
604 * /<!---->* create a label *<!---->/
605 * label = gtk_label_new ("And now for something completely different ...");
606 * gtk_container_add (GTK_CONTAINER (window), label);
608 * /<!---->* show everything *<!---->/
609 * gtk_widget_show (label);
610 * gtk_widget_show (window);
612 * /<!---->* create the threads *<!---->/
613 * yes_args.label = label;
614 * yes_args.what = YES_IT_IS;
615 * pthread_create (&yes_tid, NULL, argument_thread, &yes_args);
617 * no_args.label = label;
618 * no_args.what = NO_IT_IS_NOT;
619 * pthread_create (&no_tid, NULL, argument_thread, &no_args);
621 * /<!---->* enter the GTK main loop *<!---->/
622 * gtk_main (<!-- -->);
623 * gdk_threads_leave (<!-- -->);
635 * This macro marks the beginning of a critical section in which GDK and
636 * GTK+ functions can be called safely and without causing race
637 * conditions. Only one thread at a time can be in such a critial
641 gdk_threads_enter (void)
643 if (gdk_threads_lock)
644 (*gdk_threads_lock) ();
650 * Leaves a critical region begun with gdk_threads_enter().
653 gdk_threads_leave (void)
655 if (gdk_threads_unlock)
656 (*gdk_threads_unlock) ();
660 gdk_threads_impl_lock (void)
662 if (gdk_threads_mutex)
663 g_mutex_lock (gdk_threads_mutex);
667 gdk_threads_impl_unlock (void)
669 if (gdk_threads_mutex)
670 g_mutex_unlock (gdk_threads_mutex);
676 * Initializes GDK so that it can be used from multiple threads
677 * in conjunction with gdk_threads_enter() and gdk_threads_leave().
678 * g_thread_init() must be called previous to this function.
680 * This call must be made before any use of the main loop from
681 * GTK+; to be safe, call it before gtk_init().
684 gdk_threads_init (void)
686 if (!g_thread_supported ())
687 g_error ("g_thread_init() must be called before gdk_threads_init()");
689 gdk_threads_mutex = g_mutex_new ();
690 if (!gdk_threads_lock)
691 gdk_threads_lock = gdk_threads_impl_lock;
692 if (!gdk_threads_unlock)
693 gdk_threads_unlock = gdk_threads_impl_unlock;
697 * gdk_threads_set_lock_functions:
698 * @enter_fn: function called to guard GDK
699 * @leave_fn: function called to release the guard
701 * Allows the application to replace the standard method that
702 * GDK uses to protect its data structures. Normally, GDK
703 * creates a single #GMutex that is locked by gdk_threads_enter(),
704 * and released by gdk_threads_leave(); using this function an
705 * application provides, instead, a function @enter_fn that is
706 * called by gdk_threads_enter() and a function @leave_fn that is
707 * called by gdk_threads_leave().
709 * The functions must provide at least same locking functionality
710 * as the default implementation, but can also do extra application
711 * specific processing.
713 * As an example, consider an application that has its own recursive
714 * lock that when held, holds the GTK+ lock as well. When GTK+ unlocks
715 * the GTK+ lock when entering a recursive main loop, the application
716 * must temporarily release its lock as well.
718 * Most threaded GTK+ apps won't need to use this method.
720 * This method must be called before gdk_threads_init(), and cannot
721 * be called multiple times.
726 gdk_threads_set_lock_functions (GCallback enter_fn,
729 g_return_if_fail (gdk_threads_lock == NULL &&
730 gdk_threads_unlock == NULL);
732 gdk_threads_lock = enter_fn;
733 gdk_threads_unlock = leave_fn;
737 gdk_threads_dispatch (gpointer data)
739 GdkThreadsDispatch *dispatch = data;
740 gboolean ret = FALSE;
742 GDK_THREADS_ENTER ();
744 if (!g_source_is_destroyed (g_main_current_source ()))
745 ret = dispatch->func (dispatch->data);
747 GDK_THREADS_LEAVE ();
753 gdk_threads_dispatch_free (gpointer data)
755 GdkThreadsDispatch *dispatch = data;
757 if (dispatch->destroy && dispatch->data)
758 dispatch->destroy (dispatch->data);
760 g_slice_free (GdkThreadsDispatch, data);
765 * gdk_threads_add_idle_full:
766 * @priority: the priority of the idle source. Typically this will be in the
767 * range btweeen #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
768 * @function: function to call
769 * @data: data to pass to @function
770 * @notify: (allow-none): function to call when the idle is removed, or %NULL
772 * Adds a function to be called whenever there are no higher priority
773 * events pending. If the function returns %FALSE it is automatically
774 * removed from the list of event sources and will not be called again.
776 * This variant of g_idle_add_full() calls @function with the GDK lock
777 * held. It can be thought of a MT-safe version for GTK+ widgets for the
778 * following use case, where you have to worry about idle_callback()
779 * running in thread A and accessing @self after it has been finalized
784 * idle_callback (gpointer data)
786 * /* gdk_threads_enter(); would be needed for g_idle_add() */
788 * SomeWidget *self = data;
789 * /* do stuff with self */
793 * /* gdk_threads_leave(); would be needed for g_idle_add() */
798 * some_widget_do_stuff_later (SomeWidget *self)
800 * self->idle_id = gdk_threads_add_idle (idle_callback, self)
801 * /* using g_idle_add() here would require thread protection in the callback */
805 * some_widget_finalize (GObject *object)
807 * SomeWidget *self = SOME_WIDGET (object);
809 * g_source_remove (self->idle_id);
810 * G_OBJECT_CLASS (parent_class)->finalize (object);
814 * Return value: the ID (greater than 0) of the event source.
819 gdk_threads_add_idle_full (gint priority,
820 GSourceFunc function,
822 GDestroyNotify notify)
824 GdkThreadsDispatch *dispatch;
826 g_return_val_if_fail (function != NULL, 0);
828 dispatch = g_slice_new (GdkThreadsDispatch);
829 dispatch->func = function;
830 dispatch->data = data;
831 dispatch->destroy = notify;
833 return g_idle_add_full (priority,
834 gdk_threads_dispatch,
836 gdk_threads_dispatch_free);
840 * gdk_threads_add_idle:
841 * @function: function to call
842 * @data: data to pass to @function
844 * A wrapper for the common usage of gdk_threads_add_idle_full()
845 * assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.
847 * See gdk_threads_add_idle_full().
849 * Return value: the ID (greater than 0) of the event source.
854 gdk_threads_add_idle (GSourceFunc function,
857 return gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
858 function, data, NULL);
863 * gdk_threads_add_timeout_full:
864 * @priority: the priority of the timeout source. Typically this will be in the
865 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
866 * @interval: the time between calls to the function, in milliseconds
867 * (1/1000ths of a second)
868 * @function: function to call
869 * @data: data to pass to @function
870 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
872 * Sets a function to be called at regular intervals holding the GDK lock,
873 * with the given priority. The function is called repeatedly until it
874 * returns %FALSE, at which point the timeout is automatically destroyed
875 * and the function will not be called again. The @notify function is
876 * called when the timeout is destroyed. The first call to the
877 * function will be at the end of the first @interval.
879 * Note that timeout functions may be delayed, due to the processing of other
880 * event sources. Thus they should not be relied on for precise timing.
881 * After each call to the timeout function, the time of the next
882 * timeout is recalculated based on the current time and the given interval
883 * (it does not try to 'catch up' time lost in delays).
885 * This variant of g_timeout_add_full() can be thought of a MT-safe version
886 * for GTK+ widgets for the following use case:
889 * static gboolean timeout_callback (gpointer data)
891 * SomeWidget *self = data;
893 * /* do stuff with self */
895 * self->timeout_id = 0;
900 * static void some_widget_do_stuff_later (SomeWidget *self)
902 * self->timeout_id = g_timeout_add (timeout_callback, self)
905 * static void some_widget_finalize (GObject *object)
907 * SomeWidget *self = SOME_WIDGET (object);
909 * if (self->timeout_id)
910 * g_source_remove (self->timeout_id);
912 * G_OBJECT_CLASS (parent_class)->finalize (object);
916 * Return value: the ID (greater than 0) of the event source.
921 gdk_threads_add_timeout_full (gint priority,
923 GSourceFunc function,
925 GDestroyNotify notify)
927 GdkThreadsDispatch *dispatch;
929 g_return_val_if_fail (function != NULL, 0);
931 dispatch = g_slice_new (GdkThreadsDispatch);
932 dispatch->func = function;
933 dispatch->data = data;
934 dispatch->destroy = notify;
936 return g_timeout_add_full (priority,
938 gdk_threads_dispatch,
940 gdk_threads_dispatch_free);
944 * gdk_threads_add_timeout:
945 * @interval: the time between calls to the function, in milliseconds
946 * (1/1000ths of a second)
947 * @function: function to call
948 * @data: data to pass to @function
950 * A wrapper for the common usage of gdk_threads_add_timeout_full()
951 * assigning the default priority, #G_PRIORITY_DEFAULT.
953 * See gdk_threads_add_timeout_full().
955 * Return value: the ID (greater than 0) of the event source.
960 gdk_threads_add_timeout (guint interval,
961 GSourceFunc function,
964 return gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
965 interval, function, data, NULL);
970 * gdk_threads_add_timeout_seconds_full:
971 * @priority: the priority of the timeout source. Typically this will be in the
972 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
973 * @interval: the time between calls to the function, in seconds
974 * @function: function to call
975 * @data: data to pass to @function
976 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
978 * A variant of gdk_threads_add_timout_full() with second-granularity.
979 * See g_timeout_add_seconds_full() for a discussion of why it is
980 * a good idea to use this function if you don't need finer granularity.
982 * Return value: the ID (greater than 0) of the event source.
987 gdk_threads_add_timeout_seconds_full (gint priority,
989 GSourceFunc function,
991 GDestroyNotify notify)
993 GdkThreadsDispatch *dispatch;
995 g_return_val_if_fail (function != NULL, 0);
997 dispatch = g_slice_new (GdkThreadsDispatch);
998 dispatch->func = function;
999 dispatch->data = data;
1000 dispatch->destroy = notify;
1002 return g_timeout_add_seconds_full (priority,
1004 gdk_threads_dispatch,
1006 gdk_threads_dispatch_free);
1010 * gdk_threads_add_timeout_seconds:
1011 * @interval: the time between calls to the function, in seconds
1012 * @function: function to call
1013 * @data: data to pass to @function
1015 * A wrapper for the common usage of gdk_threads_add_timeout_seconds_full()
1016 * assigning the default priority, #G_PRIORITY_DEFAULT.
1018 * For details, see gdk_threads_add_timeout_full().
1020 * Return value: the ID (greater than 0) of the event source.
1025 gdk_threads_add_timeout_seconds (guint interval,
1026 GSourceFunc function,
1029 return gdk_threads_add_timeout_seconds_full (G_PRIORITY_DEFAULT,
1030 interval, function, data, NULL);
1034 * gdk_get_program_class:
1036 * Gets the program class. Unless the program class has explicitly
1037 * been set with gdk_set_program_class() or with the <option>--class</option>
1038 * commandline option, the default value is the program name (determined
1039 * with g_get_prgname()) with the first character converted to uppercase.
1041 * Returns: the program class.
1043 G_CONST_RETURN char *
1044 gdk_get_program_class (void)
1046 return gdk_progclass;
1050 * gdk_set_program_class:
1051 * @program_class: a string.
1053 * Sets the program class. The X11 backend uses the program class to set
1054 * the class name part of the <literal>WM_CLASS</literal> property on
1055 * toplevel windows; see the ICCCM.
1058 gdk_set_program_class (const char *program_class)
1060 g_free (gdk_progclass);
1062 gdk_progclass = g_strdup (program_class);
1066 * gdk_disable_multidevice:
1068 * Disables multidevice support in GDK. This call must happen prior
1069 * to gdk_display_open(), gtk_init(), gtk_init_with_args() or
1070 * gtk_init_check() in order to take effect.
1072 * Most common GTK+ applications won't ever need to call this. Only
1073 * applications that do mixed GDK/Xlib calls could want to disable
1074 * multidevice support if such Xlib code deals with input devices in
1075 * any way and doesn't observe the presence of XInput 2.
1080 gdk_disable_multidevice (void)
1082 if (gdk_initialized)
1085 _gdk_disable_multidevice = TRUE;