← Back to branch summary

~ubuntu-branches/debian/lenny/libgsf/lenny

« back to all changes in this revision

Viewing changes to doc/html/GsfClipData.html

  • Committer: Bazaar Package Importer
  • Author(s): J.H.M. Dassen (Ray)
  • Date: 2006-11-06 22:45:03 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 dapper)
  • Revision ID: james.westby@ubuntu.com-20061106224503-g6pmv1m82zy8jya9
Tags: 1.14.3-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/GsfClipData.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
5
<title>GsfClipData</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
 
7
<link rel="start" href="index.html" title="GSF Reference Manual">
 
8
<link rel="up" href="parsers.html" title="Stream Parsers">
 
9
<link rel="prev" href="gsf-blobs.html" title="GsfBlob">
 
10
<link rel="next" href="misc.html" title="Miscellaneous">
 
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="part" href="intro.html" title="Part&#160;I.&#160;GSF: Introduction">
 
14
<link rel="part" href="history.html" title="Part&#160;II.&#160;GSF: History">
 
15
<link rel="part" href="dependencies.html" title="Part&#160;III.&#160;GSF: Dependencies">
 
16
<link rel="part" href="gsf-users.html" title="Part&#160;IV.&#160;Projects using GSF">
 
17
<link rel="part" href="api.html" title="Part&#160;V.&#160;API Reference">
 
18
<link rel="chapter" href="io.html" title="Basic Input/Output">
 
19
<link rel="chapter" href="sources.html" title="Stream Sources">
 
20
<link rel="chapter" href="parsers.html" title="Stream Parsers">
 
21
<link rel="chapter" href="misc.html" title="Miscellaneous">
 
22
<link rel="index" href="ix01.html" title="Index">
 
23
</head>
 
24
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
25
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
26
<tr valign="middle">
 
27
<td><a accesskey="p" href="gsf-blobs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
28
<td><a accesskey="u" href="parsers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
29
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
30
<th width="100%" align="center">GSF Reference Manual</th>
 
31
<td><a accesskey="n" href="misc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
32
</tr>
 
33
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2605976" class="shortcut">Top</a>
 
34
                  &#160;|&#160;
 
35
                  <a href="#id2606193" class="shortcut">Description</a>
 
36
                  &#160;|&#160;
 
37
                  <a href="#id2606168" class="shortcut">Object Hierarchy</a></nobr></td></tr>
 
38
</table>
 
39
<div class="refentry" lang="en">
 
40
<a name="GsfClipData"></a><div class="titlepage"></div>
 
41
<div class="refnamediv"><table width="100%"><tr>
 
42
<td valign="top">
 
43
<h2>
 
44
<a name="id2605976"></a><span class="refentrytitle">GsfClipData</span>
 
45
</h2>
 
46
<p>GsfClipData</p>
 
47
</td>
 
48
<td valign="top" align="right"></td>
 
49
</tr></table></div>
 
50
<div class="refsynopsisdiv">
 
51
<h2>Synopsis</h2>
 
52
<pre class="synopsis">
 
53
 
 
54
 
 
55
 
 
56
enum        <a href="GsfClipData.html#GsfClipFormat">GsfClipFormat</a>;
 
57
enum        <a href="GsfClipData.html#GsfClipFormatWindows">GsfClipFormatWindows</a>;
 
58
            <a href="GsfClipData.html#GsfClipData-struct">GsfClipData</a>;
 
59
            <a href="GsfClipData.html#GsfClipDataClass">GsfClipDataClass</a>;
 
60
<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a>* <a href="GsfClipData.html#gsf-clip-data-new">gsf_clip_data_new</a>              (<a href="GsfClipData.html#GsfClipFormat">GsfClipFormat</a> format,
 
61
                                             <a href="gsf-blobs.html#GsfBlob">GsfBlob</a> *data_blob);
 
62
<a href="GsfClipData.html#GsfClipFormat">GsfClipFormat</a> <a href="GsfClipData.html#gsf-clip-data-get-format">gsf_clip_data_get_format</a>      (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data);
 
63
<a href="gsf-blobs.html#GsfBlob">GsfBlob</a>*    <a href="GsfClipData.html#gsf-clip-data-get-data-blob">gsf_clip_data_get_data_blob</a>     (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data);
 
