~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/gtk-General.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-09-05 17:27:55 UTC
  • mfrom: (1.14.14)
  • Revision ID: package-import@ubuntu.com-20120905172755-14uyfpowr7elvr7m
Tags: 2.24.12-0ubuntu1
* New upstream bugfix release
* debian/patches/091_bugzilla_tooltip_refresh.patch:
  - Applied upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="gtkbase.html" title="Part II. GTK+ Core Reference">
9
9
<link rel="prev" href="gtkbase.html" title="Part II. GTK+ Core Reference">
10
10
<link rel="next" href="gtk-Keyboard-Accelerators.html" title="Accelerator Groups">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
40
40
<pre class="synopsis">
41
41
#include &lt;gtk/gtk.h&gt;
42
42
 
43
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gtk-General.html#gtk-set-locale" title="gtk_set_locale ()">gtk_set_locale</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
 
43
<span class="returnvalue">gchar</span> *             <a class="link" href="gtk-General.html#gtk-set-locale" title="gtk_set_locale ()">gtk_set_locale</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
44
44
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-disable-setlocale" title="gtk_disable_setlocale ()">gtk_disable_setlocale</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
45
 
<a href="/usr/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="returnvalue">PangoLanguage</span></a> *     <a class="link" href="gtk-General.html#gtk-get-default-language" title="gtk_get_default_language ()">gtk_get_default_language</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
46
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-parse-args" title="gtk_parse_args ()">gtk_parse_args</a>                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
45
<a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="returnvalue">PangoLanguage</span></a> *     <a class="link" href="gtk-General.html#gtk-get-default-language" title="gtk_get_default_language ()">gtk_get_default_language</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
 
46
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-parse-args" title="gtk_parse_args ()">gtk_parse_args</a>                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
47
47
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);
48
48
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-init" title="gtk_init ()">gtk_init</a>                            (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
49
49
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);
50
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-init-check" title="gtk_init_check ()">gtk_init_check</a>                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
50
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-init-check" title="gtk_init_check ()">gtk_init_check</a>                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
51
51
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);
52
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-init-with-args" title="gtk_init_with_args ()">gtk_init_with_args</a>                  (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
52
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-init-with-args" title="gtk_init_with_args ()">gtk_init_with_args</a>                  (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
53
53
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>,
54
54
                                                         <em class="parameter"><code>const <span class="type">char</span> *parameter_string</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry"><span class="type">GOptionEntry</span></a> *entries</code></em>,
 
55
                                                         <em class="parameter"><code><span class="type">GOptionEntry</span> *entries</code></em>,
56
56
                                                         <em class="parameter"><code>const <span class="type">char</span> *translation_domain</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
58
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> *      <a class="link" href="gtk-General.html#gtk-get-option-group" title="gtk_get_option_group ()">gtk_get_option_group</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> open_default_display</code></em>);
59
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-exit" title="gtk_exit ()">gtk_exit</a>                            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> error_code</code></em>);
60
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-events-pending" title="gtk_events_pending ()">gtk_events_pending</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
 
57
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
58
<span class="returnvalue">GOptionGroup</span> *      <a class="link" href="gtk-General.html#gtk-get-option-group" title="gtk_get_option_group ()">gtk_get_option_group</a>                (<em class="parameter"><code><span class="type">gboolean</span> open_default_display</code></em>);
 
59
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-exit" title="gtk_exit ()">gtk_exit</a>                            (<em class="parameter"><code><span class="type">gint</span> error_code</code></em>);
 
60
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-events-pending" title="gtk_events_pending ()">gtk_events_pending</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
61
61
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-main" title="gtk_main ()">gtk_main</a>                            (<em class="parameter"><code><span class="type">void</span></code></em>);
62
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-main-level" title="gtk_main_level ()">gtk_main_level</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
 
62
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-main-level" title="gtk_main_level ()">gtk_main_level</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
63
63
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-main-quit" title="gtk_main_quit ()">gtk_main_quit</a>                       (<em class="parameter"><code><span class="type">void</span></code></em>);
64
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-main-iteration" title="gtk_main_iteration ()">gtk_main_iteration</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
65
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-main-iteration-do" title="gtk_main_iteration_do ()">gtk_main_iteration_do</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> blocking</code></em>);
66
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-main-do-event" title="gtk_main_do_event ()">gtk_main_do_event</a>                   (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);
67
 
<span class="returnvalue">void</span>                (<a class="link" href="gtk-General.html#GtkModuleInitFunc" title="GtkModuleInitFunc ()">*GtkModuleInitFunc</a>)                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
68
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);
69
 
<span class="returnvalue">void</span>                (<a class="link" href="gtk-General.html#GtkModuleDisplayInitFunc" title="GtkModuleDisplayInitFunc ()">*GtkModuleDisplayInitFunc</a>)         (<em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>);
 
64
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-main-iteration" title="gtk_main_iteration ()">gtk_main_iteration</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
 
65
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-main-iteration-do" title="gtk_main_iteration_do ()">gtk_main_iteration_do</a>               (<em class="parameter"><code><span class="type">gboolean</span> blocking</code></em>);
 
66
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-main-do-event" title="gtk_main_do_event ()">gtk_main_do_event</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);
 
67
<span class="returnvalue">void</span>                (<a class="link" href="gtk-General.html#GtkModuleInitFunc" title="GtkModuleInitFunc ()">*GtkModuleInitFunc</a>)                (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>,
 
68
                                                         <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>);
 
69
<span class="returnvalue">void</span>                (<a class="link" href="gtk-General.html#GtkModuleDisplayInitFunc" title="GtkModuleDisplayInitFunc ()">*GtkModuleDisplayInitFunc</a>)         (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>);
70
70
 
71
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-true" title="gtk_true ()">gtk_true</a>                            (<em class="parameter"><code><span class="type">void</span></code></em>);
72
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-false" title="gtk_false ()">gtk_false</a>                           (<em class="parameter"><code><span class="type">void</span></code></em>);
 
71
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-true" title="gtk_true ()">gtk_true</a>                            (<em class="parameter"><code><span class="type">void</span></code></em>);
 
72
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-false" title="gtk_false ()">gtk_false</a>                           (<em class="parameter"><code><span class="type">void</span></code></em>);
73
73
 
74
74
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-grab-add" title="gtk_grab_add ()">gtk_grab_add</a>                        (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);
75
75
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gtk-General.html#gtk-grab-get-current" title="gtk_grab_get_current ()">gtk_grab_get_current</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
76
76
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-grab-remove" title="gtk_grab_remove ()">gtk_grab_remove</a>                     (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);
77
77
 
78
78
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-init-add" title="gtk_init_add ()">gtk_init_add</a>                        (<em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
79
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
80
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-quit-add-destroy" title="gtk_quit_add_destroy ()">gtk_quit_add_destroy</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> main_level</code></em>,
 
79
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
80
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-quit-add-destroy" title="gtk_quit_add_destroy ()">gtk_quit_add_destroy</a>                (<em class="parameter"><code><span class="type">guint</span> main_level</code></em>,
81
81
                                                         <em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>);
82
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-quit-add" title="gtk_quit_add ()">gtk_quit_add</a>                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> main_level</code></em>,
83
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
84
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
85
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-quit-add-full" title="gtk_quit_add_full ()">gtk_quit_add_full</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> main_level</code></em>,
86
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
87
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
88
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
89
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
90
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-quit-remove" title="gtk_quit_remove ()">gtk_quit_remove</a>                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> quit_handler_id</code></em>);
91
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-quit-remove-by-data" title="gtk_quit_remove_by_data ()">gtk_quit_remove_by_data</a>             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
92
 
 
93
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-timeout-add-full" title="gtk_timeout_add_full ()">gtk_timeout_add_full</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> interval</code></em>,
94
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
95
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
96
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
97
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
98
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-timeout-add" title="gtk_timeout_add ()">gtk_timeout_add</a>                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> interval</code></em>,
99
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
100
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
101
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-timeout-remove" title="gtk_timeout_remove ()">gtk_timeout_remove</a>                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timeout_handler_id</code></em>);
102
 
 
103
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-idle-add" title="gtk_idle_add ()">gtk_idle_add</a>                        (<em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
104
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
105
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-idle-add-priority" title="gtk_idle_add_priority ()">gtk_idle_add_priority</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
106
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
107
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
108
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-idle-add-full" title="gtk_idle_add_full ()">gtk_idle_add_full</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
109
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
110
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
111
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
112
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
113
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-idle-remove" title="gtk_idle_remove ()">gtk_idle_remove</a>                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> idle_handler_id</code></em>);
114
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-idle-remove-by-data" title="gtk_idle_remove_by_data ()">gtk_idle_remove_by_data</a>             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
115
 
 
116
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-input-add-full" title="gtk_input_add_full ()">gtk_input_add_full</a>                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> source</code></em>,
117
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Input.html#GdkInputCondition"><span class="type">GdkInputCondition</span></a> condition</code></em>,
118
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Input.html#GdkInputFunction"><span class="type">GdkInputFunction</span></a> function</code></em>,
119
 
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
120
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
121
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
122
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-input-remove" title="gtk_input_remove ()">gtk_input_remove</a>                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> input_handler_id</code></em>);
 
