1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<refentry id="GsfClipData">
<refmeta>
<refentrytitle role="top_of_page">GsfClipData</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GSF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GsfClipData</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="GsfClipFormat">GsfClipFormat</link>;
enum <link linkend="GsfClipFormatWindows">GsfClipFormatWindows</link>;
<link linkend="GsfClipData-struct">GsfClipData</link>;
<link linkend="GsfClipDataClass">GsfClipDataClass</link>;
<link linkend="GsfClipData">GsfClipData</link>* <link linkend="gsf-clip-data-new">gsf_clip_data_new</link> (<link linkend="GsfClipFormat">GsfClipFormat</link> format,
<link linkend="GsfBlob">GsfBlob</link> *data_blob);
<link linkend="GsfClipFormat">GsfClipFormat</link> <link linkend="gsf-clip-data-get-format">gsf_clip_data_get_format</link> (<link linkend="GsfClipData">GsfClipData</link> *clip_data);
<link linkend="GsfBlob">GsfBlob</link>* <link linkend="gsf-clip-data-get-data-blob">gsf_clip_data_get_data_blob</link> (<link linkend="GsfClipData">GsfClipData</link> *clip_data);
<link linkend="GsfClipFormatWindows">GsfClipFormatWindows</link> <link linkend="gsf-clip-data-get-windows-clipboard-format">gsf_clip_data_get_windows_clipboard_format</link>
(<link linkend="GsfClipData">GsfClipData</link> *clip_data,
<link linkend="GError">GError</link> **error);
<link linkend="gconstpointer">gconstpointer</link> <link linkend="gsf-clip-data-peek-real-data">gsf_clip_data_peek_real_data</link> (<link linkend="GsfClipData">GsfClipData</link> *clip_data,
<link linkend="gsize">gsize</link> *ret_size,
<link linkend="GError">GError</link> **error);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GsfClipData
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GsfClipFormat" role="enum"/>enum GsfClipFormat</title>
<indexterm><primary>GsfClipFormat</primary></indexterm><programlisting>typedef enum {
GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD = -1,
GSF_CLIP_FORMAT_MACINTOSH_CLIPBOARD = -2,
GSF_CLIP_FORMAT_GUID = -3,
GSF_CLIP_FORMAT_NO_DATA = 0,
GSF_CLIP_FORMAT_CLIPBOARD_FORMAT_NAME = 1, /* in the file it's actually any positive integer */
GSF_CLIP_FORMAT_UNKNOWN /* this is our own value for unknown types or invalid data */
} GsfClipFormat;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GsfClipFormatWindows" role="enum"/>enum GsfClipFormatWindows</title>
<indexterm><primary>GsfClipFormatWindows</primary></indexterm><programlisting>typedef enum {
GSF_CLIP_FORMAT_WINDOWS_ERROR = -1, /* our own value */
GSF_CLIP_FORMAT_WINDOWS_UNKNOWN = -2, /* our own value */
GSF_CLIP_FORMAT_WINDOWS_METAFILE = 3, /* CF_METAFILEPICT */
GSF_CLIP_FORMAT_WINDOWS_DIB = 8, /* CF_DIB */
GSF_CLIP_FORMAT_WINDOWS_ENHANCED_METAFILE = 14 /* CF_ENHMETAFILE */
} GsfClipFormatWindows;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GsfClipData-struct" role="struct"/>GsfClipData</title>
<indexterm><primary>GsfClipData</primary></indexterm><programlisting>typedef struct _GsfClipData GsfClipData;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GsfClipDataClass" role="struct"/>GsfClipDataClass</title>
<indexterm><primary>GsfClipDataClass</primary></indexterm><programlisting>typedef struct {
GObjectClass parent_class;
} GsfClipDataClass;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gsf-clip-data-new" role="function"/>gsf_clip_data_new ()</title>
<indexterm><primary>gsf_clip_data_new</primary></indexterm><programlisting><link linkend="GsfClipData">GsfClipData</link>* gsf_clip_data_new (<link linkend="GsfClipFormat">GsfClipFormat</link> format,
<link linkend="GsfBlob">GsfBlob</link> *data_blob);</programlisting>
<para>
Creates a new <link linkend="GsfClipData"><type>GsfClipData</type></link> object. This function acquires a reference to the
<parameter>data_blob</parameter>, so you should unref the blob on your own if you no longer need it
directly.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> Format for the data inside the <parameter>data_blob</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data_blob</parameter> :</term>
<listitem><simpara> Object which holds the binary contents for the <link linkend="GsfClipData"><type>GsfClipData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly-created <link linkend="GsfClipData"><type>GsfClipData</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-clip-data-get-format" role="function"/>gsf_clip_data_get_format ()</title>
<indexterm><primary>gsf_clip_data_get_format</primary></indexterm><programlisting><link linkend="GsfClipFormat">GsfClipFormat</link> gsf_clip_data_get_format (<link linkend="GsfClipData">GsfClipData</link> *clip_data);</programlisting>
<para>
Queries the clipboard data format of a <link linkend="GsfClipData"><type>GsfClipData</type></link>. The format refers to the data
blob inside the <parameter>clip_data</parameter>; use <link linkend="gsf-clip-data-get-data-blob"><function>gsf_clip_data_get_data_blob()</function></link> to get that data blob.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>clip_data</parameter> :</term>
<listitem><simpara> A <link linkend="GsfClipData"><type>GsfClipData</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The format in which the <link linkend="GsfClipData"><type>GsfClipData</type></link>'s data blob is stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-clip-data-get-data-blob" role="function"/>gsf_clip_data_get_data_blob ()</title>
<indexterm><primary>gsf_clip_data_get_data_blob</primary></indexterm><programlisting><link linkend="GsfBlob">GsfBlob</link>* gsf_clip_data_get_data_blob (<link linkend="GsfClipData">GsfClipData</link> *clip_data);</programlisting>
<para>
Queries the data blob that actually stores a <link linkend="GsfClipData"><type>GsfClipData</type></link>'s binary data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>clip_data</parameter> :</term>
<listitem><simpara> A <link linkend="GsfClipData"><type>GsfClipData</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new reference to the <link linkend="GsfBlob"><type>GsfBlob</type></link> that stores this <parameter>clip_data</parameter>'s
binary data. You must use <link linkend="g-object-unref"><function>g_object_unref()</function></link> to dispose of that data blob when
you are done with it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-clip-data-get-windows-clipboard-format" role="function"/>gsf_clip_data_get_windows_clipboard_format ()</title>
<indexterm><primary>gsf_clip_data_get_windows_clipboard_format</primary></indexterm><programlisting><link linkend="GsfClipFormatWindows">GsfClipFormatWindows</link> gsf_clip_data_get_windows_clipboard_format
(<link linkend="GsfClipData">GsfClipData</link> *clip_data,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Queries the Windows clipboard data format for a <link linkend="GsfClipData"><type>GsfClipData</type></link>. The <parameter>clip_data</parameter> must
have been created with <link linkend="GSF-CLIP-FORMAT-WINDOWS-CLIPBOARD:CAPS"><type>GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>clip_data</parameter> :</term>
<listitem><simpara> A <link linkend="GsfClipData"><type>GsfClipData</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Location to store error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GsfClipFormatWindows"><type>GsfClipFormatWindows</type></link> value.
Possible errors: <link linkend="GSF-ERROR-INVALID-DATA:CAPS"><type>GSF_ERROR_INVALID_DATA</type></link> if the data blob in the <parameter>clip_data</parameter> is
smaller than it should be; in this case GSF_CLIP_FORMAT_WINDOWS_ERROR will be returned.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-clip-data-peek-real-data" role="function"/>gsf_clip_data_peek_real_data ()</title>
<indexterm><primary>gsf_clip_data_peek_real_data</primary></indexterm><programlisting><link linkend="gconstpointer">gconstpointer</link> gsf_clip_data_peek_real_data (<link linkend="GsfClipData">GsfClipData</link> *clip_data,
<link linkend="gsize">gsize</link> *ret_size,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Queries a pointer directly to the clipboard data of a <link linkend="GsfClipData"><type>GsfClipData</type></link>. The
resulting pointer is not necessarily the same data pointer that was passed to
<link linkend="gsf-blob-new"><function>gsf_blob_new()</function></link> prior to creating the <parameter>clip_data</parameter>. For example, if the data is
in <link linkend="GSF-CLIP-FORMAT-WINDOWS-CLIPBOARD:CAPS"><type>GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD</type></link> 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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>clip_data</parameter> :</term>
<listitem><simpara> A <link linkend="GsfClipData"><type>GsfClipData</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ret_size</parameter> :</term>
<listitem><simpara> Location to return the size of the returned data buffer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Location to store error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the real clipboard data. The size in bytes of this
buffer is returned in the <parameter>ret_size</parameter> argument.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
