callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

New upstream version 3.24.24

Browse Source
This commit is contained in:
Simon McVittie
2020-12-11 10:15:31 +00:00
parent 1185a58764 de8329b3ce
commit 92d583e7df
595 changed files with 345350 additions and 346852 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/reference/gtk/html/gtk3-General.html
View File

@ -8,7 +8,7 @@
<link rel="up" href="gtkbase.html" title="Part III. GTK+ Core Reference">
<link rel="prev" href="gtkbase.html" title="Part III. GTK+ Core Reference">
<link rel="next" href="gtk3-Feature-Test-Macros.html" title="Version Information">
<meta name="generator" content="GTK-Doc V1.99 (XML mode)">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -257,7 +257,7 @@
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GdkEvent-struct"><span class="returnvalue">GdkEvent</span></a> *
<a href="../html/gdk3-Event-Structures.html#GdkEvent"><span class="returnvalue">GdkEvent</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-General.html#gtk-get-current-event" title="gtk_get_current_event ()">gtk_get_current_event</a> <span class="c_punctuation">()</span>
@ -281,7 +281,7 @@
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/gdk4/GdkDevice.html#GdkDevice-struct"><span class="returnvalue">GdkDevice</span></a> *
<a href="../html/GdkDevice.html#GdkDevice-struct"><span class="returnvalue">GdkDevice</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-General.html#gtk-get-current-event-device" title="gtk_get_current_event_device ()">gtk_get_current_event_device</a> <span class="c_punctuation">()</span>
@ -496,7 +496,7 @@ gtk_parse_args (<em class="parameter"><code><span class="type">int</span> *argc<
<em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
<p>Parses command line arguments, and initializes global
attributes of GTK+, but does not actually open a connection
to a display. (See <a href="https://developer.gnome.org/gdk4/GdkDisplay.html#gdk-display-open"><code class="function">gdk_display_open()</code></a>, <code class="function">gdk_get_display_arg_name()</code>)</p>
to a display. (See <a href="../html/GdkDisplay.html#gdk-display-open"><code class="function">gdk_display_open()</code></a>, <a href="../html/gdk3-General.html#gdk-get-display-arg-name"><code class="function">gdk_get_display_arg_name()</code></a>)</p>
<p>Any arguments used by GTK+ or GDK are removed from the array and
<em class="parameter"><code>argc</code></em>
and <em class="parameter"><code>argv</code></em>
@ -875,7 +875,7 @@ innermost mainloop</p>
<div class="refsect2">
<a name="gtk-main-do-event"></a><h3>gtk_main_do_event ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_main_do_event (<em class="parameter"><code><a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GdkEvent-struct"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
gtk_main_do_event (<em class="parameter"><code><a href="../html/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
<p>Processes a single GDK event.</p>
<p>This is public only to allow filtering of events between GDK and GTK+.
You will not usually need to call this function directly.</p>
@ -962,7 +962,7 @@ This function is called after loading the module.</p>
<div class="refsect2">
<a name="GtkModuleDisplayInitFunc"></a><h3>GtkModuleDisplayInitFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GtkModuleDisplayInitFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/gdk4/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> *display</code></em>);</pre>
<span class="c_punctuation">(</span>*GtkModuleDisplayInitFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> *display</code></em>);</pre>
<p>A multihead-aware GTK+ module may have a <code class="function">gtk_module_display_init()</code> function
with this prototype. GTK+ calls this function for each opened display.</p>
<div class="refsect3">
@ -975,7 +975,7 @@ with this prototype. GTK+ calls this function for each opened display.</p>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>an open <a href="https://developer.gnome.org/gdk4/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a></p></td>
<td class="parameter_description"><p>an open <a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
@ -1157,7 +1157,7 @@ gtk_grab_remove (<em class="parameter"><code><a class="link" href="GtkWidget.htm
<a name="gtk-device-grab-add"></a><h3>gtk_device_grab_add ()</h3>
<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/gdk4/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a> *device</code></em>,
<em class="parameter"><code><a href="../html/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>
<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>
@ -1184,7 +1184,7 @@ unable to interact with <em class="parameter"><code>widget</code></em>
</tr>
<tr>
<td class="parameter_name"><p>device</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gdk4/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a> to grab on.</p></td>
<td class="parameter_description"><p>a <a href="../html/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a> to grab on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
@ -1203,7 +1203,7 @@ unable to interact with <em class="parameter"><code>widget</code></em>
<a name="gtk-device-grab-remove"></a><h3>gtk_device_grab_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_device_grab_remove (<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/gdk4/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a> *device</code></em>);</pre>
<em class="parameter"><code><a href="../html/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a> *device</code></em>);</pre>
<p>Removes a device grab from the given widget.</p>
<p>You have to pair calls to <a class="link" href="gtk3-General.html#gtk-device-grab-add" title="gtk_device_grab_add ()"><code class="function">gtk_device_grab_add()</code></a> and
<a class="link" href="gtk3-General.html#gtk-device-grab-remove" title="gtk_device_grab_remove ()"><code class="function">gtk_device_grab_remove()</code></a>.</p>
@ -1223,7 +1223,7 @@ gtk_device_grab_remove (<em class="parameter"><code><a class="link" href="GtkWid
</tr>
<tr>
<td class="parameter_name"><p>device</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gdk4/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a></p></td>
<td class="parameter_description"><p>a <a href="../html/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
@ -1279,7 +1279,7 @@ key events before delivering them normally.</p>
<a name="GtkKeySnoopFunc"></a><h3>GtkKeySnoopFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
<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><span class="type">GdkEventKey</span> *event</code></em>,
<em class="parameter"><code><a href="../html/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>
<p>Key snooper functions are called before normal event delivery.
They can be used to implement custom key event handling.</p>
@ -1346,17 +1346,17 @@ gtk_key_snooper_remove (<em class="parameter"><code><span class="type">guint</sp
<hr>
<div class="refsect2">
<a name="gtk-get-current-event"></a><h3>gtk_get_current_event ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GdkEvent-struct"><span class="returnvalue">GdkEvent</span></a> *
<pre class="programlisting"><a href="../html/gdk3-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>
<p>Obtains a copy of the event currently being processed by GTK+.</p>
<p>For example, if you are handling a <a class="link" href="GtkButton.html#GtkButton-clicked" title="The “clicked” signal"><span class="type">“clicked”</span></a> signal,
the current event will be the <span class="type">GdkEventButton</span> that triggered
the current event will be the <a href="../html/gdk3-Event-Structures.html#GdkEventButton"><span class="type">GdkEventButton</span></a> that triggered
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
freed with <code class="function">gdk_event_free()</code>. </p>
freed with <a href="../html/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>
</div>
@ -1366,18 +1366,18 @@ freed with <code class="function">gdk_event_free()</code>. </p>
<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>
<p>If there is a current event and it has a timestamp,
return that timestamp, otherwise return <a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.</p>
return that timestamp, otherwise return <a href="../html/gdk3-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.</p>
<div class="refsect3">
<a name="gtk-get-current-event-time.returns"></a><h4>Returns</h4>
<p> the timestamp from the current event,
or <a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.</p>
or <a href="../html/gdk3-Events.html#GDK-CURRENT-TIME:CAPS"><code class="literal">GDK_CURRENT_TIME</code></a>.</p>
</div>
</div>
<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>
gtk_get_current_event_state (<em class="parameter"><code><a href="https://developer.gnome.org/gdk4/GdkSurface.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *state</code></em>);</pre>
gtk_get_current_event_state (<em class="parameter"><code><a href="../html/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
@ -1406,13 +1406,13 @@ had a state field</p>
<hr>
<div class="refsect2">
<a name="gtk-get-current-event-device"></a><h3>gtk_get_current_event_device ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gdk4/GdkDevice.html#GdkDevice-struct"><span class="returnvalue">GdkDevice</span></a> *
<pre class="programlisting"><a href="../html/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>
<div class="refsect3">
<a name="gtk-get-current-event-device.returns"></a><h4>Returns</h4>
<p>a <a href="https://developer.gnome.org/gdk4/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a>, or <code class="literal">NULL</code>. </p>
<p>a <a href="../html/GdkDevice.html#GdkDevice-struct"><span class="type">GdkDevice</span></a>, or <code class="literal">NULL</code>. </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,7 +1420,7 @@ device, otherwise return <code class="literal">NULL</code>.</p>
<div class="refsect2">
<a name="gtk-get-event-widget"></a><h3>gtk_get_event_widget ()</h3>
<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/gdk4/gdk4-Events.html#GdkEvent-struct"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
gtk_get_event_widget (<em class="parameter"><code><a href="../html/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
@ -1435,7 +1435,7 @@ originally.</p>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GdkEvent-struct"><span class="type">GdkEvent</span></a></p></td>
<td class="parameter_description"><p>a <a href="../html/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
@ -1453,7 +1453,7 @@ received <em class="parameter"><code>event</code></em>
<a name="gtk-propagate-event"></a><h3>gtk_propagate_event ()</h3>
<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>,
<em class="parameter"><code><a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GdkEvent-struct"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
<em class="parameter"><code><a href="../html/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>);</pre>
<p>Sends an event to a widget, propagating the event to parent widgets
if the event remains unhandled.</p>
<p>Events received by GTK+ from GDK normally begin in <a class="link" href="gtk3-General.html#gtk-main-do-event" title="gtk_main_do_event ()"><code class="function">gtk_main_do_event()</code></a>.
@ -1467,7 +1467,7 @@ higher-level, and <a class="link" href="gtk3-General.html#gtk-main-do-event" tit
<p>All that said, you most likely don’t want to use any of these
functions; synthesizing events is rarely needed. There are almost
certainly better ways to achieve your goals. For example, use
<code class="function">gdk_window_invalidate_rect()</code> or <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
<a href="../html/gdk3-Windows.html#gdk-window-invalidate-rect"><code class="function">gdk_window_invalidate_rect()</code></a> or <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.</p>
<div class="refsect3">
<a name="gtk-propagate-event.parameters"></a><h4>Parameters</h4>
@ -1501,7 +1501,7 @@ of making up expose events.</p>
</pre>
<p>Use this priority for functionality related to size allocation.</p>
<p>It is used internally by GTK+ to compute the sizes of widgets.
This priority is higher than <a href="https://developer.gnome.org/gdk4/gdk4-Events.html#GDK-PRIORITY-REDRAW:CAPS"><code class="literal">GDK_PRIORITY_REDRAW</code></a> to avoid
This priority is higher than <a href="../html/gdk3-Events.html#GDK-PRIORITY-REDRAW:CAPS"><code class="literal">GDK_PRIORITY_REDRAW</code></a> to avoid
resizing a widget which was just redrawn.</p>
</div>
</div>
@ -1512,6 +1512,6 @@ functions such as <code class="function">g_signal_connect()</code></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.99</div>
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>