]> Pileus Git - ~andy/gtk/blob - gdk/gdkthreads.h
docs: Move documentation to inline comments: gdkthreads
[~andy/gtk] / gdk / gdkthreads.h
1 /* GDK - The GIMP Drawing Kit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/.
25  */
26
27 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
28 #error "Only <gdk/gdk.h> can be included directly."
29 #endif
30
31 #ifndef __GDK_THREADS_H__
32 #define __GDK_THREADS_H__
33
34 #include <gdk/gdktypes.h>
35
36 G_BEGIN_DECLS
37
38 void     gdk_threads_init                     (void);
39 void     gdk_threads_enter                    (void);
40 void     gdk_threads_leave                    (void);
41 void     gdk_threads_set_lock_functions       (GCallback enter_fn,
42                                                GCallback leave_fn);
43
44 guint    gdk_threads_add_idle_full            (gint           priority,
45                                                GSourceFunc    function,
46                                                gpointer       data,
47                                                GDestroyNotify notify);
48 guint    gdk_threads_add_idle                 (GSourceFunc    function,
49                                                gpointer       data);
50 guint    gdk_threads_add_timeout_full         (gint           priority,
51                                                guint          interval,
52                                                GSourceFunc    function,
53                                                gpointer       data,
54                                                GDestroyNotify notify);
55 guint    gdk_threads_add_timeout              (guint          interval,
56                                                GSourceFunc    function,
57                                                gpointer       data);
58 guint    gdk_threads_add_timeout_seconds_full (gint           priority,
59                                                guint          interval,
60                                                GSourceFunc    function,
61                                                gpointer       data,
62                                                GDestroyNotify notify);
63 guint    gdk_threads_add_timeout_seconds      (guint          interval,
64                                                GSourceFunc    function,
65                                                gpointer       data);
66
67 /**
68  * GDK_THREADS_ENTER:
69  *
70  * This macro marks the beginning of a critical section in which GDK and
71  * GTK+ functions can be called safely and without causing race
72  * conditions.  Only one thread at a time can be in such a critial
73  * section. The macro expands to a no-op if #G_THREADS_ENABLED has not
74  * been defined. Typically gdk_threads_enter() should be used instead of
75  * this macro.
76  */
77 #define GDK_THREADS_ENTER() gdk_threads_enter()
78
79 /**
80  * GDK_THREADS_LEAVE:
81  *
82  * This macro marks the end of a critical section
83  * begun with #GDK_THREADS_ENTER.
84  */
85 #define GDK_THREADS_LEAVE() gdk_threads_leave()
86
87 G_END_DECLS
88
89 #endif /* __GDK_THREADS_H__ */