82
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-quit-add" title="gtk_quit_add ()">gtk_quit_add</a>                        (<em class="parameter"><code><span class="type">guint</span> main_level</code></em>,
 
83
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
84
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
85
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-quit-add-full" title="gtk_quit_add_full ()">gtk_quit_add_full</a>                   (<em class="parameter"><code><span class="type">guint</span> main_level</code></em>,
 
86
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
87
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
 
88
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
89
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);
 
90
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-quit-remove" title="gtk_quit_remove ()">gtk_quit_remove</a>                     (<em class="parameter"><code><span class="type">guint</span> quit_handler_id</code></em>);
 
91
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-quit-remove-by-data" title="gtk_quit_remove_by_data ()">gtk_quit_remove_by_data</a>             (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
92
 
 
93
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-timeout-add-full" title="gtk_timeout_add_full ()">gtk_timeout_add_full</a>                (<em class="parameter"><code><span class="type">guint32</span> interval</code></em>,
 
94
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
95
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
 
96
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
97
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);
 
98
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-timeout-add" title="gtk_timeout_add ()">gtk_timeout_add</a>                     (<em class="parameter"><code><span class="type">guint32</span> interval</code></em>,
 
99
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
100
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
101
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-timeout-remove" title="gtk_timeout_remove ()">gtk_timeout_remove</a>                  (<em class="parameter"><code><span class="type">guint</span> timeout_handler_id</code></em>);
 
102
 
 
103
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-idle-add" title="gtk_idle_add ()">gtk_idle_add</a>                        (<em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
104
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
105
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-idle-add-priority" title="gtk_idle_add_priority ()">gtk_idle_add_priority</a>               (<em class="parameter"><code><span class="type">gint</span> priority</code></em>,
 
106
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
107
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
108
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-idle-add-full" title="gtk_idle_add_full ()">gtk_idle_add_full</a>                   (<em class="parameter"><code><span class="type">gint</span> priority</code></em>,
 
109
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
110
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
 
111
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
112
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);
 
113
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-idle-remove" title="gtk_idle_remove ()">gtk_idle_remove</a>                     (<em class="parameter"><code><span class="type">guint</span> idle_handler_id</code></em>);
 
114
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-idle-remove-by-data" title="gtk_idle_remove_by_data ()">gtk_idle_remove_by_data</a>             (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
115
 
 
116
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-input-add-full" title="gtk_input_add_full ()">gtk_input_add_full</a>                  (<em class="parameter"><code><span class="type">gint</span> source</code></em>,
 
117
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Input.html#GdkInputCondition"><span class="type">GdkInputCondition</span></a> condition</code></em>,
 
118
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Input.html#GdkInputFunction"><span class="type">GdkInputFunction</span></a> function</code></em>,
 
119
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
 
120
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
121
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);
 
122
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-input-remove" title="gtk_input_remove ()">gtk_input_remove</a>                    (<em class="parameter"><code><span class="type">guint</span> input_handler_id</code></em>);
123
123
 
124
124
#define             <a class="link" href="gtk-General.html#GTK-PRIORITY-REDRAW:CAPS" title="GTK_PRIORITY_REDRAW">GTK_PRIORITY_REDRAW</a>
125
125
#define             <a class="link" href="gtk-General.html#GTK-PRIORITY-RESIZE:CAPS" title="GTK_PRIORITY_RESIZE">GTK_PRIORITY_RESIZE</a>
128
128
#define             <a class="link" href="gtk-General.html#GTK-PRIORITY-DEFAULT:CAPS" title="GTK_PRIORITY_DEFAULT">GTK_PRIORITY_DEFAULT</a>
129
129
#define             <a class="link" href="gtk-General.html#GTK-PRIORITY-LOW:CAPS" title="GTK_PRIORITY_LOW">GTK_PRIORITY_LOW</a>
130
130
 
131
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="gtk-General.html#gtk-key-snooper-install" title="gtk_key_snooper_install ()">gtk_key_snooper_install</a>             (<em class="parameter"><code><a class="link" href="gtk-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()"><span class="type">GtkKeySnoopFunc</span></a> snooper</code></em>,
132
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> func_data</code></em>);
133
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                (<a class="link" href="gtk-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()">*GtkKeySnoopFunc</a>)                  (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *grab_widget</code></em>,
134
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>,
135
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> func_data</code></em>);
136
 
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-key-snooper-remove" title="gtk_key_snooper_remove ()">gtk_key_snooper_remove</a>              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> snooper_handler_id</code></em>);
 
131
<span class="returnvalue">guint</span>               <a class="link" href="gtk-General.html#gtk-key-snooper-install" title="gtk_key_snooper_install ()">gtk_key_snooper_install</a>             (<em class="parameter"><code><a class="link" href="gtk-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()"><span class="type">GtkKeySnoopFunc</span></a> snooper</code></em>,
 
132
                                                         <em class="parameter"><code><span class="type">gpointer</span> func_data</code></em>);
 
133
<span class="returnvalue">gint</span>                (<a class="link" href="gtk-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()">*GtkKeySnoopFunc</a>)                  (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *grab_widget</code></em>,
 
134
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>,
 
135
                                                         <em class="parameter"><code><span class="type">gpointer</span> func_data</code></em>);
 
136
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-key-snooper-remove" title="gtk_key_snooper_remove ()">gtk_key_snooper_remove</a>              (<em class="parameter"><code><span class="type">guint</span> snooper_handler_id</code></em>);
137
137
 
138
 
<a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="returnvalue">GdkEvent</span></a> *          <a class="link" href="gtk-General.html#gtk-get-current-event" title="gtk_get_current_event ()">gtk_get_current_event</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
139
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <a class="link" href="gtk-General.html#gtk-get-current-event-time" title="gtk_get_current_event_time ()">gtk_get_current_event_time</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
140
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gtk-General.html#gtk-get-current-event-state" title="gtk_get_current_event_state ()">gtk_get_current_event_state</a>         (<em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);
141
 
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gtk-General.html#gtk-get-event-widget" title="gtk_get_event_widget ()">gtk_get_event_widget</a>                (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);
 
138
<a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="returnvalue">GdkEvent</span></a> *          <a class="link" href="gtk-General.html#gtk-get-current-event" title="gtk_get_current_event ()">gtk_get_current_event</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
 
139
<span class="returnvalue">guint32</span>             <a class="link" href="gtk-General.html#gtk-get-current-event-time" title="gtk_get_current_event_time ()">gtk_get_current_event_time</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
 
140
<span class="returnvalue">gboolean</span>            <a class="link" href="gtk-General.html#gtk-get-current-event-state" title="gtk_get_current_event_state ()">gtk_get_current_event_state</a>         (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);
 
141
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="gtk-General.html#gtk-get-event-widget" title="gtk_get_event_widget ()">gtk_get_event_widget</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);
142
142
<span class="returnvalue">void</span>                <a class="link" href="gtk-General.html#gtk-propagate-event" title="gtk_propagate_event ()">gtk_propagate_event</a>                 (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
143
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);
 
143
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);
144
144
</pre>
145
145
</div>
146
146
<div class="refsect1">
175
175
to the main loop and await more user input.
176
176
</p>
177
177
<div class="example">
178
 
<a name="id398712"></a><p class="title"><b>Example 2. Typical <code class="function">main</code> function for a GTK+ application</b></p>
 
178
<a name="id538524"></a><p class="title"><b>Example 2. Typical <code class="function">main</code> function for a GTK+ application</b></p>
179
179
<div class="example-contents">
180
180
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
181
181
    <tbody>
224
224
</div>
225
225
<br class="example-break"><p>
226
226
It's OK to use the GLib main loop directly instead of <a class="link" href="gtk-General.html#gtk-main" title="gtk_main ()"><code class="function">gtk_main()</code></a>,
227
 