64
<a href="GsfClipData.html#GsfClipFormatWindows">GsfClipFormatWindows</a> <a href="GsfClipData.html#gsf-clip-data-get-windows-clipboard-format">gsf_clip_data_get_windows_clipboard_format</a>
 
65
                                            (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data,
 
66
                                             GError **error);
 
67
gconstpointer <a href="GsfClipData.html#gsf-clip-data-peek-real-data">gsf_clip_data_peek_real_data</a>  (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data,
 
68
                                             gsize *ret_size,
 
69
                                             GError **error);
 
70
 
 
71
 
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1" lang="en">
 
75
<a name="id2606168"></a><h2>Object Hierarchy</h2>
 
76
<pre class="synopsis">
 
77
 
 
78
  GObject
 
79
   +----GsfClipData
 
80
</pre>
 
81
</div>
 
82
<div class="refsect1" lang="en">
 
83
<a name="id2606193"></a><h2>Description</h2>
 
84
<p>
 
85
 
 
86
</p>
 
87
</div>
 
88
<div class="refsect1" lang="en">
 
89
<a name="id2606207"></a><h2>Details</h2>
 
90
<div class="refsect2" lang="en">
 
91
<a name="id2606218"></a><h3>
 
92
<a name="GsfClipFormat"></a>enum GsfClipFormat</h3>
 
93
<a class="indexterm" name="id2606231"></a><pre class="programlisting">typedef enum {
 
94
        GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD = -1,
 
95
        GSF_CLIP_FORMAT_MACINTOSH_CLIPBOARD = -2,
 
96
        GSF_CLIP_FORMAT_GUID = -3,
 
97
        GSF_CLIP_FORMAT_NO_DATA = 0,
 
98
        GSF_CLIP_FORMAT_CLIPBOARD_FORMAT_NAME = 1, /* in the file it's actually any positive integer */
 
99
        GSF_CLIP_FORMAT_UNKNOWN /* this is our own value for unknown types or invalid data */
 
100
} GsfClipFormat;
 
101
</pre>
 
102
<p>
 
103
 
 
104
</p>
 
105
</div>
 
106
<hr>
 
107
<div class="refsect2" lang="en">
 
108
<a name="id2606251"></a><h3>
 
109
<a name="GsfClipFormatWindows"></a>enum GsfClipFormatWindows</h3>
 
110
<a class="indexterm" name="id2606264"></a><pre class="programlisting">typedef enum {
 
111
        GSF_CLIP_FORMAT_WINDOWS_ERROR = -1,             /* our own value */
 
112
        GSF_CLIP_FORMAT_WINDOWS_UNKNOWN = -2,           /* our own value */
 
113
        GSF_CLIP_FORMAT_WINDOWS_METAFILE = 3,           /* CF_METAFILEPICT */
 
114
        GSF_CLIP_FORMAT_WINDOWS_DIB = 8,                /* CF_DIB */
 
115
        GSF_CLIP_FORMAT_WINDOWS_ENHANCED_METAFILE = 14  /* CF_ENHMETAFILE */
 
116
} GsfClipFormatWindows;
 
117
</pre>
 
118
<p>
 
119
 
 
120
</p>
 
121
</div>
 
122
<hr>
 
123
<div class="refsect2" lang="en">
 
124
<a name="id2606285"></a><h3>
 
125
<a name="GsfClipData-struct"></a>GsfClipData</h3>
 
126
<a class="indexterm" name="id2606298"></a><pre class="programlisting">typedef struct _GsfClipData GsfClipData;</pre>
 
127
<p>
 
128
 
 
129
</p>
 
130
</div>
 
131
<hr>
 
132
<div class="refsect2" lang="en">
 
133
<a name="id2606313"></a><h3>
 
134
<a name="GsfClipDataClass"></a>GsfClipDataClass</h3>
 
135
<a class="indexterm" name="id2606325"></a><pre class="programlisting">typedef struct {
 
136
        GObjectClass parent_class;
 
137
} GsfClipDataClass;
 
138
</pre>
 
139
<p>
 
140
 
 
141
</p>
 
142
</div>
 
143
<hr>
 
144
<div class="refsect2" lang="en">
 
145
<a name="id2606341"></a><h3>
 
