~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

« back to all changes in this revision

Viewing changes to doc/xml/gnome-vfs-module-callback.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-17 16:12:58 UTC
  • mfrom: (0.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317161258-px3a2czt9g2ktjz3
Tags: 1:2.24.1-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<refentry id="gnome-vfs-20-gnome-vfs-module-callback">
 
1
<refentry id="gnome-vfs-2.0-gnome-vfs-module-callback">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-module-callback.top_of_page">gnome-vfs-module-callback</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-2.0-gnome-vfs-module-callback.top_of_page">gnome-vfs-module-callback</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
6
6
</refmeta>
10
10
<refpurpose>functions used by apps if they want to answer to callback invocations by gnome-vfs modules</refpurpose>
11
11
</refnamediv>
12
12
 
13
 
<refsynopsisdiv id="gnome-vfs-20-gnome-vfs-module-callback.synopsis" role="synopsis">
 
13
<refsynopsisdiv id="gnome-vfs-2.0-gnome-vfs-module-callback.synopsis" role="synopsis">
14
14
<title role="synopsis.title">Synopsis</title>
15
15
 
16
16
<synopsis>
59
59
 
60
60
 
61
61
 
62
 
<refsect1 id="gnome-vfs-20-gnome-vfs-module-callback.description" role="desc">
 
62
<refsect1 id="gnome-vfs-2.0-gnome-vfs-module-callback.description" role="desc">
63
63
<title role="desc.title">Description</title>
 
64
 
64
65
<para>
65
66
</para>
66
67
</refsect1>
67
68
 
68
 
<refsect1 id="gnome-vfs-20-gnome-vfs-module-callback.details" role="details">
 
69
<refsect1 id="gnome-vfs-2.0-gnome-vfs-module-callback.details" role="details">
69
70
<title role="details.title">Details</title>
70
71
<refsect2 id="GnomeVFSModuleCallback" role="function">
71
72
<title>GnomeVFSModuleCallback ()</title>
72
 
<indexterm zone="GnomeVFSModuleCallback"><primary sortas="GnomeVFSModuleCallback">GnomeVFSModuleCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GnomeVFSModuleCallback)           (<link linkend="gconstpointer">gconstpointer</link> in,
 
73
<indexterm zone="GnomeVFSModuleCallback"><primary>GnomeVFSModuleCallback</primary></indexterm>
 
74
<programlisting><link linkend="void">void</link>                (*GnomeVFSModuleCallback)           (<link linkend="gconstpointer">gconstpointer</link> in,
73
75
                                                         <link linkend="gsize">gsize</link> in_size,
74
76
                                                         <link linkend="gpointer">gpointer</link> out,
75
77
                                                         <link linkend="gsize">gsize</link> out_size,
100
102
</variablelist></refsect2>
101
103
<refsect2 id="GnomeVFSModuleCallbackResponse" role="function">
102
104
<title>GnomeVFSModuleCallbackResponse ()</title>
103
 
<indexterm zone="GnomeVFSModuleCallbackResponse"><primary sortas="GnomeVFSModuleCallbackResponse">GnomeVFSModuleCallbackResponse</primary></indexterm><programlisting><link linkend="void">void</link>                (*GnomeVFSModuleCallbackResponse)   (<link linkend="gpointer">gpointer</link> response_data);</programlisting>
 
105
<indexterm zone="GnomeVFSModuleCallbackResponse"><primary>GnomeVFSModuleCallbackResponse</primary></indexterm>
 
106
<programlisting><link linkend="void">void</link>                (*GnomeVFSModuleCallbackResponse)   (<link linkend="gpointer">gpointer</link> response_data);</programlisting>
104
107
<para>
105
108
This is the type of the response function passed to a
106
109
<link linkend="GnomeVFSAsyncModuleCallback"><function>GnomeVFSAsyncModuleCallback()</function></link>. It should be called when the async
113
116
</variablelist></refsect2>
114
117
<refsect2 id="GnomeVFSAsyncModuleCallback" role="function">
115
118
<title>GnomeVFSAsyncModuleCallback ()</title>
116
 
<indexterm zone="GnomeVFSAsyncModuleCallback"><primary sortas="GnomeVFSAsyncModuleCallback">GnomeVFSAsyncModuleCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GnomeVFSAsyncModuleCallback)      (<link linkend="gconstpointer">gconstpointer</link> in,
 
119
<indexterm zone="GnomeVFSAsyncModuleCallback"><primary>GnomeVFSAsyncModuleCallback</primary></indexterm>
 
120
<programlisting><link linkend="void">void</link>                (*GnomeVFSAsyncModuleCallback)      (<link linkend="gconstpointer">gconstpointer</link> in,
117
121
                                                         <link linkend="gsize">gsize</link> in_size,
118
122
                                                         <link linkend="gpointer">gpointer</link> out,
119
123
                                                         <link linkend="gsize">gsize</link> out_size,
156
160
</variablelist></refsect2>
157
161
<refsect2 id="gnome-vfs-module-callback-set-default" role="function">
158
162
<title>gnome_vfs_module_callback_set_default ()</title>
159
 
<indexterm zone="gnome-vfs-module-callback-set-default"><primary sortas="gnome_vfs_module_callback_set_default">gnome_vfs_module_callback_set_default</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_module_callback_set_default
 
163
<indexterm zone="gnome-vfs-module-callback-set-default"><primary>gnome_vfs_module_callback_set_default</primary></indexterm>
 
164
<programlisting><link linkend="void">void</link>                gnome_vfs_module_callback_set_default
160
165
                                                        (const <link linkend="char">char</link> *callback_name,
161
166
                                                         <link linkend="GnomeVFSModuleCallback">GnomeVFSModuleCallback</link> callback,
162
167
                                                         <link linkend="gpointer">gpointer</link> callback_data,
195
200
</variablelist></refsect2>
196
201
<refsect2 id="gnome-vfs-module-callback-push" role="function">
197
202
<title>gnome_vfs_module_callback_push ()</title>
198
 
<indexterm zone="gnome-vfs-module-callback-push"><primary sortas="gnome_vfs_module_callback_push">gnome_vfs_module_callback_push</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_module_callback_push      (const <link linkend="char">char</link> *callback_name,
 
203
<indexterm zone="gnome-vfs-module-callback-push"><primary>gnome_vfs_module_callback_push</primary></indexterm>
 
204
<programlisting><link linkend="void">void</link>                gnome_vfs_module_callback_push      (const <link linkend="char">char</link> *callback_name,
199
205
                                                         <link linkend="GnomeVFSModuleCallback">GnomeVFSModuleCallback</link> callback,
200
206
                                                         <link linkend="gpointer">gpointer</link> callback_data,
201
207
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy_notify);</programlisting>
237
243
</variablelist></refsect2>
238
244
<refsect2 id="gnome-vfs-module-callback-pop" role="function">
239
245
<title>gnome_vfs_module_callback_pop ()</title>
240
 
<indexterm zone="gnome-vfs-module-callback-pop"><primary sortas="gnome_vfs_module_callback_pop">gnome_vfs_module_callback_pop</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_module_callback_pop       (const <link linkend="char">char</link> *callback_name);</programlisting>
241
 
<para>
242
 
Remove the temporary handler for <parameter>callback_name</parameter> most recently set
243
 
with <link linkend="gnome-vfs-module-callback-push"><function>gnome_vfs_module_callback_push()</function></link>.  If another temporary
244
 
handler was previously set on the same thread, it becomes the
245
 
current handler. Otherwise, the default handler, if any, becomes
246
 
current. 
247
 
</para>
248
 
<para>
249
 
The temporary handlers are treated as a first-in first-out
250
 
stack.</para>
 
246
<indexterm zone="gnome-vfs-module-callback-pop"><primary>gnome_vfs_module_callback_pop</primary></indexterm>
 
247
<programlisting><link linkend="void">void</link>                gnome_vfs_module_callback_pop       (const <link linkend="char">char</link> *callback_name);</programlisting>
251
248
<para>
252
249
</para><variablelist role="params">
253
250
<varlistentry><term><parameter>callback_name</parameter>&#160;:</term>
254
 
<listitem><simpara> name of the module callback to remove a temporary handler for.
 
251
<listitem><simpara>
255
252
</simpara></listitem></varlistentry>
256
253
</variablelist></refsect2>
257
254
<refsect2 id="gnome-vfs-async-module-callback-set-default" role="function">
258
255
<title>gnome_vfs_async_module_callback_set_default ()</title>
259
 
<indexterm zone="gnome-vfs-async-module-callback-set-default"><primary sortas="gnome_vfs_async_module_callback_set_default">gnome_vfs_async_module_callback_set_default</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_async_module_callback_set_default
 
256
<indexterm zone="gnome-vfs-async-module-callback-set-default"><primary>gnome_vfs_async_module_callback_set_default</primary></indexterm>
 
257
<programlisting><link linkend="void">void</link>                gnome_vfs_async_module_callback_set_default
260
258
                                                        (const <link linkend="char">char</link> *callback_name,
261
259
                                                         <link linkend="GnomeVFSAsyncModuleCallback">GnomeVFSAsyncModuleCallback</link> callback,
262
260
                                                         <link linkend="gpointer">gpointer</link> callback_data,
303
301
</variablelist></refsect2>
304
302
<refsect2 id="gnome-vfs-async-module-callback-push" role="function">
305
303
<title>gnome_vfs_async_module_callback_push ()</title>
306
 
<indexterm zone="gnome-vfs-async-module-callback-push"><primary sortas="gnome_vfs_async_module_callback_push">gnome_vfs_async_module_callback_push</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_async_module_callback_push
 
304
<indexterm zone="gnome-vfs-async-module-callback-push"><primary>gnome_vfs_async_module_callback_push</primary></indexterm>
 
305
<programlisting><link linkend="void">void</link>                gnome_vfs_async_module_callback_push
307
306
                                                        (const <link linkend="char">char</link> *callback_name,
308
307
                                                         <link linkend="GnomeVFSAsyncModuleCallback">GnomeVFSAsyncModuleCallback</link> callback,
309
308
                                                         <link linkend="gpointer">gpointer</link> callback_data,
350
349
</variablelist></refsect2>
351
350
<refsect2 id="gnome-vfs-async-module-callback-pop" role="function">
352
351
<title>gnome_vfs_async_module_callback_pop ()</title>
353
 
<indexterm zone="gnome-vfs-async-module-callback-pop"><primary sortas="gnome_vfs_async_module_callback_pop">gnome_vfs_async_module_callback_pop</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_async_module_callback_pop (const <link linkend="char">char</link> *callback_name);</programlisting>
 
352
<indexterm zone="gnome-vfs-async-module-callback-pop"><primary>gnome_vfs_async_module_callback_pop</primary></indexterm>
 
353
<programlisting><link linkend="void">void</link>                gnome_vfs_async_module_callback_pop (const <link linkend="char">char</link> *callback_name);</programlisting>
354
354
<para>
355
355
Remove the temporary async handler for <parameter>callback_name</parameter> most recently
356
356
set with <link linkend="gnome-vfs-async-module-callback-push"><function>gnome_vfs_async_module_callback_push()</function></link>.  If another