RubyGems - gsf - Versions diffs - 3.0.9-x64-mingw32 - Mend

gsf 3.0.9-x64-mingw32

Files changed (166) hide show

data/vendor/local/share/gtk-doc/html/gsf/gsf-clip-data.html ADDED Viewed

@@ -0,0 +1,444 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GSF Reference Manual: GsfClipData</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="GSF Reference Manual">
+<link rel="up" href="parsers.html" title="Stream Parsers">
+<link rel="prev" href="gsf-blobs.html" title="GsfBlob">
+<link rel="next" href="misc.html" title="Miscellaneous">
+<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
+                  <a href="#gsf-clip-data.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
+                  <a href="#gsf-clip-data.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="gsf-blobs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="misc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="gsf-clip-data"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gsf-clip-data.top_of_page"></a>GsfClipData</span></h2>
+<p>GsfClipData</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="gsf-clip-data.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-clip-data.html#GsfClipData"><span class="returnvalue">GsfClipData</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-clip-data.html#gsf-clip-data-new" title="gsf_clip_data_new ()">gsf_clip_data_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-clip-data.html#GsfClipFormat" title="enum GsfClipFormat"><span class="returnvalue">GsfClipFormat</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-clip-data.html#gsf-clip-data-get-format" title="gsf_clip_data_get_format ()">gsf_clip_data_get_format</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-blobs.html#GsfBlob"><span class="returnvalue">GsfBlob</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-clip-data.html#gsf-clip-data-get-data-blob" title="gsf_clip_data_get_data_blob ()">gsf_clip_data_get_data_blob</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-clip-data.html#GsfClipFormatWindows" title="enum GsfClipFormatWindows"><span class="returnvalue">GsfClipFormatWindows</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-clip-data.html#gsf-clip-data-get-windows-clipboard-format" title="gsf_clip_data_get_windows_clipboard_format ()">gsf_clip_data_get_windows_clipboard_format</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gconstpointer</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-clip-data.html#gsf-clip-data-peek-real-data" title="gsf_clip_data_peek_real_data ()">gsf_clip_data_peek_real_data</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<a name="GsfClipData"></a><div class="refsect1">
+<a name="gsf-clip-data.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="gsf-clip-data.html#GsfClipFormat" title="enum GsfClipFormat">GsfClipFormat</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="gsf-clip-data.html#GsfClipFormatWindows" title="enum GsfClipFormatWindows">GsfClipFormatWindows</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="gsf-clip-data.html#GsfClipData-struct" title="struct GsfClipData">GsfClipData</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-clip-data.html#GsfClipDataClass" title="GsfClipDataClass">GsfClipDataClass</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-clip-data.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">╰──</span> GsfClipData
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsf-clip-data.description"></a><h2>Description</h2>
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsf-clip-data.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gsf-clip-data-new"></a><h3>gsf_clip_data_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-clip-data.html#GsfClipData"><span class="returnvalue">GsfClipData</span></a> *
+gsf_clip_data_new (<em class="parameter"><code><a class="link" href="gsf-clip-data.html#GsfClipFormat" title="enum GsfClipFormat"><span class="type">GsfClipFormat</span></a> format</code></em>,
+                   <em class="parameter"><code><a class="link" href="gsf-blobs.html#GsfBlob"><span class="type">GsfBlob</span></a> *data_blob</code></em>);</pre>
+<p>Creates a new <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a> object.  This function acquires a reference to the
+<em class="parameter"><code>data_blob</code></em>
+, so you should unref the blob on your own if you no longer need it
+directly.</p>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.2.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>format</p></td>
+<td class="parameter_description"><p>Format for the data inside the <em class="parameter"><code>data_blob</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data_blob</p></td>
+<td class="parameter_description"><p>Object which holds the binary contents for the <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.2.6"></a><h4>Returns</h4>
+<p> A newly-created <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-clip-data-get-format"></a><h3>gsf_clip_data_get_format ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-clip-data.html#GsfClipFormat" title="enum GsfClipFormat"><span class="returnvalue">GsfClipFormat</span></a>
+gsf_clip_data_get_format (<em class="parameter"><code><a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a> *clip_data</code></em>);</pre>
+<p>Queries the clipboard data format of a <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.  The format refers to the data
+blob inside the <em class="parameter"><code>clip_data</code></em>
+; use <a class="link" href="gsf-clip-data.html#gsf-clip-data-get-data-blob" title="gsf_clip_data_get_data_blob ()"><code class="function">gsf_clip_data_get_data_blob()</code></a> to get that data blob.</p>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.3.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>clip_data</p></td>
+<td class="parameter_description"><p>A <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.3.6"></a><h4>Returns</h4>
+<p> The format in which the <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>'s data blob is stored.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-clip-data-get-data-blob"></a><h3>gsf_clip_data_get_data_blob ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-blobs.html#GsfBlob"><span class="returnvalue">GsfBlob</span></a> *
+gsf_clip_data_get_data_blob (<em class="parameter"><code><a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a> *clip_data</code></em>);</pre>
+<p>Queries the data blob that actually stores a <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>'s binary data.</p>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>clip_data</p></td>
+<td class="parameter_description"><p>A <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.4.6"></a><h4>Returns</h4>
+<p> A new reference to the <a class="link" href="gsf-blobs.html#GsfBlob"><span class="type">GsfBlob</span></a> that stores this <em class="parameter"><code>clip_data</code></em>
+'s
+binary data.  You must use <code class="function">g_object_unref()</code> to dispose of that data blob when
+you are done with it. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-clip-data-get-windows-clipboard-format"></a><h3>gsf_clip_data_get_windows_clipboard_format ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-clip-data.html#GsfClipFormatWindows" title="enum GsfClipFormatWindows"><span class="returnvalue">GsfClipFormatWindows</span></a>
+gsf_clip_data_get_windows_clipboard_format
+                               (<em class="parameter"><code><a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a> *clip_data</code></em>,
+                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<p>Queries the Windows clipboard data format for a <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.  The <em class="parameter"><code>clip_data</code></em>
+ must
+have been created with <a class="link" href="gsf-clip-data.html#GSF-CLIP-FORMAT-WINDOWS-CLIPBOARD:CAPS"><span class="type">GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD</span></a>.</p>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.5.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>clip_data</p></td>
+<td class="parameter_description"><p>A <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>Location to store error, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.5.6"></a><h4>Returns</h4>
+<p> A <a class="link" href="gsf-clip-data.html#GsfClipFormatWindows" title="enum GsfClipFormatWindows"><span class="type">GsfClipFormatWindows</span></a> value.</p>
+<p>Possible errors: <a class="link" href="gsf-utils.html#GSF-ERROR-INVALID-DATA:CAPS"><span class="type">GSF_ERROR_INVALID_DATA</span></a> if the data blob in the <em class="parameter"><code>clip_data</code></em>
+is
+smaller than it should be; in this case GSF_CLIP_FORMAT_WINDOWS_ERROR will be returned.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-clip-data-peek-real-data"></a><h3>gsf_clip_data_peek_real_data ()</h3>
+<pre class="programlisting"><span class="returnvalue">gconstpointer</span>
+gsf_clip_data_peek_real_data (<em class="parameter"><code><a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a> *clip_data</code></em>,
+                              <em class="parameter"><code><span class="type">gsize</span> *ret_size</code></em>,
+                              <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<p>Queries a pointer directly to the clipboard data of a <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.  The
+resulting pointer is not necessarily the same data pointer that was passed to
+<code class="function">gsf_blob_new()</code> prior to creating the <em class="parameter"><code>clip_data</code></em>
+.  For example, if the data is
+in <a class="link" href="gsf-clip-data.html#GSF-CLIP-FORMAT-WINDOWS-CLIPBOARD:CAPS"><span class="type">GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD</span></a> format, then it will have extra header
+bytes in front of the actual metafile data.  This function will skip over
+those header bytes if necessary and return a pointer to the "real" data.</p>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.6.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>clip_data</p></td>
+<td class="parameter_description"><p>A <a class="link" href="gsf-clip-data.html#GsfClipData"><span class="type">GsfClipData</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>ret_size</p></td>
+<td class="parameter_description"><p>Location to return the size of the returned data buffer.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>Location to store error, or <code class="literal">NULL</code>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.5.10.8.6.6"></a><h4>Returns</h4>
+<p> Pointer to the real clipboard data.  The size in bytes of this
+buffer is returned in the <em class="parameter"><code>ret_size</code></em>
+argument. </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>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-clip-data.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GsfClipFormat"></a><h3>enum GsfClipFormat</h3>
+<div class="refsect3">
+<a name="id-1.6.5.10.9.2.3"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="300px" class="enum_members_name">
+<col class="enum_members_description">
+<col width="200px" class="enum_members_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-WINDOWS-CLIPBOARD:CAPS"></a>GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD</p></td>
+<td class="enum_member_description">
+<p>Windows clipboard format</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-MACINTOSH-CLIPBOARD:CAPS"></a>GSF_CLIP_FORMAT_MACINTOSH_CLIPBOARD</p></td>
+<td class="enum_member_description">
+<p>Macintosh clipboard format</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-GUID:CAPS"></a>GSF_CLIP_FORMAT_GUID</p></td>
+<td class="enum_member_description">
+<p>GUID that contains a format identifier</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-NO-DATA:CAPS"></a>GSF_CLIP_FORMAT_NO_DATA</p></td>
+<td class="enum_member_description">
+<p>No clipboard data</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-CLIPBOARD-FORMAT-NAME:CAPS"></a>GSF_CLIP_FORMAT_CLIPBOARD_FORMAT_NAME</p></td>
+<td class="enum_member_description">
+<p>Custom clipboard format</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-UNKNOWN:CAPS"></a>GSF_CLIP_FORMAT_UNKNOWN</p></td>
+<td class="enum_member_description">
+<p>Unknown clipboard type or invalid data</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfClipFormatWindows"></a><h3>enum GsfClipFormatWindows</h3>
+<div class="refsect3">
+<a name="id-1.6.5.10.9.3.3"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="300px" class="enum_members_name">
+<col class="enum_members_description">
+<col width="200px" class="enum_members_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-WINDOWS-ERROR:CAPS"></a>GSF_CLIP_FORMAT_WINDOWS_ERROR</p></td>
+<td class="enum_member_description">
+<p>error</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-WINDOWS-UNKNOWN:CAPS"></a>GSF_CLIP_FORMAT_WINDOWS_UNKNOWN</p></td>
+<td class="enum_member_description">
+<p>unknown</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-WINDOWS-METAFILE:CAPS"></a>GSF_CLIP_FORMAT_WINDOWS_METAFILE</p></td>
+<td class="enum_member_description">
+<p>CF_METAFILEPICT</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-WINDOWS-DIB:CAPS"></a>GSF_CLIP_FORMAT_WINDOWS_DIB</p></td>
+<td class="enum_member_description">
+<p>CF_DIB</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GSF-CLIP-FORMAT-WINDOWS-ENHANCED-METAFILE:CAPS"></a>GSF_CLIP_FORMAT_WINDOWS_ENHANCED_METAFILE</p></td>
+<td class="enum_member_description">
+<p>CF_ENHMETAFILE</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfClipData-struct"></a><h3>struct GsfClipData</h3>
+<pre class="programlisting">struct GsfClipData;</pre>
+<p>
+</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfClipDataClass"></a><h3>GsfClipDataClass</h3>
+<pre class="programlisting">typedef struct _GsfClipDataClass GsfClipDataClass;</pre>
+<p>
+</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>