146
<a name="gsf-clip-data-new"></a>gsf_clip_data_new ()</h3>
 
147
<a class="indexterm" name="id2606355"></a><pre class="programlisting"><a href="GsfClipData.html" title="GsfClipData">GsfClipData</a>* gsf_clip_data_new              (<a href="GsfClipData.html#GsfClipFormat">GsfClipFormat</a> format,
 
148
                                             <a href="gsf-blobs.html#GsfBlob">GsfBlob</a> *data_blob);</pre>
 
149
<p>
 
150
Creates a new <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a> object.  This function acquires a reference to the
 
151
<em class="parameter"><code>data_blob</code></em>, so you should unref the blob on your own if you no longer need it
 
152
directly.</p>
 
153
<p>
 
154
 
 
155
</p>
 
156
<div class="variablelist"><table border="0">
 
157
<col align="left" valign="top">
 
158
<tbody>
 
159
<tr>
 
160
<td><span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
 
161
<td> Format for the data inside the <em class="parameter"><code>data_blob</code></em>
 
162
</td>
 
163
</tr>
 
164
<tr>
 
165
<td><span class="term"><em class="parameter"><code>data_blob</code></em>&#160;:</span></td>
 
166
<td> Object which holds the binary contents for the <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>
 
167
</td>
 
168
</tr>
 
169
<tr>
 
170
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
171
<td> A newly-created <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.
 
172
</td>
 
173
</tr>
 
174
</tbody>
 
175
</table></div>
 
176
</div>
 
177
<hr>
 
178
<div class="refsect2" lang="en">
 
179
<a name="id2606475"></a><h3>
 
180
<a name="gsf-clip-data-get-format"></a>gsf_clip_data_get_format ()</h3>
 
181
<a class="indexterm" name="id2606488"></a><pre class="programlisting"><a href="GsfClipData.html#GsfClipFormat">GsfClipFormat</a> gsf_clip_data_get_format      (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data);</pre>
 
182
<p>
 
183
Queries the clipboard data format of a <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.  The format refers to the data
 
184
blob inside the <em class="parameter"><code>clip_data</code></em>; use <a href="GsfClipData.html#gsf-clip-data-get-data-blob"><code class="function">gsf_clip_data_get_data_blob()</code></a> to get that data blob.</p>
 
185
<p>
 
186
 
 
187
</p>
 
188
<div class="variablelist"><table border="0">
 
189
<col align="left" valign="top">
 
190
<tbody>
 
191
<tr>
 
192
<td><span class="term"><em class="parameter"><code>clip_data</code></em>&#160;:</span></td>
 
193
<td> A <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.
 
194
</td>
 
195
</tr>
 
196
<tr>
 
197
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
198
<td> The format in which the <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>'s data blob is stored.
 
199
</td>
 
200
</tr>
 
201
</tbody>
 
202
</table></div>
 
203
</div>
 
204
<hr>
 
205
<div class="refsect2" lang="en">
 
206
<a name="id2606591"></a><h3>
 
207
<a name="gsf-clip-data-get-data-blob"></a>gsf_clip_data_get_data_blob ()</h3>
 
208
<a class="indexterm" name="id2606605"></a><pre class="programlisting"><a href="gsf-blobs.html#GsfBlob">GsfBlob</a>*    gsf_clip_data_get_data_blob     (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data);</pre>
 
209
<p>
 
210
Queries the data blob that actually stores a <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>'s binary data.</p>
 
211
<p>
 
212
 
 
213
</p>
 
214
<div class="variablelist"><table border="0">
 
215
<col align="left" valign="top">
 
216
<tbody>
 
217
<tr>
 
218
<td><span class="term"><em class="parameter"><code>clip_data</code></em>&#160;:</span></td>
 
219
<td> A <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.
 
220
</td>
 
221
</tr>
 
222
<tr>
 
223
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
224
<td> A new reference to the <a href="gsf-blobs.html#GsfBlob"><span class="type">GsfBlob</span></a> that stores this <em class="parameter"><code>clip_data</code></em>'s
 
225
binary data.  You must use <code class="function">g_object_unref()</code> to dispose of that data blob when
 
226
you are done with it.
 
227
</td>
 
228
</tr>
 
229
</tbody>
 
230
</table></div>
 
231
</div>
 
