New upstream version 3.24.5
This commit is contained in:
@ -65,7 +65,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-parse-args" title="gtk_parse_args ()">gtk_parse_args</a> <span class="c_punctuation">()</span>
|
||||
@ -81,7 +81,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-init-check" title="gtk_init_check ()">gtk_init_check</a> <span class="c_punctuation">()</span>
|
||||
@ -89,7 +89,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-init-with-args" title="gtk_init_with_args ()">gtk_init_with_args</a> <span class="c_punctuation">()</span>
|
||||
@ -97,7 +97,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">GOptionGroup</span> *
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-get-option-group" title="gtk_get_option_group ()">gtk_get_option_group</a> <span class="c_punctuation">()</span>
|
||||
@ -105,7 +105,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-events-pending" title="gtk_events_pending ()">gtk_events_pending</a> <span class="c_punctuation">()</span>
|
||||
@ -121,7 +121,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">guint</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-main-level" title="gtk_main_level ()">gtk_main_level</a> <span class="c_punctuation">()</span>
|
||||
@ -137,7 +137,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-main-iteration" title="gtk_main_iteration ()">gtk_main_iteration</a> <span class="c_punctuation">()</span>
|
||||
@ -145,7 +145,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-main-iteration-do" title="gtk_main_iteration_do ()">gtk_main_iteration_do</a> <span class="c_punctuation">()</span>
|
||||
@ -177,7 +177,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-true" title="gtk_true ()">gtk_true</a> <span class="c_punctuation">()</span>
|
||||
@ -185,7 +185,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-false" title="gtk_false ()">gtk_false</a> <span class="c_punctuation">()</span>
|
||||
@ -233,7 +233,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">guint</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-key-snooper-install" title="gtk_key_snooper_install ()">gtk_key_snooper_install</a> <span class="c_punctuation">()</span>
|
||||
@ -241,7 +241,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gint</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<span class="c_punctuation">(</span><a class="link" href="gtk3-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()">*GtkKeySnoopFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
|
||||
@ -265,7 +265,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">guint32</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-get-current-event-time" title="gtk_get_current_event_time ()">gtk_get_current_event_time</a> <span class="c_punctuation">()</span>
|
||||
@ -273,7 +273,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<span class="returnvalue">gboolean</span>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="gtk3-General.html#gtk-get-current-event-state" title="gtk_get_current_event_state ()">gtk_get_current_event_state</a> <span class="c_punctuation">()</span>
|
||||
@ -340,7 +340,7 @@ event to one or more widgets.</p>
|
||||
<p>When widgets receive an event, they frequently emit one or more
|
||||
“signals”. Signals notify your program that "something
|
||||
interesting happened" by invoking functions you’ve connected to the signal
|
||||
with <code class="function">g_signal_connect()</code>. Functions connected to a signal are often termed
|
||||
with <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#g-signal-connect"><code class="function">g_signal_connect()</code></a>. Functions connected to a signal are often termed
|
||||
“callbacks”.</p>
|
||||
<p>When your callbacks are invoked, you would typically take some action - for
|
||||
example, when an Open button is clicked you might display a
|
||||
@ -413,7 +413,7 @@ main loop and await more user input.</p>
|
||||
|
||||
<p></p>
|
||||
<p>It’s OK to use the GLib main loop directly instead of <a class="link" href="gtk3-General.html#gtk-main" title="gtk_main ()"><code class="function">gtk_main()</code></a>, though it
|
||||
involves slightly more typing. See <span class="type">GMainLoop</span> in the GLib documentation.</p>
|
||||
involves slightly more typing. See <a href="https://developer.gnome.org/glib/unstable/glib-The-Main-Event-Loop.html#GMainLoop"><span class="type">GMainLoop</span></a> in the GLib documentation.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
@ -491,7 +491,7 @@ you can use it to update the default text direction as follows:</p>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-parse-args"></a><h3>gtk_parse_args ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>,
|
||||
<em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
|
||||
<p>Parses command line arguments, and initializes global
|
||||
@ -531,7 +531,7 @@ command line arguments. </p></td>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-parse-args.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> if initialization succeeded, otherwise <code class="literal">FALSE</code></p>
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if initialization succeeded, otherwise <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
@ -546,7 +546,7 @@ toolkit and parses some standard command line options.</p>
|
||||
<p>Although you are expected to pass the <em class="parameter"><code>argc</code></em>
|
||||
, <em class="parameter"><code>argv</code></em>
|
||||
parameters from <code class="function">main()</code> to
|
||||
this function, it is possible to pass <code class="literal">NULL</code> if <em class="parameter"><code>argv</code></em>
|
||||
this function, it is possible to pass <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>argv</code></em>
|
||||
is not available or
|
||||
commandline handling is not required.</p>
|
||||
<p><em class="parameter"><code>argc</code></em>
|
||||
@ -555,7 +555,7 @@ commandline handling is not required.</p>
|
||||
never see those standard arguments.</p>
|
||||
<p>Note that there are some alternative ways to initialize GTK+:
|
||||
if you are calling <a class="link" href="gtk3-General.html#gtk-parse-args" title="gtk_parse_args ()"><code class="function">gtk_parse_args()</code></a>, <a class="link" href="gtk3-General.html#gtk-init-check" title="gtk_init_check ()"><code class="function">gtk_init_check()</code></a>,
|
||||
<a class="link" href="gtk3-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
|
||||
<a class="link" href="gtk3-General.html#gtk-init-with-args" title="gtk_init_with_args ()"><code class="function">gtk_init_with_args()</code></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#g-option-context-parse"><code class="function">g_option_context_parse()</code></a> with
|
||||
the option group returned by <a class="link" href="gtk3-General.html#gtk-get-option-group" title="gtk_get_option_group ()"><code class="function">gtk_get_option_group()</code></a>,
|
||||
you don’t have to call <a class="link" href="gtk3-General.html#gtk-init" title="gtk_init ()"><code class="function">gtk_init()</code></a>.</p>
|
||||
<p>And if you are using <a class="link" href="GtkApplication.html" title="GtkApplication"><span class="type">GtkApplication</span></a>, you don't have to call any of the
|
||||
@ -584,14 +584,14 @@ similar things.</p>
|
||||
<td class="parameter_name"><p>argc</p></td>
|
||||
<td class="parameter_description"><p>Address of the <code class="literal">argc</code> parameter of
|
||||
your <code class="function">main()</code> function (or 0 if <em class="parameter"><code>argv</code></em>
|
||||
is <code class="literal">NULL</code>). This will be changed if
|
||||
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). This will be changed if
|
||||
any arguments were handled. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>argv</p></td>
|
||||
<td class="parameter_description"><p>Address of the
|
||||
<code class="literal">argv</code> parameter of <code class="function">main()</code>, or <code class="literal">NULL</code>. Any options
|
||||
<code class="literal">argv</code> parameter of <code class="function">main()</code>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Any options
|
||||
understood by GTK+ are stripped before return. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
@ -602,13 +602,13 @@ understood by GTK+ are stripped before return. </p></td>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-init-check"></a><h3>gtk_init_check ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>,
|
||||
<em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
|
||||
<p>This function does the same work as <a class="link" href="gtk3-General.html#gtk-init" title="gtk_init ()"><code class="function">gtk_init()</code></a> with only a single
|
||||
change: It does not terminate the program if the commandline
|
||||
arguments couldn’t be parsed or the windowing system can’t be
|
||||
initialized. Instead it returns <code class="literal">FALSE</code> on failure.</p>
|
||||
initialized. Instead it returns <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</p>
|
||||
<p>This way the application can fall back to some other means of
|
||||
communication with the user - for example a curses or command line
|
||||
interface.</p>
|
||||
@ -625,14 +625,14 @@ interface.</p>
|
||||
<td class="parameter_name"><p>argc</p></td>
|
||||
<td class="parameter_description"><p>Address of the <code class="literal">argc</code> parameter of
|
||||
your <code class="function">main()</code> function (or 0 if <em class="parameter"><code>argv</code></em>
|
||||
is <code class="literal">NULL</code>). This will be changed if
|
||||
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). This will be changed if
|
||||
any arguments were handled. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>argv</p></td>
|
||||
<td class="parameter_description"><p>Address of the
|
||||
<code class="literal">argv</code> parameter of <code class="function">main()</code>, or <code class="literal">NULL</code>. Any options
|
||||
<code class="literal">argv</code> parameter of <code class="function">main()</code>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Any options
|
||||
understood by GTK+ are stripped before return. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
@ -641,21 +641,21 @@ understood by GTK+ are stripped before return. </p></td>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-init-check.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> if the commandline arguments (if any) were valid and
|
||||
the windowing system has been successfully initialized, <code class="literal">FALSE</code>
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the commandline arguments (if any) were valid and
|
||||
the windowing system has been successfully initialized, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
|
||||
otherwise</p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-init-with-args"></a><h3>gtk_init_with_args ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
gtk_init_with_args (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>,
|
||||
<em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>,
|
||||
<em class="parameter"><code>const <span class="type">gchar</span> *parameter_string</code></em>,
|
||||
<em class="parameter"><code>const <span class="type">GOptionEntry</span> *entries</code></em>,
|
||||
<em class="parameter"><code>const <span class="type">gchar</span> *translation_domain</code></em>,
|
||||
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
gtk_init_with_args (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>,
|
||||
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *parameter_string</code></em>,
|
||||
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry"><span class="type">GOptionEntry</span></a> *entries</code></em>,
|
||||
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *translation_domain</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
|
||||
<p>This function does the same work as <a class="link" href="gtk3-General.html#gtk-init-check" title="gtk_init_check ()"><code class="function">gtk_init_check()</code></a>.
|
||||
Additionally, it allows you to add your own commandline options,
|
||||
and it automatically generates nicely formatted
|
||||
@ -674,14 +674,14 @@ be terminated after writing out the help output.</p>
|
||||
<td class="parameter_name"><p>argc</p></td>
|
||||
<td class="parameter_description"><p>Address of the <code class="literal">argc</code> parameter of
|
||||
your <code class="function">main()</code> function (or 0 if <em class="parameter"><code>argv</code></em>
|
||||
is <code class="literal">NULL</code>). This will be changed if
|
||||
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). This will be changed if
|
||||
any arguments were handled. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>argv</p></td>
|
||||
<td class="parameter_description"><p>Address of the
|
||||
<code class="literal">argv</code> parameter of <code class="function">main()</code>, or <code class="literal">NULL</code>. Any options
|
||||
<code class="literal">argv</code> parameter of <code class="function">main()</code>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Any options
|
||||
understood by GTK+ are stripped before return. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
@ -694,8 +694,8 @@ the first line of <code class="literal">--help</code> output, after
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>entries</p></td>
|
||||
<td class="parameter_description"><p>a <code class="literal">NULL</code>-terminated array
|
||||
of <span class="type">GOptionEntrys</span> describing the options of your program. </p></td>
|
||||
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array
|
||||
of <a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#GOptionEntry"><span class="type">GOptionEntrys</span></a> describing the options of your program. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -703,7 +703,7 @@ of <span class="type">GOptionEntrys</span> describing the options of your progra
|
||||
<td class="parameter_description"><p>a translation domain to use for translating
|
||||
the <code class="literal">--help</code> output for the options in <em class="parameter"><code>entries</code></em>
|
||||
and the <em class="parameter"><code>parameter_string</code></em>
|
||||
with <code class="function">gettext()</code>, or <code class="literal">NULL</code>. </p></td>
|
||||
with <code class="function">gettext()</code>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -716,22 +716,22 @@ with <code class="function">gettext()</code>, or <code class="literal">NULL</cod
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-init-with-args.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> if the commandline arguments (if any) were valid and
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the commandline arguments (if any) were valid and
|
||||
if the windowing system has been successfully initialized,
|
||||
<code class="literal">FALSE</code> otherwise</p>
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
|
||||
</div>
|
||||
<p class="since">Since: 2.6</p>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-get-option-group"></a><h3>gtk_get_option_group ()</h3>
|
||||
<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>
|
||||
<p>Returns a <span class="type">GOptionGroup</span> for the commandline arguments recognized
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="returnvalue">GOptionGroup</span></a> *
|
||||
gtk_get_option_group (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> open_default_display</code></em>);</pre>
|
||||
<p>Returns a <a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> for the commandline arguments recognized
|
||||
by GTK+ and GDK.</p>
|
||||
<p>You should add this group to your <span class="type">GOptionContext</span>
|
||||
with <code class="function">g_option_context_add_group()</code>, if you are using
|
||||
<code class="function">g_option_context_parse()</code> to parse your commandline arguments.</p>
|
||||
<p>You should add this group to your <a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a>
|
||||
with <a href="https://developer.gnome.org/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
|
||||
<a href="https://developer.gnome.org/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.</p>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-get-option-group.parameters"></a><h4>Parameters</h4>
|
||||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||||
@ -750,7 +750,7 @@ when parsing the commandline arguments</p></td>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-get-option-group.returns"></a><h4>Returns</h4>
|
||||
<p>a <span class="type">GOptionGroup</span> for the commandline
|
||||
<p>a <a href="https://developer.gnome.org/glib/unstable/glib-Commandline-option-parser.html#GOptionGroup"><span class="type">GOptionGroup</span></a> for the commandline
|
||||
arguments recognized by GTK+. </p>
|
||||
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
|
||||
</div>
|
||||
@ -759,7 +759,7 @@ arguments recognized by GTK+. </p>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-events-pending"></a><h3>gtk_events_pending ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>
|
||||
<p>Checks if any events are pending.</p>
|
||||
<p>This can be used to update the UI and invoke timeouts etc.
|
||||
@ -791,7 +791,7 @@ while doing some time intensive computation.</p>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-events-pending.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> if any events are pending, <code class="literal">FALSE</code> otherwise</p>
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if any events are pending, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
@ -806,7 +806,7 @@ will make the innermost invocation of the main loop return.</p>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-main-level"></a><h3>gtk_main_level ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">guint</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>
|
||||
<p>Asks for the current nesting level of the main loop.</p>
|
||||
<div class="refsect3">
|
||||
@ -826,7 +826,7 @@ when it regains control.</p>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-main-iteration"></a><h3>gtk_main_iteration ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>
|
||||
<p>Runs a single iteration of the mainloop.</p>
|
||||
<p>If no events are waiting to be processed GTK+ will block
|
||||
@ -835,15 +835,15 @@ look at <a class="link" href="gtk3-General.html#gtk-main-iteration-do" title="gt
|
||||
pending with <a class="link" href="gtk3-General.html#gtk-events-pending" title="gtk_events_pending ()"><code class="function">gtk_events_pending()</code></a> first.</p>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-main-iteration.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> if <a class="link" href="gtk3-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="gtk3-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the
|
||||
innermost mainloop</p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-main-iteration-do"></a><h3>gtk_main_iteration_do ()</h3>
|
||||
<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>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
gtk_main_iteration_do (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> blocking</code></em>);</pre>
|
||||
<p>Runs a single iteration of the mainloop.
|
||||
If no events are available either return or block depending on
|
||||
the value of <em class="parameter"><code>blocking</code></em>
|
||||
@ -858,14 +858,14 @@ the value of <em class="parameter"><code>blocking</code></em>
|
||||
</colgroup>
|
||||
<tbody><tr>
|
||||
<td class="parameter_name"><p>blocking</p></td>
|
||||
<td class="parameter_description"><p><code class="literal">TRUE</code> if you want GTK+ to block if no events are pending</p></td>
|
||||
<td class="parameter_description"><p><a href="https://developer.gnome.org/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</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr></tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-main-iteration-do.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> if <a class="link" href="gtk3-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="gtk3-General.html#gtk-main-quit" title="gtk_main_quit ()"><code class="function">gtk_main_quit()</code></a> has been called for the
|
||||
innermost mainloop</p>
|
||||
</div>
|
||||
</div>
|
||||
@ -929,8 +929,8 @@ of <a class="link" href="gtk3-General.html#gtk-key-snooper-install" title="gtk_k
|
||||
<div class="refsect2">
|
||||
<a name="GtkModuleInitFunc"></a><h3>GtkModuleInitFunc ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
<span class="c_punctuation">(</span>*GtkModuleInitFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gint</span> *argc</code></em>,
|
||||
<em class="parameter"><code><span class="type">gchar</span> ***argv</code></em>);</pre>
|
||||
<span class="c_punctuation">(</span>*GtkModuleInitFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *argc</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> ***argv</code></em>);</pre>
|
||||
<p>Each GTK+ module must have a function <code class="function">gtk_module_init()</code> with this prototype.
|
||||
This function is called after loading the module.</p>
|
||||
<div class="refsect3">
|
||||
@ -944,12 +944,12 @@ This function is called after loading the module.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>argc</p></td>
|
||||
<td class="parameter_description"><p>GTK+ always passes <code class="literal">NULL</code> for this argument. </p></td>
|
||||
<td class="parameter_description"><p>GTK+ always passes <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for this argument. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>argv</p></td>
|
||||
<td class="parameter_description"><p>GTK+ always passes <code class="literal">NULL</code> for this argument. </p></td>
|
||||
<td class="parameter_description"><p>GTK+ always passes <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for this argument. </p></td>
|
||||
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc]</span></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -983,9 +983,9 @@ with this prototype. GTK+ calls this function for each opened display.</p>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-true"></a><h3>gtk_true ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>
|
||||
<p>All this function does it to return <code class="literal">TRUE</code>.</p>
|
||||
<p>All this function does it to return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
|
||||
<p>This can be useful for example if you want to inhibit the deletion
|
||||
of a window. Of course you should not do this as the user expects
|
||||
a reaction from clicking the close icon of the window...</p>
|
||||
@ -1037,17 +1037,17 @@ a reaction from clicking the close icon of the window...</p>
|
||||
<span class="normal"> </span><span class="function"><a href="gtk3-General.html#gtk-init">gtk_init</a></span><span class="normal"> </span><span class="symbol">(&</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">argv</span><span class="symbol">);</span>
|
||||
|
||||
<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="GtkWindow.html#GTK-WINDOW-TOPLEVEL:CAPS">GTK_WINDOW_TOPLEVEL</a></span><span class="symbol">);</span>
|
||||
<span class="normal"> </span><span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">win</span><span class="symbol">,</span>
|
||||
<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/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>
|
||||
<span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk3-General.html#gtk-true">gtk_true</a></span><span class="symbol">),</span>
|
||||
<span class="normal"> NULL</span><span class="symbol">);</span>
|
||||
<span class="normal"> </span><span class="function">g_signal_connect</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>
|
||||
<span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="gtk3-General.html#gtk-main-quit">gtk_main_quit</a></span><span class="symbol">),</span>
|
||||
<span class="normal"> NULL</span><span class="symbol">);</span>
|
||||
<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/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="gtk3-General.html#gtk-true">gtk_true</a></span><span class="symbol">),</span>
|
||||
<span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
|
||||
<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/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>
|
||||
<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/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="gtk3-General.html#gtk-main-quit">gtk_main_quit</a></span><span class="symbol">),</span>
|
||||
<span class="normal"> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
|
||||
|
||||
<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="normal">text</span><span class="symbol">);</span>
|
||||
<span class="normal"> </span><span class="function">g_signal_connect_swapped</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>
|
||||
<span class="normal"> </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">gtk_object_destroy</span><span class="symbol">),</span>
|
||||
<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/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>
|
||||
<span class="normal"> </span><span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">gtk_object_destroy</span><span class="symbol">),</span>
|
||||
<span class="normal"> win</span><span class="symbol">);</span>
|
||||
<span class="normal"> </span><span class="function"><a href="GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">win</span><span class="symbol">),</span><span class="normal"> but</span><span class="symbol">);</span>
|
||||
|
||||
@ -1066,19 +1066,19 @@ a reaction from clicking the close icon of the window...</p>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-true.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code></p>
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-false"></a><h3>gtk_false ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>
|
||||
<p>Analogical to <a class="link" href="gtk3-General.html#gtk-true" title="gtk_true ()"><code class="function">gtk_true()</code></a>, this function does nothing
|
||||
but always returns <code class="literal">FALSE</code>.</p>
|
||||
but always returns <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-false.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">FALSE</code></p>
|
||||
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
@ -1120,7 +1120,7 @@ gtk_grab_get_current (<em class="parameter"><code><span class="type">void</span>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-grab-get-current.returns"></a><h4>Returns</h4>
|
||||
<p>The widget which currently
|
||||
has the grab or <code class="literal">NULL</code> if no grab is active. </p>
|
||||
has the grab or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no grab is active. </p>
|
||||
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||||
</div>
|
||||
</div>
|
||||
@ -1156,14 +1156,14 @@ gtk_grab_remove (<em class="parameter"><code><a class="link" href="GtkWidget.htm
|
||||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||||
gtk_device_grab_add (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/gdk3/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a> *device</code></em>,
|
||||
<em class="parameter"><code><span class="type">gboolean</span> block_others</code></em>);</pre>
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> block_others</code></em>);</pre>
|
||||
<p>Adds a GTK+ grab on <em class="parameter"><code>device</code></em>
|
||||
, so all the events on <em class="parameter"><code>device</code></em>
|
||||
and its
|
||||
associated pointer or keyboard (if any) are delivered to <em class="parameter"><code>widget</code></em>
|
||||
.
|
||||
If the <em class="parameter"><code>block_others</code></em>
|
||||
parameter is <code class="literal">TRUE</code>, any other devices will be
|
||||
parameter is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, any other devices will be
|
||||
unable to interact with <em class="parameter"><code>widget</code></em>
|
||||
during the grab.</p>
|
||||
<div class="refsect3">
|
||||
@ -1187,7 +1187,7 @@ unable to interact with <em class="parameter"><code>widget</code></em>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="parameter_name"><p>block_others</p></td>
|
||||
<td class="parameter_description"><p><code class="literal">TRUE</code> to prevent other devices to interact with <em class="parameter"><code>widget</code></em>
|
||||
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to prevent other devices to interact with <em class="parameter"><code>widget</code></em>
|
||||
.</p></td>
|
||||
<td class="parameter_annotations"> </td>
|
||||
</tr>
|
||||
@ -1232,9 +1232,9 @@ gtk_device_grab_remove (<em class="parameter"><code><a class="link" href="GtkWid
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-key-snooper-install"></a><h3>gtk_key_snooper_install ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">guint</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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="gtk3-General.html#GtkKeySnoopFunc" title="GtkKeySnoopFunc ()"><span class="type">GtkKeySnoopFunc</span></a> snooper</code></em>,
|
||||
<em class="parameter"><code><span class="type">gpointer</span> func_data</code></em>);</pre>
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> func_data</code></em>);</pre>
|
||||
<div class="warning">
|
||||
<p><code class="literal">gtk_key_snooper_install</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
|
||||
<p>Key snooping should not be done. Events should
|
||||
@ -1275,10 +1275,10 @@ key events before delivering them normally.</p>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="GtkKeySnoopFunc"></a><h3>GtkKeySnoopFunc ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gint</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
|
||||
<span class="c_punctuation">(</span>*GtkKeySnoopFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *grab_widget</code></em>,
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/gdk3/gdk3-Event-Structures.html#GdkEventKey"><span class="type">GdkEventKey</span></a> *event</code></em>,
|
||||
<em class="parameter"><code><span class="type">gpointer</span> func_data</code></em>);</pre>
|
||||
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> func_data</code></em>);</pre>
|
||||
<p>Key snooper functions are called before normal event delivery.
|
||||
They can be used to implement custom key event handling.</p>
|
||||
<div class="refsect3">
|
||||
@ -1310,15 +1310,15 @@ They can be used to implement custom key event handling.</p>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="GtkKeySnoopFunc.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> to stop further processing of <em class="parameter"><code>event</code></em>
|
||||
, <code class="literal">FALSE</code> to continue.</p>
|
||||
<p> <a href="https://developer.gnome.org/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="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to continue.</p>
|
||||
</div>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-key-snooper-remove"></a><h3>gtk_key_snooper_remove ()</h3>
|
||||
<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>
|
||||
gtk_key_snooper_remove (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> snooper_handler_id</code></em>);</pre>
|
||||
<div class="warning">
|
||||
<p><code class="literal">gtk_key_snooper_remove</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
|
||||
<p>Key snooping should not be done. Events should
|
||||
@ -1353,7 +1353,7 @@ the ::clicked signal.</p>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-get-current-event.returns"></a><h4>Returns</h4>
|
||||
<p>a copy of the current event, or
|
||||
<code class="literal">NULL</code> if there is no current event. The returned event must be
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no current event. The returned event must be
|
||||
freed with <a href="https://developer.gnome.org/gdk3/gdk3-Events.html#gdk-event-free"><code class="function">gdk_event_free()</code></a>. </p>
|
||||
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||||
</div>
|
||||
@ -1361,7 +1361,7 @@ freed with <a href="https://developer.gnome.org/gdk3/gdk3-Events.html#gdk-event-
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-get-current-event-time"></a><h3>gtk_get_current_event_time ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">guint32</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/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>
|
||||
<p>If there is a current event and it has a timestamp,
|
||||
return that timestamp, otherwise return <a href="https://developer.gnome.org/gdk3/gdk3-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.</p>
|
||||
@ -1374,12 +1374,12 @@ or <a href="https://developer.gnome.org/gdk3/gdk3-Events.html#GDK-CURRENT-TIME:C
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-get-current-event-state"></a><h3>gtk_get_current_event_state ()</h3>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
gtk_get_current_event_state (<em class="parameter"><code><a href="https://developer.gnome.org/gdk3/gdk3-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);</pre>
|
||||
<p>If there is a current event and it has a state field, place
|
||||
that state field in <em class="parameter"><code>state</code></em>
|
||||
and return <code class="literal">TRUE</code>, otherwise return
|
||||
<code class="literal">FALSE</code>.</p>
|
||||
and return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, otherwise return
|
||||
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-get-current-event-state.parameters"></a><h4>Parameters</h4>
|
||||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||||
@ -1397,7 +1397,7 @@ that state field in <em class="parameter"><code>state</code></em>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-get-current-event-state.returns"></a><h4>Returns</h4>
|
||||
<p> <code class="literal">TRUE</code> if there was a current event and it
|
||||
<p> <a href="https://developer.gnome.org/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</p>
|
||||
</div>
|
||||
</div>
|
||||
@ -1407,10 +1407,10 @@ had a state field</p>
|
||||
<pre class="programlisting"><a href="https://developer.gnome.org/gdk3/GdkDevice.html#GdkDevice-struct"><span class="returnvalue">GdkDevice</span></a> *
|
||||
gtk_get_current_event_device (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||||
<p>If there is a current event and it has a device, return that
|
||||
device, otherwise return <code class="literal">NULL</code>.</p>
|
||||
device, otherwise return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-get-current-event-device.returns"></a><h4>Returns</h4>
|
||||
<p>a <a href="https://developer.gnome.org/gdk3/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a>, or <code class="literal">NULL</code>. </p>
|
||||
<p>a <a href="https://developer.gnome.org/gdk3/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
|
||||
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||||
</div>
|
||||
</div>
|
||||
@ -1420,8 +1420,8 @@ device, otherwise return <code class="literal">NULL</code>.</p>
|
||||
<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="https://developer.gnome.org/gdk3/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
|
||||
<p>If <em class="parameter"><code>event</code></em>
|
||||
is <code class="literal">NULL</code> or the event was not associated with any widget,
|
||||
returns <code class="literal">NULL</code>, otherwise returns the widget that received the event
|
||||
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or the event was not associated with any widget,
|
||||
returns <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, otherwise returns the widget that received the event
|
||||
originally.</p>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-get-event-widget.parameters"></a><h4>Parameters</h4>
|
||||
@ -1442,7 +1442,7 @@ originally.</p>
|
||||
<a name="gtk-get-event-widget.returns"></a><h4>Returns</h4>
|
||||
<p>the widget that originally
|
||||
received <em class="parameter"><code>event</code></em>
|
||||
, or <code class="literal">NULL</code>. </p>
|
||||
, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
|
||||
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
|
||||
</div>
|
||||
</div>
|
||||
@ -1505,8 +1505,8 @@ resizing a widget which was just redrawn.</p>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="gtk3-General.see-also"></a><h2>See Also</h2>
|
||||
<p>See the GLib manual, especially <span class="type">GMainLoop</span> and signal-related
|
||||
functions such as <code class="function">g_signal_connect()</code></p>
|
||||
<p>See the GLib manual, especially <a href="https://developer.gnome.org/glib/unstable/glib-The-Main-Event-Loop.html#GMainLoop"><span class="type">GMainLoop</span></a> and signal-related
|
||||
functions such as <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#g-signal-connect"><code class="function">g_signal_connect()</code></a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
||||
Reference in New Issue
Block a user