though it involves slightly more typing. See <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainLoop"><span class="type">GMainLoop</span></a> in the GLib
 
227
though it involves slightly more typing. See <span class="type">GMainLoop</span> in the GLib
228
228
documentation.
229
229
</p>
230
230
</div>
232
232
<a name="gtk-General.details"></a><h2>Details</h2>
233
233
<div class="refsect2">
234
234
<a name="gtk-set-locale"></a><h3>gtk_set_locale ()</h3>
235
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gtk_set_locale                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
235
<pre class="programlisting"><span class="returnvalue">gchar</span> *             gtk_set_locale                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
236
236
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
237
237
<h3 class="title">Warning</h3>
238
 
<p><code class="literal">gtk_set_locale</code> has been deprecated since version 2.24 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-running.html#setlocale"><code class="function">setlocale()</code></a> directly</p>
 
238
<p><code class="literal">gtk_set_locale</code> has been deprecated since version 2.24 and should not be used in newly-written code. Use <code class="function">setlocale()</code> directly</p>
239
239
</div>
240
240
<p>
241
241
Initializes internationalization support for GTK+. <a class="link" href="gtk-General.html#gtk-init" title="gtk_init ()"><code class="function">gtk_init()</code></a>
265
265
<td>a string corresponding to the locale set, typically in the
266
266
form lang_COUNTRY, where lang is an ISO-639 language code, and
267
267
COUNTRY is an ISO-3166 country code. On Unix, this form matches the
268
 
result of the <a href="http://library.gnome.org/devel/glib/unstable/glib-running.html#setlocale"><code class="function">setlocale()</code></a>; it is also used on other machines, such as
 
268
result of the <code class="function">setlocale()</code>; it is also used on other machines, such as
269
269
Windows, where the C library returns a different result. The string is
270
270
owned by GTK+ and should not be modified or freed.</td>
271
271
</tr></tbody>
290
290
<hr>
291
291
<div class="refsect2">
292
292
<a name="gtk-get-default-language"></a><h3>gtk_get_default_language ()</h3>
293
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="returnvalue">PangoLanguage</span></a> *     gtk_get_default_language            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
293
<pre class="programlisting"><a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="returnvalue">PangoLanguage</span></a> *     gtk_get_default_language            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
294
294
<p>
295
 
Returns the <a href="/usr/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="type">PangoLanguage</span></a> for the default language currently in
 
295
Returns the <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="type">PangoLanguage</span></a> for the default language currently in
296
296
effect. (Note that this can change over the life of an
297
297
application.)  The default language is derived from the current
298
298
locale. It determines, for example, whether GTK+ uses the
299
299
right-to-left or left-to-right text direction.
300
300
</p>
301
301
<p>
302
 
This function is equivalent to <a href="/usr/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#pango-language-get-default"><code class="function">pango_language_get_default()</code></a>.  See
 
302
This function is equivalent to <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#pango-language-get-default"><code class="function">pango_language_get_default()</code></a>.  See
303
303
that function for details.
304
304
</p>
305
305
<div class="variablelist"><table border="0" class="variablelist">
309
309
</colgroup>
310
310
<tbody><tr>
311
311
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
312
 
<td>the default language as a <a href="/usr/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="type">PangoLanguage</span></a>, must not be
 
312
<td>the default language as a <a href="/home/mclasen/gnome/share/gtk-doc/html/pango/pango-Scripts-and-Languages.html#PangoLanguage"><span class="type">PangoLanguage</span></a>, must not be
313
313
freed</td>
314
314
</tr></tbody>
315
315
</table></div>
317
317
<hr>
318
318
<div class="refsect2">
319
319
<a name="gtk-parse-args"></a><h3>gtk_parse_args ()</h3>
320
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_parse_args                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
320
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_parse_args                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
321
321
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
322
322
<p>
323
323
Parses command line arguments, and initializes global
324
324
attributes of GTK+, but does not actually open a connection
325
 
to a display. (See <a href="../gdk/GdkDisplay.html#gdk-display-open"><code class="function">gdk_display_open()</code></a>, <a href="../gdk/gdk-General.html#gdk-get-display-arg-name"><code class="function">gdk_get_display_arg_name()</code></a>)
 
325
to a display. (See <a href="http://library.gnome.org/devel/gdk3/GdkDisplay.html#gdk-display-open"><code class="function">gdk_display_open()</code></a>, <a href="http://library.gnome.org/devel/gdk3/gdk-General.html#gdk-get-display-arg-name"><code class="function">gdk_get_display_arg_name()</code></a>)
326
326
</p>
327
327
<p>
328
328
Any arguments used by GTK+ or GDK are removed from the array and
352
352
<tr>
353
353
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
354
354
<td>
355
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if initialization succeeded, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
 
355
<code class="literal">TRUE</code> if initialization succeeded, otherwise <code class="literal">FALSE</code>.</td>
356
356
</tr>
357
357
</tbody>
358
358
</table></div>
374
374
<p>
375
375
Note that there are some alternative ways to initialize GTK+:
376
376
if you are calling <a class="link" href="gtk-General.html#gtk-parse-args" title="gtk_parse_args ()"><code class="function">gtk_parse_args()</code></a>, <a class="link" href="gtk-General.html#gtk-init-check" title="gtk_init_check ()"><code class="function">gtk_init_check()</code></a>,
377
 
<a class="link" href="gtk-General.html#gtk-init-with-args" title="gtk_init_with_args ()"><code class="function">gtk_init_with_args()</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a> with
 
