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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #define GDK_DISABLE_DEPRECATION_WARNINGS 1
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
48 * utility functions, as well as deprecation facilities.
50 * The GDK and GTK+ headers annotate deprecated APIs in a way that produces
51 * compiler warnings if these deprecated APIs are used. The warnings
52 * can be turned off by defining the macro %GDK_DISABLE_DEPRECATION_WARNINGS
53 * before including the glib.h header.
55 * GDK and GTK+ also provide support for building applications against
56 * defined subsets of deprecated or new APIs. Define the macro
57 * %GDK_VERSION_MIN_REQUIRED to specify up to what version
58 * you want to receive warnings about deprecated APIs. Define the
59 * macro %GDK_VERSION_MAX_ALLOWED to specify the newest version
60 * whose API you want to use.
66 * The #GDK_WINDOWING_X11 macro is defined if the X11 backend
69 * Use this macro to guard code that is specific to the X11 backend.
73 * GDK_WINDOWING_WIN32:
75 * The #GDK_WINDOWING_WIN32 macro is defined if the Win32 backend
78 * Use this macro to guard code that is specific to the Win32 backend.
82 * GDK_WINDOWING_QUARTZ:
84 * The #GDK_WINDOWING_QUARTZ macro is defined if the Quartz backend
87 * Use this macro to guard code that is specific to the Quartz backend.
91 * GDK_DISABLE_DEPRECATION_WARNINGS:
93 * A macro that should be defined before including the gdk.h header.
94 * If it is defined, no compiler warnings will be produced for uses
95 * of deprecated GDK APIs.
98 typedef struct _GdkPredicate GdkPredicate;
106 typedef struct _GdkThreadsDispatch GdkThreadsDispatch;
108 struct _GdkThreadsDispatch
112 GDestroyNotify destroy;
116 /* Private variable declarations
118 static int gdk_initialized = 0; /* 1 if the library is initialized,
122 static gchar *gdk_progclass = NULL;
124 static GMutex gdk_threads_mutex;
126 static GCallback gdk_threads_lock = NULL;
127 static GCallback gdk_threads_unlock = NULL;
129 #ifdef G_ENABLE_DEBUG
130 static const GDebugKey gdk_debug_keys[] = {
131 {"events", GDK_DEBUG_EVENTS},
132 {"misc", GDK_DEBUG_MISC},
133 {"dnd", GDK_DEBUG_DND},
134 {"xim", GDK_DEBUG_XIM},
135 {"nograbs", GDK_DEBUG_NOGRABS},
136 {"input", GDK_DEBUG_INPUT},
137 {"cursor", GDK_DEBUG_CURSOR},
138 {"multihead", GDK_DEBUG_MULTIHEAD},
139 {"xinerama", GDK_DEBUG_XINERAMA},
140 {"draw", GDK_DEBUG_DRAW},
141 {"eventloop", GDK_DEBUG_EVENTLOOP}
145 gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
147 guint debug_value = g_parse_debug_string (value,
148 (GDebugKey *) gdk_debug_keys,
149 G_N_ELEMENTS (gdk_debug_keys));
151 if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
154 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
155 _("Error parsing option --gdk-debug"));
159 _gdk_debug_flags |= debug_value;
165 gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
167 guint debug_value = g_parse_debug_string (value,
168 (GDebugKey *) gdk_debug_keys,
169 G_N_ELEMENTS (gdk_debug_keys));
171 if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
174 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
175 _("Error parsing option --gdk-no-debug"));
179 _gdk_debug_flags &= ~debug_value;
183 #endif /* G_ENABLE_DEBUG */
186 gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error)
188 gdk_set_program_class (value);
194 gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error)
196 g_set_prgname (value);
201 static const GOptionEntry gdk_args[] = {
202 { "class", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_class_cb,
203 /* Description of --class=CLASS in --help output */ N_("Program class as used by the window manager"),
204 /* Placeholder in --class=CLASS in --help output */ N_("CLASS") },
205 { "name", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_name_cb,
206 /* Description of --name=NAME in --help output */ N_("Program name as used by the window manager"),
207 /* Placeholder in --name=NAME in --help output */ N_("NAME") },
208 { "display", 0, G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING, &_gdk_display_name,
209 /* Description of --display=DISPLAY in --help output */ N_("X display to use"),
210 /* Placeholder in --display=DISPLAY in --help output */ N_("DISPLAY") },
211 #ifdef G_ENABLE_DEBUG
212 { "gdk-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_debug_cb,
213 /* Description of --gdk-debug=FLAGS in --help output */ N_("GDK debugging flags to set"),
214 /* Placeholder in --gdk-debug=FLAGS in --help output */ N_("FLAGS") },
215 { "gdk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_no_debug_cb,
216 /* Description of --gdk-no-debug=FLAGS in --help output */ N_("GDK debugging flags to unset"),
217 /* Placeholder in --gdk-no-debug=FLAGS in --help output */ N_("FLAGS") },
223 * gdk_add_option_entries_libgtk_only:
224 * @group: An option group.
226 * Appends gdk option entries to the passed in option group. This is
227 * not public API and must not be used by applications.
230 gdk_add_option_entries_libgtk_only (GOptionGroup *group)
232 g_option_group_add_entries (group, gdk_args);
236 gdk_pre_parse_libgtk_only (void)
238 const char *rendering_mode;
240 gdk_initialized = TRUE;
242 /* We set the fallback program class here, rather than lazily in
243 * gdk_get_program_class, since we don't want -name to override it.
245 gdk_progclass = g_strdup (g_get_prgname ());
246 if (gdk_progclass && gdk_progclass[0])
247 gdk_progclass[0] = g_ascii_toupper (gdk_progclass[0]);
249 #ifdef G_ENABLE_DEBUG
251 gchar *debug_string = getenv("GDK_DEBUG");
252 if (debug_string != NULL)
253 _gdk_debug_flags = g_parse_debug_string (debug_string,
254 (GDebugKey *) gdk_debug_keys,
255 G_N_ELEMENTS (gdk_debug_keys));
257 #endif /* G_ENABLE_DEBUG */
259 if (getenv ("GDK_NATIVE_WINDOWS"))
261 g_warning ("The GDK_NATIVE_WINDOWS environment variable is not supported in GTK3.\n"
262 "See the documentation for gdk_window_ensure_native() on how to get native windows.");
263 g_unsetenv ("GDK_NATIVE_WINDOWS");
266 rendering_mode = g_getenv ("GDK_RENDERING");
269 if (g_str_equal (rendering_mode, "similar"))
270 _gdk_rendering_mode = GDK_RENDERING_MODE_SIMILAR;
271 else if (g_str_equal (rendering_mode, "image"))
272 _gdk_rendering_mode = GDK_RENDERING_MODE_IMAGE;
273 else if (g_str_equal (rendering_mode, "recording"))
274 _gdk_rendering_mode = GDK_RENDERING_MODE_RECORDING;
279 /* Do any setup particular to the windowing system */
280 gdk_display_manager_get ();
286 * @argc: the number of command line arguments.
287 * @argv: (inout) (array length=argc): the array of command line arguments.
289 * Parse command line arguments, and store for future
290 * use by calls to gdk_display_open().
292 * Any arguments used by GDK are removed from the array and @argc and @argv are
293 * updated accordingly.
295 * You shouldn't call this function explicitely if you are using
296 * gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().
301 gdk_parse_args (int *argc,
304 GOptionContext *option_context;
305 GOptionGroup *option_group;
306 GError *error = NULL;
311 gdk_pre_parse_libgtk_only ();
313 option_context = g_option_context_new (NULL);
314 g_option_context_set_ignore_unknown_options (option_context, TRUE);
315 g_option_context_set_help_enabled (option_context, FALSE);
316 option_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
317 g_option_context_set_main_group (option_context, option_group);
319 g_option_group_add_entries (option_group, gdk_args);
321 if (!g_option_context_parse (option_context, argc, argv, &error))
323 g_warning ("%s", error->message);
324 g_error_free (error);
326 g_option_context_free (option_context);
328 GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ()));
332 * gdk_get_display_arg_name:
334 * Gets the display name specified in the command line arguments passed
335 * to gdk_init() or gdk_parse_args(), if any.
337 * Returns: the display name, if specified explicitely, otherwise %NULL
338 * this string is owned by GTK+ and must not be modified or freed.
343 gdk_get_display_arg_name (void)
345 if (!_gdk_display_arg_name)
346 _gdk_display_arg_name = g_strdup (_gdk_display_name);
348 return _gdk_display_arg_name;
352 * gdk_display_open_default_libgtk_only:
354 * Opens the default display specified by command line arguments or
355 * environment variables, sets it as the default display, and returns
356 * it. gdk_parse_args must have been called first. If the default
357 * display has previously been set, simply returns that. An internal
358 * function that should not be used by applications.
360 * Return value: (transfer none): the default display, if it could be
361 * opened, otherwise %NULL.
364 gdk_display_open_default_libgtk_only (void)
368 g_return_val_if_fail (gdk_initialized, NULL);
370 display = gdk_display_get_default ();
374 display = gdk_display_open (gdk_get_display_arg_name ());
381 * @argc: (inout): the number of command line arguments.
382 * @argv: (array length=argc) (inout): the array of command line arguments.
384 * Initializes the GDK library and connects to the windowing system,
385 * returning %TRUE on success.
387 * Any arguments used by GDK are removed from the array and @argc and @argv
388 * are updated accordingly.
390 * GTK+ initializes GDK in gtk_init() and so this function is not usually
391 * needed by GTK+ applications.
393 * Returns: %TRUE if initialization succeeded.
396 gdk_init_check (int *argc,
399 gdk_parse_args (argc, argv);
401 return gdk_display_open_default_libgtk_only () != NULL;
407 * @argc: (inout): the number of command line arguments.
408 * @argv: (array length=argc) (inout): the array of command line arguments.
410 * Initializes the GDK library and connects to the windowing system.
411 * If initialization fails, a warning message is output and the application
412 * terminates with a call to <literal>exit(1)</literal>.
414 * Any arguments used by GDK are removed from the array and @argc and @argv
415 * are updated accordingly.
417 * GTK+ initializes GDK in gtk_init() and so this function is not usually
418 * needed by GTK+ applications.
421 gdk_init (int *argc, char ***argv)
423 if (!gdk_init_check (argc, argv))
425 const char *display_name = gdk_get_display_arg_name ();
426 g_warning ("cannot open display: %s", display_name ? display_name : "");
435 * @Short_description: Functions for using GDK in multi-threaded programs
438 * For thread safety, GDK relies on the thread primitives in GLib,
439 * and on the thread-safe GLib main loop.
441 * GLib is completely thread safe (all global data is automatically
442 * locked), but individual data structure instances are not automatically
443 * locked for performance reasons. So e.g. you must coordinate
444 * accesses to the same #GHashTable from multiple threads.
446 * GTK+ is "thread aware" but not thread safe — it provides a
447 * global lock controlled by gdk_threads_enter()/gdk_threads_leave()
448 * which protects all use of GTK+. That is, only one thread can use GTK+
451 * Unfortunately the above holds with the X11 backend only. With the
452 * Win32 backend, GDK calls should not be attempted from multiple threads
455 * You must call gdk_threads_init() before executing any other GTK+ or
456 * GDK functions in a threaded GTK+ program.
458 * Idles, timeouts, and input functions from GLib, such as g_idle_add(),
459 * are executed outside of the main GTK+ lock. So, if you need to call
460 * GTK+ inside of such a callback, you must surround the callback with
461 * a gdk_threads_enter()/gdk_threads_leave() pair or use
462 * gdk_threads_add_idle_full() which does this for you.
463 * However, event dispatching from the mainloop is still executed within
464 * the main GTK+ lock, so callback functions connected to event signals
465 * like #GtkWidget::button-press-event, do not need thread protection.
467 * In particular, this means, if you are writing widgets that might
468 * be used in threaded programs, you <emphasis>must</emphasis> surround
469 * timeouts and idle functions in this matter.
471 * As always, you must also surround any calls to GTK+ not made within
472 * a signal handler with a gdk_threads_enter()/gdk_threads_leave() pair.
474 * Before calling gdk_threads_leave() from a thread other
475 * than your main thread, you probably want to call gdk_flush()
476 * to send all pending commands to the windowing system.
477 * (The reason you don't need to do this from the main thread
478 * is that GDK always automatically flushes pending commands
479 * when it runs out of incoming events to process and has
480 * to sleep while waiting for more events.)
482 * A minimal main program for a threaded GTK+ application
485 * <programlisting role="C">
487 * main (int argc, char *argv[])
491 * gdk_threads_init (<!-- -->);
492 * gdk_threads_enter (<!-- -->);
494 * gtk_init (&argc, &argv);
496 * window = create_window (<!-- -->);
497 * gtk_widget_show (window);
499 * gtk_main (<!-- -->);
500 * gdk_threads_leave (<!-- -->);
507 * Callbacks require a bit of attention. Callbacks from GTK+ signals
508 * are made within the GTK+ lock. However callbacks from GLib (timeouts,
509 * IO callbacks, and idle functions) are made outside of the GTK+
510 * lock. So, within a signal handler you do not need to call
511 * gdk_threads_enter(), but within the other types of callbacks, you
514 * Erik Mouw contributed the following code example to
515 * illustrate how to use threads within GTK+ programs.
517 * <programlisting role="C">
518 * /<!---->*-------------------------------------------------------------------------
519 * * Filename: gtk-thread.c
521 * * Copyright: Copyright (C) 1999, Erik Mouw
522 * * Author: Erik Mouw <J.A.K.Mouw@its.tudelft.nl>
523 * * Description: GTK threads example.
524 * * Created at: Sun Oct 17 21:27:09 1999
525 * * Modified by: Erik Mouw <J.A.K.Mouw@its.tudelft.nl>
526 * * Modified at: Sun Oct 24 17:21:41 1999
527 * *-----------------------------------------------------------------------*<!---->/
531 * * cc -o gtk-thread gtk-thread.c `gtk-config --cflags --libs gthread`
533 * * Thanks to Sebastian Wilhelmi and Owen Taylor for pointing out some
539 * #include <stdlib.h>
540 * #include <unistd.h>
542 * #include <gtk/gtk.h>
544 * #include <pthread.h>
546 * #define YES_IT_IS (1)
547 * #define NO_IT_IS_NOT (0)
555 * G_LOCK_DEFINE_STATIC (yes_or_no);
556 * static volatile int yes_or_no = YES_IT_IS;
558 * void destroy (GtkWidget *widget, gpointer data)
560 * gtk_main_quit (<!-- -->);
563 * void *argument_thread (void *args)
565 * yes_or_no_args *data = (yes_or_no_args *)args;
566 * gboolean say_something;
570 * /<!---->* sleep a while *<!---->/
571 * sleep(rand(<!-- -->) / (RAND_MAX / 3) + 1);
573 * /<!---->* lock the yes_or_no_variable *<!---->/
576 * /<!---->* do we have to say something? *<!---->/
577 * say_something = (yes_or_no != data->what);
581 * /<!---->* set the variable *<!---->/
582 * yes_or_no = data->what;
585 * /<!---->* Unlock the yes_or_no variable *<!---->/
586 * G_UNLOCK (yes_or_no);
590 * /<!---->* get GTK thread lock *<!---->/
591 * gdk_threads_enter (<!-- -->);
593 * /<!---->* set label text *<!---->/
594 * if(data->what == YES_IT_IS)
595 * gtk_label_set_text (GTK_LABEL (data->label), "O yes, it is!");
597 * gtk_label_set_text (GTK_LABEL (data->label), "O no, it isn't!");
599 * /<!---->* release GTK thread lock *<!---->/
600 * gdk_threads_leave (<!-- -->);
607 * int main (int argc, char *argv[])
611 * yes_or_no_args yes_args, no_args;
612 * pthread_t no_tid, yes_tid;
614 * /<!---->* init threads *<!---->/
615 * gdk_threads_init (<!-- -->);
616 * gdk_threads_enter (<!-- -->);
618 * /<!---->* init gtk *<!---->/
619 * gtk_init(&argc, &argv);
621 * /<!---->* init random number generator *<!---->/
622 * srand ((unsigned int) time (NULL));
624 * /<!---->* create a window *<!---->/
625 * window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
627 * g_signal_connect (window, "destroy", G_CALLBACK (destroy), NULL);
629 * gtk_container_set_border_width (GTK_CONTAINER (window), 10);
631 * /<!---->* create a label *<!---->/
632 * label = gtk_label_new ("And now for something completely different ...");
633 * gtk_container_add (GTK_CONTAINER (window), label);
635 * /<!---->* show everything *<!---->/
636 * gtk_widget_show (label);
637 * gtk_widget_show (window);
639 * /<!---->* create the threads *<!---->/
640 * yes_args.label = label;
641 * yes_args.what = YES_IT_IS;
642 * pthread_create (&yes_tid, NULL, argument_thread, &yes_args);
644 * no_args.label = label;
645 * no_args.what = NO_IT_IS_NOT;
646 * pthread_create (&no_tid, NULL, argument_thread, &no_args);
648 * /<!---->* enter the GTK main loop *<!---->/
649 * gtk_main (<!-- -->);
650 * gdk_threads_leave (<!-- -->);
662 * This function marks the beginning of a critical section in which
663 * GDK and GTK+ functions can be called safely and without causing race
664 * conditions. Only one thread at a time can be in such a critial
667 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
671 gdk_threads_enter (void)
673 if (gdk_threads_lock)
674 (*gdk_threads_lock) ();
680 * Leaves a critical region begun with gdk_threads_enter().
682 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
686 gdk_threads_leave (void)
688 if (gdk_threads_unlock)
689 (*gdk_threads_unlock) ();
693 gdk_threads_impl_lock (void)
695 g_mutex_lock (&gdk_threads_mutex);
699 gdk_threads_impl_unlock (void)
701 g_mutex_unlock (&gdk_threads_mutex);
707 * Initializes GDK so that it can be used from multiple threads
708 * in conjunction with gdk_threads_enter() and gdk_threads_leave().
710 * This call must be made before any use of the main loop from
711 * GTK+; to be safe, call it before gtk_init().
713 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
717 gdk_threads_init (void)
719 if (!gdk_threads_lock)
720 gdk_threads_lock = gdk_threads_impl_lock;
721 if (!gdk_threads_unlock)
722 gdk_threads_unlock = gdk_threads_impl_unlock;
726 * gdk_threads_set_lock_functions: (skip)
727 * @enter_fn: function called to guard GDK
728 * @leave_fn: function called to release the guard
730 * Allows the application to replace the standard method that
731 * GDK uses to protect its data structures. Normally, GDK
732 * creates a single #GMutex that is locked by gdk_threads_enter(),
733 * and released by gdk_threads_leave(); using this function an
734 * application provides, instead, a function @enter_fn that is
735 * called by gdk_threads_enter() and a function @leave_fn that is
736 * called by gdk_threads_leave().
738 * The functions must provide at least same locking functionality
739 * as the default implementation, but can also do extra application
740 * specific processing.
742 * As an example, consider an application that has its own recursive
743 * lock that when held, holds the GTK+ lock as well. When GTK+ unlocks
744 * the GTK+ lock when entering a recursive main loop, the application
745 * must temporarily release its lock as well.
747 * Most threaded GTK+ apps won't need to use this method.
749 * This method must be called before gdk_threads_init(), and cannot
750 * be called multiple times.
752 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
758 gdk_threads_set_lock_functions (GCallback enter_fn,
761 g_return_if_fail (gdk_threads_lock == NULL &&
762 gdk_threads_unlock == NULL);
764 gdk_threads_lock = enter_fn;
765 gdk_threads_unlock = leave_fn;
769 gdk_threads_dispatch (gpointer data)
771 GdkThreadsDispatch *dispatch = data;
772 gboolean ret = FALSE;
774 gdk_threads_enter ();
776 if (!g_source_is_destroyed (g_main_current_source ()))
777 ret = dispatch->func (dispatch->data);
779 gdk_threads_leave ();
785 gdk_threads_dispatch_free (gpointer data)
787 GdkThreadsDispatch *dispatch = data;
789 if (dispatch->destroy && dispatch->data)
790 dispatch->destroy (dispatch->data);
792 g_slice_free (GdkThreadsDispatch, data);
797 * gdk_threads_add_idle_full:
798 * @priority: the priority of the idle source. Typically this will be in the
799 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
800 * @function: function to call
801 * @data: data to pass to @function
802 * @notify: (allow-none): function to call when the idle is removed, or %NULL
804 * Adds a function to be called whenever there are no higher priority
805 * events pending. If the function returns %FALSE it is automatically
806 * removed from the list of event sources and will not be called again.
808 * This variant of g_idle_add_full() calls @function with the GDK lock
809 * held. It can be thought of a MT-safe version for GTK+ widgets for the
810 * following use case, where you have to worry about idle_callback()
811 * running in thread A and accessing @self after it has been finalized
816 * idle_callback (gpointer data)
818 * /* gdk_threads_enter(); would be needed for g_idle_add() */
820 * SomeWidget *self = data;
821 * /* do stuff with self */
825 * /* gdk_threads_leave(); would be needed for g_idle_add() */
830 * some_widget_do_stuff_later (SomeWidget *self)
832 * self->idle_id = gdk_threads_add_idle (idle_callback, self)
833 * /* using g_idle_add() here would require thread protection in the callback */
837 * some_widget_finalize (GObject *object)
839 * SomeWidget *self = SOME_WIDGET (object);
841 * g_source_remove (self->idle_id);
842 * G_OBJECT_CLASS (parent_class)->finalize (object);
846 * Return value: the ID (greater than 0) of the event source.
849 * Rename to: gdk_threads_add_idle
852 gdk_threads_add_idle_full (gint priority,
853 GSourceFunc function,
855 GDestroyNotify notify)
857 GdkThreadsDispatch *dispatch;
859 g_return_val_if_fail (function != NULL, 0);
861 dispatch = g_slice_new (GdkThreadsDispatch);
862 dispatch->func = function;
863 dispatch->data = data;
864 dispatch->destroy = notify;
866 return g_idle_add_full (priority,
867 gdk_threads_dispatch,
869 gdk_threads_dispatch_free);
873 * gdk_threads_add_idle: (skip)
874 * @function: function to call
875 * @data: data to pass to @function
877 * A wrapper for the common usage of gdk_threads_add_idle_full()
878 * assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.
880 * See gdk_threads_add_idle_full().
882 * Return value: the ID (greater than 0) of the event source.
887 gdk_threads_add_idle (GSourceFunc function,
890 return gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
891 function, data, NULL);
896 * gdk_threads_add_timeout_full:
897 * @priority: the priority of the timeout source. Typically this will be in the
898 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
899 * @interval: the time between calls to the function, in milliseconds
900 * (1/1000ths of a second)
901 * @function: function to call
902 * @data: data to pass to @function
903 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
905 * Sets a function to be called at regular intervals holding the GDK lock,
906 * with the given priority. The function is called repeatedly until it
907 * returns %FALSE, at which point the timeout is automatically destroyed
908 * and the function will not be called again. The @notify function is
909 * called when the timeout is destroyed. The first call to the
910 * function will be at the end of the first @interval.
912 * Note that timeout functions may be delayed, due to the processing of other
913 * event sources. Thus they should not be relied on for precise timing.
914 * After each call to the timeout function, the time of the next
915 * timeout is recalculated based on the current time and the given interval
916 * (it does not try to 'catch up' time lost in delays).
918 * This variant of g_timeout_add_full() can be thought of a MT-safe version
919 * for GTK+ widgets for the following use case:
922 * static gboolean timeout_callback (gpointer data)
924 * SomeWidget *self = data;
926 * /* do stuff with self */
928 * self->timeout_id = 0;
930 * return G_SOURCE_REMOVE;
933 * static void some_widget_do_stuff_later (SomeWidget *self)
935 * self->timeout_id = g_timeout_add (timeout_callback, self)
938 * static void some_widget_finalize (GObject *object)
940 * SomeWidget *self = SOME_WIDGET (object);
942 * if (self->timeout_id)
943 * g_source_remove (self->timeout_id);
945 * G_OBJECT_CLASS (parent_class)->finalize (object);
949 * Return value: the ID (greater than 0) of the event source.
952 * Rename to: gdk_threads_add_timeout
955 gdk_threads_add_timeout_full (gint priority,
957 GSourceFunc function,
959 GDestroyNotify notify)
961 GdkThreadsDispatch *dispatch;
963 g_return_val_if_fail (function != NULL, 0);
965 dispatch = g_slice_new (GdkThreadsDispatch);
966 dispatch->func = function;
967 dispatch->data = data;
968 dispatch->destroy = notify;
970 return g_timeout_add_full (priority,
972 gdk_threads_dispatch,
974 gdk_threads_dispatch_free);
978 * gdk_threads_add_timeout: (skip)
979 * @interval: the time between calls to the function, in milliseconds
980 * (1/1000ths of a second)
981 * @function: function to call
982 * @data: data to pass to @function
984 * A wrapper for the common usage of gdk_threads_add_timeout_full()
985 * assigning the default priority, #G_PRIORITY_DEFAULT.
987 * See gdk_threads_add_timeout_full().
989 * Return value: the ID (greater than 0) of the event source.
994 gdk_threads_add_timeout (guint interval,
995 GSourceFunc function,
998 return gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
999 interval, function, data, NULL);
1004 * gdk_threads_add_timeout_seconds_full:
1005 * @priority: the priority of the timeout source. Typically this will be in the
1006 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
1007 * @interval: the time between calls to the function, in seconds
1008 * @function: function to call
1009 * @data: data to pass to @function
1010 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
1012 * A variant of gdk_threads_add_timeout_full() with second-granularity.
1013 * See g_timeout_add_seconds_full() for a discussion of why it is
1014 * a good idea to use this function if you don't need finer granularity.
1016 * Return value: the ID (greater than 0) of the event source.
1019 * Rename to: gdk_threads_add_timeout_seconds
1022 gdk_threads_add_timeout_seconds_full (gint priority,
1024 GSourceFunc function,
1026 GDestroyNotify notify)
1028 GdkThreadsDispatch *dispatch;
1030 g_return_val_if_fail (function != NULL, 0);
1032 dispatch = g_slice_new (GdkThreadsDispatch);
1033 dispatch->func = function;
1034 dispatch->data = data;
1035 dispatch->destroy = notify;
1037 return g_timeout_add_seconds_full (priority,
1039 gdk_threads_dispatch,
1041 gdk_threads_dispatch_free);
1045 * gdk_threads_add_timeout_seconds: (skip)
1046 * @interval: the time between calls to the function, in seconds
1047 * @function: function to call
1048 * @data: data to pass to @function
1050 * A wrapper for the common usage of gdk_threads_add_timeout_seconds_full()
1051 * assigning the default priority, #G_PRIORITY_DEFAULT.
1053 * For details, see gdk_threads_add_timeout_full().
1055 * Return value: the ID (greater than 0) of the event source.
1060 gdk_threads_add_timeout_seconds (guint interval,
1061 GSourceFunc function,
1064 return gdk_threads_add_timeout_seconds_full (G_PRIORITY_DEFAULT,
1065 interval, function, data, NULL);
1069 * gdk_get_program_class:
1071 * Gets the program class. Unless the program class has explicitly
1072 * been set with gdk_set_program_class() or with the <option>--class</option>
1073 * commandline option, the default value is the program name (determined
1074 * with g_get_prgname()) with the first character converted to uppercase.
1076 * Returns: the program class.
1079 gdk_get_program_class (void)
1081 return gdk_progclass;
1085 * gdk_set_program_class:
1086 * @program_class: a string.
1088 * Sets the program class. The X11 backend uses the program class to set
1089 * the class name part of the <literal>WM_CLASS</literal> property on
1090 * toplevel windows; see the ICCCM.
1093 gdk_set_program_class (const char *program_class)
1095 g_free (gdk_progclass);
1097 gdk_progclass = g_strdup (program_class);
1101 * gdk_disable_multidevice:
1103 * Disables multidevice support in GDK. This call must happen prior
1104 * to gdk_display_open(), gtk_init(), gtk_init_with_args() or
1105 * gtk_init_check() in order to take effect.
1107 * Most common GTK+ applications won't ever need to call this. Only
1108 * applications that do mixed GDK/Xlib calls could want to disable
1109 * multidevice support if such Xlib code deals with input devices in
1110 * any way and doesn't observe the presence of XInput 2.
1115 gdk_disable_multidevice (void)
1117 if (gdk_initialized)
1120 _gdk_disable_multidevice = TRUE;