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

New upstream version 3.22.29

Browse Source
This commit is contained in:
Jeremy Bicha
2018-03-13 17:06:34 -04:00
parent 55d2e9a013 9f6deab88c
commit 13631127a0
262 changed files with 27134 additions and 455456 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/reference/gtk/html/gtk3-Clipboards.html
View File

@ -123,7 +123,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkDisplay</span> *
<a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="returnvalue">GdkDisplay</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtk3-Clipboards.html#gtk-clipboard-get-display" title="gtk_clipboard_get_display ()">gtk_clipboard_get_display</a> <span class="c_punctuation">()</span>
@ -339,7 +339,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkAtom</span>
<a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="returnvalue">GdkAtom</span></a>
</td>
<td class="function_name">
<a class="link" href="gtk3-Clipboards.html#gtk-clipboard-get-selection" title="gtk_clipboard_get_selection ()">gtk_clipboard_get_selection</a> <span class="c_punctuation">()</span>
@ -392,8 +392,8 @@
<p>The <a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> object represents a clipboard of data shared
between different processes or between different widgets in
the same process. Each clipboard is identified by a name encoded as a
<span class="type">GdkAtom</span>. (Conversion to and from strings can be done with
<code class="function">gdk_atom_intern()</code> and <code class="function">gdk_atom_name()</code>.) The default clipboard
<a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a>. (Conversion to and from strings can be done with
<a href="../html/gdk3-Properties-and-Atoms.html#gdk-atom-intern"><code class="function">gdk_atom_intern()</code></a> and <a href="../html/gdk3-Properties-and-Atoms.html#gdk-atom-name"><code class="function">gdk_atom_name()</code></a>.) The default clipboard
corresponds to the “CLIPBOARD” atom; another commonly used clipboard
is the “PRIMARY” clipboard, which, in X, traditionally contains
the currently selected text.</p>
@ -573,7 +573,7 @@ supplied to
<a name="GtkClipboardTargetsReceivedFunc"></a><h3>GtkClipboardTargetsReceivedFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GtkClipboardTargetsReceivedFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> *atoms</code></em>,
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> *atoms</code></em>,
<em class="parameter"><code><span class="type">gint</span> n_atoms</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>A function to be called when the results of <a class="link" href="gtk3-Clipboards.html#gtk-clipboard-request-targets" title="gtk_clipboard_request_targets ()"><code class="function">gtk_clipboard_request_targets()</code></a>
@ -595,7 +595,7 @@ are received, or when the request fails.</p>
<tr>
<td class="parameter_name"><p>atoms</p></td>
<td class="parameter_description"><p>the supported targets,
as array of <span class="type">GdkAtom</span>, or <code class="literal">NULL</code> if retrieving the data failed. </p></td>
as array of <a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a>, or <code class="literal">NULL</code> if retrieving the data failed. </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>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_atoms]</span></td>
</tr>
<tr>
@ -621,7 +621,7 @@ supplied to
<a name="GtkClipboardRichTextReceivedFunc"></a><h3>GtkClipboardRichTextReceivedFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GtkClipboardRichTextReceivedFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> format</code></em>,
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> format</code></em>,
<em class="parameter"><code>const <span class="type">guint8</span> *text</code></em>,
<em class="parameter"><code><span class="type">gsize</span> length</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
@ -810,7 +810,7 @@ argument passed to <a class="link" href="gtk3-Clipboards.html#gtk-clipboard-set-
<div class="refsect2">
<a name="gtk-clipboard-get"></a><h3>gtk_clipboard_get ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="returnvalue">GtkClipboard</span></a> *
gtk_clipboard_get (<em class="parameter"><code><span class="type">GdkAtom</span> selection</code></em>);</pre>
gtk_clipboard_get (<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> selection</code></em>);</pre>
<p>Returns the clipboard object for the given selection.
See <a class="link" href="gtk3-Clipboards.html#gtk-clipboard-get-for-display" title="gtk_clipboard_get_for_display ()"><code class="function">gtk_clipboard_get_for_display()</code></a> for complete details.</p>
<div class="refsect3">
@ -823,7 +823,7 @@ See <a class="link" href="gtk3-Clipboards.html#gtk-clipboard-get-for-display" ti
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>selection</p></td>
<td class="parameter_description"><p>a <span class="type">GdkAtom</span> which identifies the clipboard to use</p></td>
<td class="parameter_description"><p>a <a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> which identifies the clipboard to use</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
@ -841,26 +841,26 @@ owned by GTK+, must not be freed or unreffed. </p>
<div class="refsect2">
<a name="gtk-clipboard-get-for-display"></a><h3>gtk_clipboard_get_for_display ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="returnvalue">GtkClipboard</span></a> *
gtk_clipboard_get_for_display (<em class="parameter"><code><span class="type">GdkDisplay</span> *display</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> selection</code></em>);</pre>
gtk_clipboard_get_for_display (<em class="parameter"><code><a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> *display</code></em>,
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> selection</code></em>);</pre>
<p>Returns the clipboard object for the given selection.
Cut/copy/paste menu items and keyboard shortcuts should use
the default clipboard, returned by passing <code class="literal">GDK_SELECTION_CLIPBOARD</code> for <em class="parameter"><code>selection</code></em>
the default clipboard, returned by passing <a href="../html/gdk3-Selections.html#GDK-SELECTION-CLIPBOARD:CAPS"><code class="literal">GDK_SELECTION_CLIPBOARD</code></a> for <em class="parameter"><code>selection</code></em>
.
(<code class="literal">GDK_NONE</code> is supported as a synonym for GDK_SELECTION_CLIPBOARD
(<a href="../html/gdk3-Properties-and-Atoms.html#GDK-NONE:CAPS"><code class="literal">GDK_NONE</code></a> is supported as a synonym for GDK_SELECTION_CLIPBOARD
for backwards compatibility reasons.)
The currently-selected object or text should be provided on the clipboard
identified by <span class="type">GDK_SELECTION_PRIMARY</span>. Cut/copy/paste menu items
conceptually copy the contents of the <span class="type">GDK_SELECTION_PRIMARY</span> clipboard
identified by <a href="../html/gdk3-Selections.html#GDK-SELECTION-PRIMARY:CAPS"><span class="type">GDK_SELECTION_PRIMARY</span></a>. Cut/copy/paste menu items
conceptually copy the contents of the <a href="../html/gdk3-Selections.html#GDK-SELECTION-PRIMARY:CAPS"><span class="type">GDK_SELECTION_PRIMARY</span></a> clipboard
to the default clipboard, i.e. they copy the selection to what the
user sees as the clipboard.</p>
<p>(Passing <span class="type">GDK_NONE</span> is the same as using <code class="literal">gdk_atom_intern
<p>(Passing <a href="../html/gdk3-Properties-and-Atoms.html#GDK-NONE:CAPS"><span class="type">GDK_NONE</span></a> is the same as using <code class="literal">gdk_atom_intern
("CLIPBOARD", FALSE)</code>.</p>
<p>See the
<a class="ulink" href="http://www.freedesktop.org/Standards/clipboards-spec" target="_top">FreeDesktop Clipboard Specification</a>
for a detailed discussion of the “CLIPBOARD” vs. “PRIMARY”
selections under the X window system. On Win32 the
<span class="type">GDK_SELECTION_PRIMARY</span> clipboard is essentially ignored.)</p>
<a href="../html/gdk3-Selections.html#GDK-SELECTION-PRIMARY:CAPS"><span class="type">GDK_SELECTION_PRIMARY</span></a> clipboard is essentially ignored.)</p>
<p>It’s possible to have arbitrary named clipboards; if you do invent
new clipboards, you should prefix the selection name with an
underscore (because the ICCCM requires that nonstandard atoms are
@ -878,12 +878,12 @@ clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”.</p>
<tbody>
<tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>the <span class="type">GdkDisplay</span> for which the clipboard is to be retrieved or created.</p></td>
<td class="parameter_description"><p>the <a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> for which the clipboard is to be retrieved or created.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection</p></td>
<td class="parameter_description"><p>a <span class="type">GdkAtom</span> which identifies the clipboard to use.</p></td>
<td class="parameter_description"><p>a <a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> which identifies the clipboard to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
@ -902,9 +902,9 @@ GTK+, must not be freed or unrefd. </p>
<hr>
<div class="refsect2">
<a name="gtk-clipboard-get-display"></a><h3>gtk_clipboard_get_display ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkDisplay</span> *
<pre class="programlisting"><a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="returnvalue">GdkDisplay</span></a> *
gtk_clipboard_get_display (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>);</pre>
<p>Gets the <span class="type">GdkDisplay</span> associated with <em class="parameter"><code>clipboard</code></em>
<p>Gets the <a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> associated with <em class="parameter"><code>clipboard</code></em>
</p>
<div class="refsect3">
<a name="gtk-clipboard-get-display.parameters"></a><h4>Parameters</h4>
@ -923,7 +923,7 @@ gtk_clipboard_get_display (<em class="parameter"><code><a class="link" href="gtk
</div>
<div class="refsect3">
<a name="gtk-clipboard-get-display.returns"></a><h4>Returns</h4>
<p>the <span class="type">GdkDisplay</span> associated with <em class="parameter"><code>clipboard</code></em>
<p>the <a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> associated with <em class="parameter"><code>clipboard</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
@ -933,7 +933,7 @@ gtk_clipboard_get_display (<em class="parameter"><code><a class="link" href="gtk
<div class="refsect2">
<a name="gtk-clipboard-get-default"></a><h3>gtk_clipboard_get_default ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="returnvalue">GtkClipboard</span></a> *
gtk_clipboard_get_default (<em class="parameter"><code><span class="type">GdkDisplay</span> *display</code></em>);</pre>
gtk_clipboard_get_default (<em class="parameter"><code><a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> *display</code></em>);</pre>
<p>Returns the default clipboard object for use with cut/copy/paste menu items
and keyboard shortcuts.</p>
<div class="refsect3">
@ -946,7 +946,7 @@ and keyboard shortcuts.</p>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>the <span class="type">GdkDisplay</span> for which the clipboard is to be retrieved.</p></td>
<td class="parameter_description"><p>the <a href="../html/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> for which the clipboard is to be retrieved.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
@ -1239,7 +1239,7 @@ requested format.</p>
<a name="gtk-clipboard-request-contents"></a><h3>gtk_clipboard_request_contents ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_clipboard_request_contents (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> target</code></em>,
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> target</code></em>,
<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboardReceivedFunc" title="GtkClipboardReceivedFunc ()"><span class="type">GtkClipboardReceivedFunc</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Requests the contents of clipboard as the given target.
@ -1533,7 +1533,7 @@ or the retrieval fails. (It will always be called one way or the other.). </p></
<a name="gtk-clipboard-wait-for-contents"></a><h3>gtk_clipboard_wait_for_contents ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Selections.html#GtkSelectionData"><span class="returnvalue">GtkSelectionData</span></a> *
gtk_clipboard_wait_for_contents (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> target</code></em>);</pre>
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> target</code></em>);</pre>
<p>Requests the contents of the clipboard using the given target.
This function waits for the data to be received using the main
loop, so events, timeouts, etc, may be dispatched during the wait.</p>
@ -1646,7 +1646,7 @@ converted into an image.). </p>
<pre class="programlisting"><span class="returnvalue">guint8</span> *
gtk_clipboard_wait_for_rich_text (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>,
<em class="parameter"><code><a class="link" href="GtkTextBuffer.html" title="GtkTextBuffer"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> *format</code></em>,
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> *format</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *length</code></em>);</pre>
<p>Requests the contents of the clipboard as rich text. This function
waits for the data to be received using the main loop, so events,
@ -1879,7 +1879,7 @@ the actual URI data.</p>
<a name="gtk-clipboard-wait-for-targets"></a><h3>gtk_clipboard_wait_for_targets ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_clipboard_wait_for_targets (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> **targets</code></em>,
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> **targets</code></em>,
<em class="parameter"><code><span class="type">gint</span> *n_targets</code></em>);</pre>
<p>Returns a list of targets that are present on the clipboard, or <code class="literal">NULL</code>
if there aren’t any targets available. The returned list must be
@ -1929,7 +1929,7 @@ otherwise <code class="literal">FALSE</code>.</p>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_clipboard_wait_is_target_available
(<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>,
<em class="parameter"><code><span class="type">GdkAtom</span> target</code></em>);</pre>
<em class="parameter"><code><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> target</code></em>);</pre>
<p>Checks if a clipboard supports pasting data of a given type. This
function can be used to determine if a “Paste” menu item should be
insensitive or not.</p>
@ -1951,7 +1951,7 @@ insensitive or not.</p>
</tr>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>A <span class="type">GdkAtom</span> indicating which target to look for.</p></td>
<td class="parameter_description"><p>A <a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="type">GdkAtom</span></a> indicating which target to look for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
@ -1974,7 +1974,7 @@ gtk_clipboard_set_can_store (<em class="parameter"><code><a class="link" href="g
application exits or when <a class="link" href="gtk3-Clipboards.html#gtk-clipboard-store" title="gtk_clipboard_store ()"><code class="function">gtk_clipboard_store()</code></a> is called.</p>
<p>This value is reset when the clipboard owner changes.
Where the clipboard data is stored is platform dependent,
see <code class="function">gdk_display_store_clipboard()</code> for more information.</p>
see <a href="../html/GdkDisplay.html#gdk-display-store-clipboard"><code class="function">gdk_display_store_clipboard()</code></a> for more information.</p>
<div class="refsect3">
<a name="gtk-clipboard-set-can-store.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@ -2034,7 +2034,7 @@ around after the application has quit.</p>
<hr>
<div class="refsect2">
<a name="gtk-clipboard-get-selection"></a><h3>gtk_clipboard_get_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkAtom</span>
<pre class="programlisting"><a href="../html/gdk3-Properties-and-Atoms.html#GdkAtom"><span class="returnvalue">GdkAtom</span></a>
gtk_clipboard_get_selection (<em class="parameter"><code><a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard</code></em>);</pre>
<p>Gets the selection that this clipboard is for.</p>
<div class="refsect3">
@ -2072,7 +2072,7 @@ gtk_clipboard_get_selection (<em class="parameter"><code><a class="link" href="g
<a name="GtkClipboard-owner-change"></a><h3>The <code class="literal">“owner-change”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="gtk3-Clipboards.html#GtkClipboard"><span class="type">GtkClipboard</span></a> *clipboard,
<span class="type">GdkEvent</span> *event,
<a href="../html/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::owner-change signal is emitted when GTK+ receives an
event that indicates that the ownership of the selection