377
<a class="link" href="gtk-General.html#gtk-init-with-args" title="gtk_init_with_args ()"><code class="function">gtk_init_with_args()</code></a> or <code class="function">g_option_context_parse()</code> with
378
378
the option group returned by <a class="link" href="gtk-General.html#gtk-get-option-group" title="gtk_get_option_group ()"><code class="function">gtk_get_option_group()</code></a>,
379
379
you <span class="emphasis"><em>don't</em></span> have to call <a class="link" href="gtk-General.html#gtk-init" title="gtk_init ()"><code class="function">gtk_init()</code></a>.
380
380
</p>
438
438
<hr>
439
439
<div class="refsect2">
440
440
<a name="gtk-init-check"></a><h3>gtk_init_check ()</h3>
441
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_init_check                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
441
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_init_check                      (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
442
442
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
443
443
<p>
444
444
This function does the same work as <a class="link" href="gtk-General.html#gtk-init" title="gtk_init ()"><code class="function">gtk_init()</code></a> with only
445
445
a single change: It does not terminate the program if the GUI can't be
446
 
initialized. Instead it returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.
 
446
initialized. Instead it returns <code class="literal">FALSE</code> on failure.
447
447
</p>
448
448
<p>
449
449
This way the application can fall back to some other means of communication 
470
470
<tr>
471
471
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
472
472
<td>
473
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the GUI has been successfully initialized,
474
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 
473
<code class="literal">TRUE</code> if the GUI has been successfully initialized,
 
474
<code class="literal">FALSE</code> otherwise.</td>
475
475
</tr>
476
476
</tbody>
477
477
</table></div>
479
479
<hr>
480
480
<div class="refsect2">
481
481
<a name="gtk-init-with-args"></a><h3>gtk_init_with_args ()</h3>
482
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_init_with_args                  (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
 
482
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_init_with_args                  (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
483
483
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>,
484
484
                                                         <em class="parameter"><code>const <span class="type">char</span> *parameter_string</code></em>,
485
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry"><span class="type">GOptionEntry</span></a> *entries</code></em>,
 
485
                                                         <em class="parameter"><code><span class="type">GOptionEntry</span> *entries</code></em>,
486
486
                                                         <em class="parameter"><code>const <span class="type">char</span> *translation_domain</code></em>,
487
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
487
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
488
488
<p>
489
489
This function does the same work as <a class="link" href="gtk-General.html#gtk-init-check" title="gtk_init_check ()"><code class="function">gtk_init_check()</code></a>. 
490
490
Additionally, it allows you to add your own commandline options, 
517
517
</tr>
518
518
<tr>
519
519
<td><p><span class="term"><em class="parameter"><code>entries</code></em> :</span></p></td>
520
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array
521
 
of <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry"><span class="type">GOptionEntry</span></a>s describing the options of your program. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
 
520
<td>a <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated array
 
521
of <span class="type">GOptionEntry</span>s describing the options of your program. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
522
522
</td>
523
523
</tr>
524
524
<tr>
525
525
<td><p><span class="term"><em class="parameter"><code>translation_domain</code></em> :</span></p></td>
526
526
<td>a translation domain to use for translating
527
527
the <code class="option">--help</code> output for the options in <em class="parameter"><code>entries</code></em>
528
 
with <code class="function">gettext()</code>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
528
with <code class="function">gettext()</code>, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
529
529
</td>
530
530
</tr>
531
531
<tr>
535
535
<tr>
536
536
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
537
537
<td>
538
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the GUI has been successfully initialized,
539
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 
538
<code class="literal">TRUE</code> if the GUI has been successfully initialized,
 
539
<code class="literal">FALSE</code> otherwise.</td>
540
540
</tr>
541
541
</tbody>
542
542
</table></div>
545
545
<hr>
546
546
<div class="refsect2">
547
547
<a name="gtk-get-option-group"></a><h3>gtk_get_option_group ()</h3>
548
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> *      gtk_get_option_group                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> open_default_display</code></em>);</pre>
 
548
<pre class="programlisting"><span class="returnvalue">GOptionGroup</span> *      gtk_get_option_group                (<em class="parameter"><code><span class="type">gboolean</span> open_default_display</code></em>);</pre>
549
549
<p>
550
 
Returns a <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> for the commandline arguments recognized
551
 
by GTK+ and GDK. You should add this group to your <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a> 
552
 
with <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#g-option-context-add-group"><code class="function">g_option_context_add_group()</code></a>, if you are using 
553
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a> to parse your commandline arguments.
 
550
Returns a <span class="type">GOptionGroup</span> for the commandline arguments recognized
 
551
by GTK+ and GDK. You should add this group to your <span class="type">GOptionContext</span> 
 
552
with <code class="function">g_option_context_add_group()</code>, if you are using 
 
553
<code class="function">g_option_context_parse()</code> to parse your commandline arguments.
554
554
</p>
555
555
<div class="variablelist"><table border="0" class="variablelist">
556
556
<colgroup>
565
565
</tr>
566
566
<tr>
567
567
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
568
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> for the commandline arguments recognized
 
568
<td>a <span class="type">GOptionGroup</span> for the commandline arguments recognized
569
569
by GTK+</td>
570
570
</tr>
571
571
</tbody>
575
575
<hr>
576
576
<div class="refsect2">
577
577
<a name="gtk-exit"></a><h3>gtk_exit ()</h3>
578
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_exit                            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> error_code</code></em>);</pre>
 
578
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_exit                            (<em class="parameter"><code><span class="type">gint</span> error_code</code></em>);</pre>
579
579
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
580
580
<h3 class="title">Warning</h3>
581
581
<p><code class="literal">gtk_exit</code> is deprecated and should not be used in newly-written code. Use the standard <code class="function">exit()</code> function instead.</p>
600
600
<hr>
601
601
<div class="refsect2">
602
602
<a name="gtk-events-pending"></a><h3>gtk_events_pending ()</h3>
603
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_events_pending                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
603
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_events_pending                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
604
604
<p>
605
605
Checks if any events are pending. This can be used to update the GUI
606
606
and invoke timeouts etc. while doing some time intensive computation.
607
607
</p>
608
608
<div class="example">
609
 
<a name="id414549"></a><p class="title"><b>Example 3. Updating the GUI during a long computation.</b></p>
 
609
<a name="id552231"></a><p class="title"><b>Example 3. Updating the GUI during a long computation.</b></p>
610
610
<div class="example-contents">
611
611
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
612
612
    <tbody>
637
637
<tbody><tr>
638
638
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
639
639
<td>
640
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if any events are pending, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 
640
<code class="literal">TRUE</code> if any events are pending, <code class="literal">FALSE</code> otherwise.</td>
641
641
</tr></tbody>
642
642
</table></div>
643
643
</div>
654
654
<hr>
655
655
<div class="refsect2">
656
656
<a name="gtk-main-level"></a><h3>gtk_main_level ()</h3>
657
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_main_level                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
657
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_main_level                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
658
658
<p>
659
659
Asks for the current nesting level of the main loop. This can be useful
660
660
when calling <a class="link" href="gtk-General.html#gtk-quit-add" title="gtk_quit_add ()"><code class="function">gtk_quit_add()</code></a>.
682
682
<hr>
683
683
<div class="refsect2">
684
684
<a name="gtk-main-iteration"></a><h3>gtk_main_iteration ()</h3>
685
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_main_iteration                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
685
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_main_iteration                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
686
686
<p>
687
687
Runs a single iteration of the mainloop. If no events are waiting to be
688
688
processed GTK+ will block until the next event is noticed. If you don't
697
697
<tbody><tr>
698
698
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
699
699
<td>
700
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="gtk-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the innermost mainloop.</td>
 
700
<code class="literal">TRUE</code> if <a class="link" href="gtk-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the innermost mainloop.</td>
701
701
</tr></tbody>
702
702
</table></div>
703
703
</div>
704
704
<hr>
705
705
<div class="refsect2">
706
706
<a name="gtk-main-iteration-do"></a><h3>gtk_main_iteration_do ()</h3>
707
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_main_iteration_do               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> blocking</code></em>);</pre>
 
707
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_main_iteration_do               (<em class="parameter"><code><span class="type">gboolean</span> blocking</code></em>);</pre>
708
708
<p>
709
709
Runs a single iteration of the mainloop. If no events are available either
710
710
return or block dependent on the value of <em class="parameter"><code>blocking</code></em>.
718
718
<tr>
719
719
<td><p><span class="term"><em class="parameter"><code>blocking</code></em> :</span></p></td>
720
720
<td>
721
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if you want GTK+ to block if no events are pending.</td>
 
721
<code class="literal">TRUE</code> if you want GTK+ to block if no events are pending.</td>
722
722
</tr>
723
723
<tr>
724
724
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
725
725
<td>
726
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="gtk-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the innermost mainloop.</td>
 
726
<code class="literal">TRUE</code> if <a class="link" href="gtk-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the innermost mainloop.</td>
727
727
</tr>
728
728
</tbody>
729
729
</table></div>
731
731
<hr>
732
732
<div class="refsect2">
733
733
<a name="gtk-main-do-event"></a><h3>gtk_main_do_event ()</h3>
734
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_main_do_event                   (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
 
734
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_main_do_event                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
735
735
<p>
736
736
Processes a single GDK event. This is public only to allow filtering of events
737
737
between GDK and GTK+. You will not usually need to call this function directly.
805
805
<hr>
806
806
<div class="refsect2">
807
807
<a name="GtkModuleInitFunc"></a><h3>GtkModuleInitFunc ()</h3>
808
 
<pre class="programlisting"><span class="returnvalue">void</span>                (*GtkModuleInitFunc)                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
809
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);</pre>
 
808
<pre class="programlisting"><span class="returnvalue">void</span>                (*GtkModuleInitFunc)                (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>,
 
809
                                                         <em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>);</pre>
810
810
<p>
811
811
Each GTK+ module must have a function <code class="function">gtk_module_init()</code> with this prototype.
812
812
This function is called after loading the module with the <em class="parameter"><code>argc</code></em> and <em class="parameter"><code>argv</code></em>
832
832
<hr>
833
833
<div class="refsect2">
834
834
<a name="GtkModuleDisplayInitFunc"></a><h3>GtkModuleDisplayInitFunc ()</h3>
835
 