232
<hr>
 
233
<div class="refsect2" lang="en">
 
234
<a name="id2606709"></a><h3>
 
235
<a name="gsf-clip-data-get-windows-clipboard-format"></a>gsf_clip_data_get_windows_clipboard_format ()</h3>
 
236
<a class="indexterm" name="id2606724"></a><pre class="programlisting"><a href="GsfClipData.html#GsfClipFormatWindows">GsfClipFormatWindows</a> gsf_clip_data_get_windows_clipboard_format
 
237
                                            (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data,
 
238
                                             GError **error);</pre>
 
239
<p>
 
240
Queries the Windows clipboard data format for a <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.  The <em class="parameter"><code>clip_data</code></em> must
 
241
have been created with <span class="type">GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD</span>.</p>
 
242
<p>
 
243
 
 
244
</p>
 
245
<div class="variablelist"><table border="0">
 
246
<col align="left" valign="top">
 
247
<tbody>
 
248
<tr>
 
249
<td><span class="term"><em class="parameter"><code>clip_data</code></em>&#160;:</span></td>
 
250
<td> A <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.
 
251
</td>
 
252
</tr>
 
253
<tr>
 
254
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
255
<td> Location to store error, or <code class="literal">NULL</code>
 
256
</td>
 
257
</tr>
 
258
<tr>
 
259
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
260
<td> A <a href="GsfClipData.html#GsfClipFormatWindows"><span class="type">GsfClipFormatWindows</span></a> value.
 
261
 
 
262
Possible errors: <span class="type">GSF_ERROR_INVALID_DATA</span> if the data blob in the <em class="parameter"><code>clip_data</code></em> is
 
263
smaller than it should be; in this case GSF_CLIP_FORMAT_WINDOWS_ERROR will be returned.
 
264
</td>
 
265
</tr>
 
266
</tbody>
 
267
</table></div>
 
268
</div>
 
269
<hr>
 
270
<div class="refsect2" lang="en">
 
271
<a name="id2606878"></a><h3>
 
272
<a name="gsf-clip-data-peek-real-data"></a>gsf_clip_data_peek_real_data ()</h3>
 
273
<a class="indexterm" name="id2606891"></a><pre class="programlisting">gconstpointer gsf_clip_data_peek_real_data  (<a href="GsfClipData.html" title="GsfClipData">GsfClipData</a> *clip_data,
 
274
                                             gsize *ret_size,
 
275
                                             GError **error);</pre>
 
276
<p>
 
277
Queries a pointer directly to the clipboard data of a <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.  The
 
278
resulting pointer is not necessarily the same data pointer that was passed to
 
279
<a href="gsf-blobs.html#gsf-blob-new"><code class="function">gsf_blob_new()</code></a> prior to creating the <em class="parameter"><code>clip_data</code></em>.  For example, if the data is
 
280
in <span class="type">GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD</span> format, then it will have extra header
 
281
bytes in front of the actual metafile data.  This function will skip over
 
282
those header bytes if necessary and return a pointer to the "real" data.</p>
 
283
<p>
 
284
 
 
285
</p>
 
286
<div class="variablelist"><table border="0">
 
287
<col align="left" valign="top">
 
288
<tbody>
 
289
<tr>
 
290
<td><span class="term"><em class="parameter"><code>clip_data</code></em>&#160;:</span></td>
 
291
<td> A <a href="GsfClipData.html" title="GsfClipData"><span class="type">GsfClipData</span></a>.
 
292
</td>
 
293
</tr>
 
294
<tr>
 
295
<td><span class="term"><em class="parameter"><code>ret_size</code></em>&#160;:</span></td>
 
296
<td> Location to return the size of the returned data buffer.
 
297
</td>
 
298
</tr>
 
299
<tr>
 
300
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
301
<td> Location to store error, or <code class="literal">NULL</code>.
 
302
</td>
 
303
</tr>
 
304
<tr>
 
305
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
306
<td> Pointer to the real clipboard data.  The size in bytes of this
 
307
buffer is returned in the <em class="parameter"><code>ret_size</code></em> argument.
 
308
</td>
 
309
</tr>
 
310
</tbody>
 
311
</table></div>
 
312
</div>
 
313
</div>
 
314
</div>
 
315
</body>
 
316
</html>