<pre class="programlisting"><span class="returnvalue">void</span>                (*GtkModuleDisplayInitFunc)         (<em class="parameter"><code><a href="../gdk/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>);</pre>
 
835
<pre class="programlisting"><span class="returnvalue">void</span>                (*GtkModuleDisplayInitFunc)         (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/GdkDisplay.html"><span class="type">GdkDisplay</span></a> *display</code></em>);</pre>
836
836
<p>
837
837
</p>
838
838
<p class="since">Since 2.2</p>
840
840
<hr>
841
841
<div class="refsect2">
842
842
<a name="gtk-true"></a><h3>gtk_true ()</h3>
843
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_true                            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
843
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_true                            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
844
844
<p>
845
 
All this function does it to return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. This can be useful for example
 
845
All this function does it to return <code class="literal">TRUE</code>. This can be useful for example
846
846
if you want to inhibit the deletion of a window. Of course you should
847
847
not do this as the user expects a reaction from clicking the close
848
848
icon of the window...
849
849
</p>
850
850
<div class="example">
851
 
<a name="id415470"></a><p class="title"><b>Example 4. A persistent window</b></p>
 
851
<a name="id553171"></a><p class="title"><b>Example 4. A persistent window</b></p>
852
852
<div class="example-contents">
853
853
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
854
854
    <tbody>
880
880
<span class="normal">  </span><span class="function"><a href="gtk-General.html#gtk-init">gtk_init</a></span><span class="symbol">(</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argv </span><span class="symbol">);</span>
881
881
<span class="normal">  win </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkWindow.html#gtk-window-new">gtk_window_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk-Standard-Enumerations.html#GTK-WINDOW-TOPLEVEL:CAPS">GTK_WINDOW_TOPLEVEL</a></span><span class="symbol">);</span>
882
882
<span class="normal">  </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">win</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"delete-event"</span><span class="symbol">,</span>
883
 
<span class="normal">                    </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk-General.html#gtk-true">gtk_true</a></span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
 
883
<span class="normal">                    </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk-General.html#gtk-true">gtk_true</a></span><span class="symbol">),</span><span class="normal"> <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
884
884
<span class="normal">  </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">win</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"destroy"</span><span class="symbol">,</span>
885
 
<span class="normal">            </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk-General.html#gtk-main-quit">gtk_main_quit</a></span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
 
885
<span class="normal">            </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk-General.html#gtk-main-quit">gtk_main_quit</a></span><span class="symbol">),</span><span class="normal"> <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
886
886
<span class="normal">  but </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkButton.html#gtk-button-new-with-label">gtk_button_new_with_label</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Close yourself. I mean it!"</span><span class="symbol">);</span>
887
887
<span class="normal">  </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect-swapped">g_signal_connect_swapped</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">but</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"clicked"</span><span class="symbol">,</span>
888
888
<span class="normal">          </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="GtkObject.html#gtk-object-destroy">gtk_object_destroy</a></span><span class="symbol">),</span><span class="normal"> win</span><span class="symbol">);</span>
904
904
</colgroup>
905
905
<tbody><tr>
906
906
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
907
 
<td><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a></td>
 
907
<td><code class="literal">TRUE</code></td>
908
908
</tr></tbody>
909
909
</table></div>
910
910
</div>
911
911
<hr>
912
912
<div class="refsect2">
913
913
<a name="gtk-false"></a><h3>gtk_false ()</h3>
914
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_false                           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
914
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_false                           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
915
915
<p>
916
916
Analogical to <a class="link" href="gtk-General.html#gtk-true" title="gtk_true ()"><code class="function">gtk_true()</code></a> this function does nothing
917
 
but always returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
 
917
but always returns <code class="literal">FALSE</code>.
918
918
</p>
919
919
<div class="variablelist"><table border="0" class="variablelist">
920
920
<colgroup>
923
923
</colgroup>
924
924
<tbody><tr>
925
925
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
926
 
<td><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></td>
 
926
<td><code class="literal">FALSE</code></td>
927
927
</tr></tbody>
928
928
</table></div>
929
929
</div>
969
969
<tbody><tr>
970
970
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
971
971
<td>The widget which currently
972
 
has the grab or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no grab is active. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
972
has the grab or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if no grab is active. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
973
973
</td>
974
974
</tr></tbody>
975
975
</table></div>
1000
1000
<div class="refsect2">
1001
1001
<a name="gtk-init-add"></a><h3>gtk_init_add ()</h3>
1002
1002
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_init_add                        (<em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1003
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1003
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1004
1004
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1005
1005
<h3 class="title">Warning</h3>
1006
1006
<p><code class="literal">gtk_init_add</code> is deprecated and should not be used in newly-written code. This function is going to be removed in GTK+ 3.0</p>
1028
1028
<hr>
1029
1029
<div class="refsect2">
1030
1030
<a name="gtk-quit-add-destroy"></a><h3>gtk_quit_add_destroy ()</h3>
1031
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_quit_add_destroy                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> main_level</code></em>,
 
1031
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_quit_add_destroy                (<em class="parameter"><code><span class="type">guint</span> main_level</code></em>,
1032
1032
                                                         <em class="parameter"><code><a class="link" href="GtkObject.html" title="GtkObject"><span class="type">GtkObject</span></a> *object</code></em>);</pre>
1033
1033
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1034
1034
<h3 class="title">Warning</h3>
1058
1058
<hr>
1059
1059
<div class="refsect2">
1060
1060
<a name="gtk-quit-add"></a><h3>gtk_quit_add ()</h3>
1061
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_quit_add                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> main_level</code></em>,
 
1061
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_quit_add                        (<em class="parameter"><code><span class="type">guint</span> main_level</code></em>,
1062
1062
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1063
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1063
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1064
1064
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1065
1065
<h3 class="title">Warning</h3>
1066
1066
<p><code class="literal">gtk_quit_add</code> is deprecated and should not be used in newly-written code. This function is going to be removed in GTK+ 3.0</p>
1092
1092
<tr>
1093
1093
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1094
1094
<td>A handle for this quit handler (you need this for <a class="link" href="gtk-General.html#gtk-quit-remove" title="gtk_quit_remove ()"><code class="function">gtk_quit_remove()</code></a>)
1095
 
or 0 if you passed a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> pointer in <em class="parameter"><code>function</code></em>.</td>
 
1095
or 0 if you passed a <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> pointer in <em class="parameter"><code>function</code></em>.</td>
1096
1096
</tr>
1097
1097
</tbody>
1098
1098
</table></div>
1100
1100
<hr>
1101
1101
<div class="refsect2">
1102
1102
<a name="gtk-quit-add-full"></a><h3>gtk_quit_add_full ()</h3>
1103
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_quit_add_full                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> main_level</code></em>,
 
1103
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_quit_add_full                   (<em class="parameter"><code><span class="type">guint</span> main_level</code></em>,
1104
1104
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1105
1105
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
1106
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
1107
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
 
1106
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
1107
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
1108
1108
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1109
1109
<h3 class="title">Warning</h3>
1110
1110
<p><code class="literal">gtk_quit_add_full</code> is deprecated and should not be used in newly-written code. This function is going to be removed in GTK+ 3.0</p>
1139
1139
</tr>
1140
1140
<tr>
1141
1141
<td><p><span class="term"><em class="parameter"><code>marshal</code></em> :</span></p></td>
1142
 
<td>The marshaller to be used. If this is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>function</code></em> is
 
1142
<td>The marshaller to be used. If this is non-<a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>function</code></em> is
1143
1143
ignored.</td>
1144
1144
</tr>
1145
1145
<tr>
1153
1153
<tr>
1154
1154
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1155
1155
<td>A handle for this quit handler (you need this for <a class="link" href="gtk-General.html#gtk-quit-remove" title="gtk_quit_remove ()"><code class="function">gtk_quit_remove()</code></a>)
1156
 
or 0 if you passed a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> pointer in <em class="parameter"><code>function</code></em>.</td>
 
1156
or 0 if you passed a <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> pointer in <em class="parameter"><code>function</code></em>.</td>
1157
1157
</tr>
1158
1158
</tbody>
1159
1159
</table></div>
1161
1161
<hr>
1162
1162
<div class="refsect2">
1163
1163
<a name="gtk-quit-remove"></a><h3>gtk_quit_remove ()</h3>
1164
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_quit_remove                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> quit_handler_id</code></em>);</pre>
 
1164
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_quit_remove                     (<em class="parameter"><code><span class="type">guint</span> quit_handler_id</code></em>);</pre>
1165
1165
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1166
1166
<h3 class="title">Warning</h3>
1167
1167
<p><code class="literal">gtk_quit_remove</code> is deprecated and should not be used in newly-written code. This function is going to be removed in GTK+ 3.0</p>
1183
1183
<hr>
1184
1184
<div class="refsect2">
1185
1185
<a name="gtk-quit-remove-by-data"></a><h3>gtk_quit_remove_by_data ()</h3>
1186
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_quit_remove_by_data             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1186
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_quit_remove_by_data             (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1187
1187
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1188
1188
<h3 class="title">Warning</h3>
1189
1189
<p><code class="literal">gtk_quit_remove_by_data</code> is deprecated and should not be used in newly-written code. This function is going to be removed in GTK+ 3.0</p>
1205
1205
<hr>
1206
1206
<div class="refsect2">
1207
1207
<a name="gtk-timeout-add-full"></a><h3>gtk_timeout_add_full ()</h3>
1208
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_timeout_add_full                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> interval</code></em>,
 
1208
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_timeout_add_full                (<em class="parameter"><code><span class="type">guint32</span> interval</code></em>,
1209
1209
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1210
1210
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
1211
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
1212
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
 
1211
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
1212
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
1213
1213
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1214
1214
<h3 class="title">Warning</h3>
1215
 
<p><code class="literal">gtk_timeout_add_full</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-timeout-add-full"><code class="function">g_timeout_add_full()</code></a> instead.</p>
 
1215
<p><code class="literal">gtk_timeout_add_full</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_timeout_add_full()</code> instead.</p>
1216
1216
</div>
1217
1217
<p>
1218
1218
Registers a function to be called periodically. The function will be called
1219
 
repeatedly after <em class="parameter"><code>interval</code></em> milliseconds until it returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> at which
 
1219
repeatedly after <em class="parameter"><code>interval</code></em> milliseconds until it returns <code class="literal">FALSE</code> at which
1220
1220
point the timeout is destroyed and will not be called again.
1221
1221
</p>
1222
1222
<div class="variablelist"><table border="0" class="variablelist">
1236
1236
</tr>
1237
1237
<tr>
1238
1238
<td><p><span class="term"><em class="parameter"><code>marshal</code></em> :</span></p></td>
1239
 
<td>The marshaller to use instead of the function (if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</td>
 
1239
<td>The marshaller to use instead of the function (if non-<a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>).</td>
1240
1240
</tr>
1241
1241
<tr>
1242
1242
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1244
1244
</tr>
1245
1245
<tr>
1246
1246
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
1247
 
<td>Function to call when the timeout is destroyed or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 
1247
<td>Function to call when the timeout is destroyed or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
1248
1248
</tr>
1249
1249
<tr>
1250
1250
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1256
1256
<hr>
1257
1257
<div class="refsect2">
1258
1258
<a name="gtk-timeout-add"></a><h3>gtk_timeout_add ()</h3>
1259
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_timeout_add                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> interval</code></em>,
 
1259
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_timeout_add                     (<em class="parameter"><code><span class="type">guint32</span> interval</code></em>,
1260
1260
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1261
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1261
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1262
1262
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1263
1263
<h3 class="title">Warning</h3>
1264
 
<p><code class="literal">gtk_timeout_add</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-timeout-add"><code class="function">g_timeout_add()</code></a> instead.</p>
 
1264
<p><code class="literal">gtk_timeout_add</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_timeout_add()</code> instead.</p>
1265
1265
</div>
1266
1266
<p>
1267
1267
Registers a function to be called periodically. The function will be called
1268
 
repeatedly after <em class="parameter"><code>interval</code></em> milliseconds until it returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> at which
 
1268
repeatedly after <em class="parameter"><code>interval</code></em> milliseconds until it returns <code class="literal">FALSE</code> at which
1269
1269
point the timeout is destroyed and will not be called again.
1270
1270
</p>
1271
1271
<div class="variablelist"><table border="0" class="variablelist">
1297
1297
<hr>
1298
1298
<div class="refsect2">
1299
1299
<a name="gtk-timeout-remove"></a><h3>gtk_timeout_remove ()</h3>
1300
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_timeout_remove                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timeout_handler_id</code></em>);</pre>
 
1300
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_timeout_remove                  (<em class="parameter"><code><span class="type">guint</span> timeout_handler_id</code></em>);</pre>
1301
1301
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1302
1302
<h3 class="title">Warning</h3>
1303
 
<p><code class="literal">gtk_timeout_remove</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-remove"><code class="function">g_source_remove()</code></a> instead.</p>
 
1303
<p><code class="literal">gtk_timeout_remove</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_source_remove()</code> instead.</p>
1304
1304
</div>
1305
1305
<p>
1306
1306
Removes the given timeout destroying all information about it.
1319
1319
<hr>
1320
1320
<div class="refsect2">
1321
1321
<a name="gtk-idle-add"></a><h3>gtk_idle_add ()</h3>
1322
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_idle_add                        (<em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1323
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1322
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_idle_add                        (<em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
 
1323
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1324
1324
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1325
1325
<h3 class="title">Warning</h3>
1326
 
<p><code class="literal">gtk_idle_add</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-idle-add"><code class="function">g_idle_add()</code></a> instead.</p>
 
1326
<p><code class="literal">gtk_idle_add</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_idle_add()</code> instead.</p>
1327
1327
</div>
1328
1328
<p>
1329
1329
Causes the mainloop to call the given function whenever no events with
1354
1354
<hr>
1355
1355
<div class="refsect2">
1356
1356
<a name="gtk-idle-add-priority"></a><h3>gtk_idle_add_priority ()</h3>
1357
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_idle_add_priority               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
 
1357
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_idle_add_priority               (<em class="parameter"><code><span class="type">gint</span> priority</code></em>,
1358
1358
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1359
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1359
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1360
1360
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1361
1361
<h3 class="title">Warning</h3>
1362
 
<p><code class="literal">gtk_idle_add_priority</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-idle-add-full"><code class="function">g_idle_add_full()</code></a> instead.</p>
 
1362
<p><code class="literal">gtk_idle_add_priority</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_idle_add_full()</code> instead.</p>
1363
1363
</div>
1364
1364
<p>
1365
1365
Like <a class="link" href="gtk-General.html#gtk-idle-add" title="gtk_idle_add ()"><code class="function">gtk_idle_add()</code></a> this function allows you to have a function called
1374
1374
<tbody>
1375
1375
<tr>
1376
1376
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
1377
 
<td>The priority which should not be above <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-HIGH-IDLE:CAPS"><code class="literal">G_PRIORITY_HIGH_IDLE</code></a>.
 
1377
<td>The priority which should not be above <code class="literal">G_PRIORITY_HIGH_IDLE</code>.
1378
1378
Note that you will interfere with GTK+ if you use a priority above
1379
1379
<a class="link" href="gtk-General.html#GTK-PRIORITY-RESIZE:CAPS" title="GTK_PRIORITY_RESIZE"><code class="literal">GTK_PRIORITY_RESIZE</code></a>.</td>
1380
1380
</tr>
1396
1396
<hr>
1397
1397
<div class="refsect2">
1398
1398
<a name="gtk-idle-add-full"></a><h3>gtk_idle_add_full ()</h3>
1399
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_idle_add_full                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
 
1399
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_idle_add_full                   (<em class="parameter"><code><span class="type">gint</span> priority</code></em>,
1400
1400
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkFunction" title="GtkFunction ()"><span class="type">GtkFunction</span></a> function</code></em>,
1401
1401
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
1402
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
1403
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
 
1402
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
1403
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
1404
1404
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1405
1405
<h3 class="title">Warning</h3>
1406
 
<p><code class="literal">gtk_idle_add_full</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-idle-add-full"><code class="function">g_idle_add_full()</code></a> instead.</p>
 
1406
<p><code class="literal">gtk_idle_add_full</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_idle_add_full()</code> instead.</p>
1407
1407
</div>
1408
1408
<p>
1409
1409
Like <a class="link" href="gtk-General.html#gtk-idle-add" title="gtk_idle_add ()"><code class="function">gtk_idle_add()</code></a> this function allows you to have a function called
1418
1418
<tbody>
1419
1419
<tr>
1420
1420
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
1421
 
<td>The priority which should not be above <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-HIGH-IDLE:CAPS"><code class="literal">G_PRIORITY_HIGH_IDLE</code></a>.
 
1421
<td>The priority which should not be above <code class="literal">G_PRIORITY_HIGH_IDLE</code>.
1422
1422
Note that you will interfere with GTK+ if you use a priority above
1423
1423
<a class="link" href="gtk-General.html#GTK-PRIORITY-RESIZE:CAPS" title="GTK_PRIORITY_RESIZE"><code class="literal">GTK_PRIORITY_RESIZE</code></a>.</td>
1424
1424
</tr>
1428
1428
</tr>
1429
1429
<tr>
1430
1430
<td><p><span class="term"><em class="parameter"><code>marshal</code></em> :</span></p></td>
1431
 
<td>The marshaller to use instead of the function (if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</td>
 
1431
<td>The marshaller to use instead of the function (if non-<a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>).</td>
1432
1432
</tr>
1433
1433
<tr>
1434
1434
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1436
1436
</tr>
1437
1437
<tr>
1438
1438
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
1439
 
<td>Function to call when the timeout is destroyed or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 
1439
<td>Function to call when the timeout is destroyed or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
1440
1440
</tr>
1441
1441
<tr>
1442
1442
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1448
1448
<hr>
1449
1449
<div class="refsect2">
1450
1450
<a name="gtk-idle-remove"></a><h3>gtk_idle_remove ()</h3>
1451
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_idle_remove                     (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> idle_handler_id</code></em>);</pre>
 
1451
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_idle_remove                     (<em class="parameter"><code><span class="type">guint</span> idle_handler_id</code></em>);</pre>
1452
1452
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1453
1453
<h3 class="title">Warning</h3>
1454
 
<p><code class="literal">gtk_idle_remove</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-remove"><code class="function">g_source_remove()</code></a> instead.</p>
 
1454
<p><code class="literal">gtk_idle_remove</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_source_remove()</code> instead.</p>
1455
1455
</div>
1456
1456
<p>
1457
1457
Removes the idle function with the given id.
1470
1470
<hr>
1471
1471
<div class="refsect2">
1472
1472
<a name="gtk-idle-remove-by-data"></a><h3>gtk_idle_remove_by_data ()</h3>
1473
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_idle_remove_by_data             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1473
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_idle_remove_by_data             (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1474
1474
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1475
1475
<h3 class="title">Warning</h3>
1476
 
<p><code class="literal">gtk_idle_remove_by_data</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-idle-remove-by-data"><code class="function">g_idle_remove_by_data()</code></a> instead.</p>
 
1476
<p><code class="literal">gtk_idle_remove_by_data</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_idle_remove_by_data()</code> instead.</p>
1477
1477
</div>
1478
1478
<p>
1479
1479
Removes the idle function identified by the user data.
1492
1492
<hr>
1493
1493
<div class="refsect2">
1494
1494
<a name="gtk-input-add-full"></a><h3>gtk_input_add_full ()</h3>
1495
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_input_add_full                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> source</code></em>,
1496
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Input.html#GdkInputCondition"><span class="type">GdkInputCondition</span></a> condition</code></em>,
1497
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Input.html#GdkInputFunction"><span class="type">GdkInputFunction</span></a> function</code></em>,
 
1495
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_input_add_full                  (<em class="parameter"><code><span class="type">gint</span> source</code></em>,
 
1496
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Input.html#GdkInputCondition"><span class="type">GdkInputCondition</span></a> condition</code></em>,
 
1497
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Input.html#GdkInputFunction"><span class="type">GdkInputFunction</span></a> function</code></em>,
1498
1498
                                                         <em class="parameter"><code><a class="link" href="gtk-Types.html#GtkCallbackMarshal" title="GtkCallbackMarshal ()"><span class="type">GtkCallbackMarshal</span></a> marshal</code></em>,
1499
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
1500
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
 
1499
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
1500
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
1501
1501
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1502
1502
<h3 class="title">Warning</h3>
1503
 
<p><code class="literal">gtk_input_add_full</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#g-io-add-watch-full"><code class="function">g_io_add_watch_full()</code></a> instead.</p>
 
1503
<p><code class="literal">gtk_input_add_full</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_io_add_watch_full()</code> instead.</p>
1504
1504
</div>
1505
1505
<p>
1506
1506
Registers a function to be called when a condition becomes true
1526
1526
</tr>
1527
1527
<tr>
1528
1528
<td><p><span class="term"><em class="parameter"><code>marshal</code></em> :</span></p></td>
1529
 
<td>The marshaller to use instead of the function (if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</td>
 
1529
<td>The marshaller to use instead of the function (if non-<a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>).</td>
1530
1530
</tr>
1531
1531
<tr>
1532
1532
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1535
1535
<tr>
1536
1536
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
1537
1537
<td>callback function to call with <em class="parameter"><code>data</code></em> when the input
1538
 
handler is removed, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 
1538
handler is removed, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
1539
1539
</tr>
1540
1540
<tr>
1541
1541
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1547
1547
<hr>
1548
1548
<div class="refsect2">
1549
1549
<a name="gtk-input-remove"></a><h3>gtk_input_remove ()</h3>
1550
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_input_remove                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> input_handler_id</code></em>);</pre>
 
1550
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_input_remove                    (<em class="parameter"><code><span class="type">guint</span> input_handler_id</code></em>);</pre>
1551
1551
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1552
1552
<h3 class="title">Warning</h3>
1553
 
<p><code class="literal">gtk_input_remove</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-remove"><code class="function">g_source_remove()</code></a> instead.</p>
 
1553
<p><code class="literal">gtk_input_remove</code> has been deprecated since version 2.4 and should not be used in newly-written code. Use <code class="function">g_source_remove()</code> instead.</p>
1554
1554
</div>
1555
1555
<p>
1556
1556
Removes the function with the given id.
1573
1573
</pre>
1574
1574
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1575
1575
<h3 class="title">Warning</h3>
1576
 
<p><code class="literal">GTK_PRIORITY_REDRAW</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <a href="../gdk/gdk-Events.html#GDK-PRIORITY-REDRAW:CAPS"><code class="literal">GDK_PRIORITY_REDRAW</code></a> instead.</p>
 
1576
<p><code class="literal">GTK_PRIORITY_REDRAW</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <a href="http://library.gnome.org/devel/gdk3/gdk-Events.html#GDK-PRIORITY-REDRAW:CAPS"><code class="literal">GDK_PRIORITY_REDRAW</code></a> instead.</p>
1577
1577
</div>
1578
1578
<p>
1579
1579
Use this priority for redrawing related stuff. It is used internally by
1600
1600
</pre>
1601
1601
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1602
1602
<h3 class="title">Warning</h3>
1603
 
<p><code class="literal">GTK_PRIORITY_HIGH</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-HIGH:CAPS"><code class="literal">G_PRIORITY_HIGH</code></a> instead.</p>
 
1603
<p><code class="literal">GTK_PRIORITY_HIGH</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <code class="literal">G_PRIORITY_HIGH</code> instead.</p>
1604
1604
</div>
1605
1605
<p>
1606
1606
Use this for high priority timeouts. This priority is never used inside
1628
1628
</pre>
1629
1629
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1630
1630
<h3 class="title">Warning</h3>
1631
 
<p><code class="literal">GTK_PRIORITY_DEFAULT</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT-IDLE:CAPS"><code class="literal">G_PRIORITY_DEFAULT_IDLE</code></a> instead.</p>
 
1631
<p><code class="literal">GTK_PRIORITY_DEFAULT</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <code class="literal">G_PRIORITY_DEFAULT_IDLE</code> instead.</p>
1632
1632
</div>
1633
1633
<p>
1634
1634
Default priority for idle functions.
1641
1641
</pre>
1642
1642
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1643
1643
<h3 class="title">Warning</h3>
1644
 
<p><code class="literal">GTK_PRIORITY_LOW</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-LOW:CAPS"><code class="literal">G_PRIORITY_LOW</code></a> instead.</p>
 
1644
<p><code class="literal">GTK_PRIORITY_LOW</code> has been deprecated since version 2.4 and should not be used in newly-written code. This macro is deprecated. You should use <code class="literal">G_PRIORITY_LOW</code> instead.</p>
1645
1645
</div>
1646
1646
<p>
1647
1647
Priority for very unimportant background tasks.
1650
1650
<hr>
1651
1651
<div class="refsect2">
1652
1652
<a name="gtk-key-snooper-install"></a><h3>gtk_key_snooper_install ()</h3>
1653
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gtk_key_snooper_install             (<em class="parameter"><code><a class="link" href="gtk-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()"><span class="type">GtkKeySnoopFunc</span></a> snooper</code></em>,
1654
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> func_data</code></em>);</pre>
 
1653
<pre class="programlisting"><span class="returnvalue">guint</span>               gtk_key_snooper_install             (<em class="parameter"><code><a class="link" href="gtk-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()"><span class="type">GtkKeySnoopFunc</span></a> snooper</code></em>,
 
1654
                                                         <em class="parameter"><code><span class="type">gpointer</span> func_data</code></em>);</pre>
1655
1655
<p>
1656
1656
Installs a key snooper function, which will get called on all key events
1657
1657
before delivering them normally.
1680
1680
<hr>
1681
1681
<div class="refsect2">
1682
1682
<a name="GtkKeySnoopFunc"></a><h3>GtkKeySnoopFunc ()</h3>
1683
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                (*GtkKeySnoopFunc)                  (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *grab_widget</code></em>,
1684
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>,
1685
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> func_data</code></em>);</pre>
 
1683
<pre class="programlisting"><span class="returnvalue">gint</span>                (*GtkKeySnoopFunc)                  (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *grab_widget</code></em>,
 
1684
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>,
 
1685
                                                         <em class="parameter"><code><span class="type">gpointer</span> func_data</code></em>);</pre>
1686
1686
<p>
1687
1687
Key snooper functions are called before normal event delivery.
1688
1688
They can be used to implement custom key event handling.
1708
1708
<tr>
1709
1709
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1710
1710
<td>
1711
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop further processing of <em class="parameter"><code>event</code></em>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to continue.</td>
 
1711
<code class="literal">TRUE</code> to stop further processing of <em class="parameter"><code>event</code></em>, <code class="literal">FALSE</code> to continue.</td>
1712
1712
</tr>
1713
1713
</tbody>
1714
1714
</table></div>
1716
1716
<hr>
1717
1717
<div class="refsect2">
1718
1718
<a name="gtk-key-snooper-remove"></a><h3>gtk_key_snooper_remove ()</h3>
1719
 
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_key_snooper_remove              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> snooper_handler_id</code></em>);</pre>
 
1719
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_key_snooper_remove              (<em class="parameter"><code><span class="type">guint</span> snooper_handler_id</code></em>);</pre>
1720
1720
<p>
1721
1721
Removes the key snooper function with the given id.
1722
1722
</p>
1734
1734
<hr>
1735
1735
<div class="refsect2">
1736
1736
<a name="gtk-get-current-event"></a><h3>gtk_get_current_event ()</h3>
1737
 
<pre class="programlisting"><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="returnvalue">GdkEvent</span></a> *          gtk_get_current_event               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
1737
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="returnvalue">GdkEvent</span></a> *          gtk_get_current_event               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1738
1738
<p>
1739
1739
Obtains a copy of the event currently being processed by GTK+.  For
1740
1740
example, if you get a "clicked" signal from <a class="link" href="GtkButton.html" title="GtkButton"><span class="type">GtkButton</span></a>, the current
1741
 
event will be the <a href="../gdk/gdk-Event-Structures.html#GdkEventButton"><span class="type">GdkEventButton</span></a> that triggered the "clicked"
1742
 
signal. The returned event must be freed with <a href="../gdk/gdk-Events.html#gdk-event-free"><code class="function">gdk_event_free()</code></a>.
1743
 
If there is no current event, the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
1741
event will be the <a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEventButton"><span class="type">GdkEventButton</span></a> that triggered the "clicked"
 
1742
signal. The returned event must be freed with <a href="http://library.gnome.org/devel/gdk3/gdk-Events.html#gdk-event-free"><code class="function">gdk_event_free()</code></a>.
 
1743
If there is no current event, the function returns <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
1744
1744
</p>
1745
1745
<div class="variablelist"><table border="0" class="variablelist">
1746
1746
<colgroup>
1749
1749
</colgroup>
1750
1750
<tbody><tr>
1751
1751
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1752
 
<td>a copy of the current event, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no
 
1752
<td>a copy of the current event, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if no
1753
1753
current event. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1754
1754
</td>
1755
1755
</tr></tbody>
1758
1758
<hr>
1759
1759
<div class="refsect2">
1760
1760
<a name="gtk-get-current-event-time"></a><h3>gtk_get_current_event_time ()</h3>
1761
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             gtk_get_current_event_time          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
1761
<pre class="programlisting"><span class="returnvalue">guint32</span>             gtk_get_current_event_time          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1762
1762
<p>
1763
1763
If there is a current event and it has a timestamp, return that
1764
 
timestamp, otherwise return <a href="../gdk/gdk-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.
 
1764
timestamp, otherwise return <a href="http://library.gnome.org/devel/gdk3/gdk-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.
1765
1765
</p>
1766
1766
<div class="variablelist"><table border="0" class="variablelist">
1767
1767
<colgroup>
1770
1770
</colgroup>
1771
1771
<tbody><tr>
1772
1772
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1773
 
<td>the timestamp from the current event, or <a href="../gdk/gdk-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.</td>
 
1773
<td>the timestamp from the current event, or <a href="http://library.gnome.org/devel/gdk3/gdk-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.</td>
1774
1774
</tr></tbody>
1775
1775
</table></div>
1776
1776
</div>
1777
1777
<hr>
1778
1778
<div class="refsect2">
1779
1779
<a name="gtk-get-current-event-state"></a><h3>gtk_get_current_event_state ()</h3>
1780
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_get_current_event_state         (<em class="parameter"><code><a href="../gdk/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);</pre>
 
1780
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_get_current_event_state         (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);</pre>
1781
1781
<p>
1782
1782
If there is a current event and it has a state field, place
1783
 
that state field in <em class="parameter"><code>state</code></em> and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, otherwise return
1784
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
 
1783
that state field in <em class="parameter"><code>state</code></em> and return <code class="literal">TRUE</code>, otherwise return
 
1784
<code class="literal">FALSE</code>.
1785
1785
</p>
1786
1786
<div class="variablelist"><table border="0" class="variablelist">
1787
1787
<colgroup>
1797
1797
<tr>
1798
1798
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1799
1799
<td>
1800
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there was a current event and it had a state field</td>
 
1800
<code class="literal">TRUE</code> if there was a current event and it had a state field</td>
1801
1801
</tr>
1802
1802
</tbody>
1803
1803
</table></div>
1805
1805
<hr>
1806
1806
<div class="refsect2">
1807
1807
<a name="gtk-get-event-widget"></a><h3>gtk_get_event_widget ()</h3>
1808
 
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_get_event_widget                (<em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
 
1808
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_get_event_widget                (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
1809
1809
<p>
1810
 
If <em class="parameter"><code>event</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or the event was not associated with any widget,
1811
 
returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, otherwise returns the widget that received the event
 
1810
If <em class="parameter"><code>event</code></em> is <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> or the event was not associated with any widget,
 
1811
returns <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, otherwise returns the widget that received the event
1812
1812
originally.
1813
1813
</p>
1814
1814
<div class="variablelist"><table border="0" class="variablelist">
1819
1819
<tbody>
1820
1820
<tr>
1821
1821
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
1822
 
<td>a <a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a>
 
1822
<td>a <a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a>
1823
1823
</td>
1824
1824
</tr>
1825
1825
<tr>
1826
1826
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1827
1827
<td>the widget that originally
1828
 
received <em class="parameter"><code>event</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
1828
received <em class="parameter"><code>event</code></em>, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1829
1829
</td>
1830
1830
</tr>
1831
1831
</tbody>
1835
1835
<div class="refsect2">
1836
1836
<a name="gtk-propagate-event"></a><h3>gtk_propagate_event ()</h3>
1837
1837
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_propagate_event                 (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
1838
 
                                                         <em class="parameter"><code><a href="../gdk/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
 
1838
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
1839
1839
<p>
1840
1840
Sends an event to a widget, propagating the event to parent widgets
1841
1841
if the event remains unhandled. Events received by GTK+ from GDK
1852
1852
All that said, you most likely don't want to use any of these
1853
1853
functions; synthesizing events is rarely needed. Consider asking on
1854
1854
the mailing list for better ways to achieve your goals. For
1855
 
example, use <a href="../gdk/gdk-Windows.html#gdk-window-invalidate-rect"><code class="function">gdk_window_invalidate_rect()</code></a> or
 
1855
example, use <a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#gdk-window-invalidate-rect"><code class="function">gdk_window_invalidate_rect()</code></a> or
1856
1856
<a class="link" href="GtkWidget.html#gtk-widget-queue-draw" title="gtk_widget_queue_draw ()"><code class="function">gtk_widget_queue_draw()</code></a> instead of making up expose events.
1857
1857
</p>
1858
1858
<div class="variablelist"><table border="0" class="variablelist">
1877
1877
<div class="refsect1">
1878
1878
<a name="gtk-General.see-also"></a><h2>See Also</h2>
1879
1879
<p>
1880
 
See the GLib manual, especially <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainLoop"><span class="type">GMainLoop</span></a> and signal-related
 
1880
See the GLib manual, especially <span class="type">GMainLoop</span> and signal-related
1881
1881
functions such as <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect"><code class="function">g_signal_connect()</code></a>.
1882
1882
</p>
1883
1883
</div>
1884
1884
</div>
1885
1885
<div class="footer">
1886
1886
<hr>
1887
 
          Generated by GTK-Doc V1.18</div>
 
1887
          Generated by GTK-Doc V1.18.1</div>
1888
1888
</body>
1889
1889
</html>
 
 
b'\\ No newline at end of file'