libbonobo2-dev 2.32.1-3 / usr / share / gtk-doc / html / libbonobo / libbonobo-bonobo-persist-file.html

This file is indexed.

/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-persist-file.html is in libbonobo2-dev 2.32.1-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libbonobo Reference Manual: BonoboPersistFile</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="persist.html" title="Persistency">
<link rel="prev" href="libbonobo-bonobo-persist.html" title="BonoboPersist">
<link rel="next" href="libbonobo-bonobo-persist-stream.html" title="BonoboPersistStream">
<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="#libbonobo-bonobo-persist-file.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#libbonobo-bonobo-persist-file.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="persist.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libbonobo-bonobo-persist.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libbonobo-bonobo-persist-stream.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libbonobo-bonobo-persist-file"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-persist-file.top_of_page"></a>BonoboPersistFile</span></h2>
<p>BonoboPersistFile — Interface for anything that can save / load itself from a file.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-file.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">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFileIOFn" title="BonoboPersistFileIOFn ()">*BonoboPersistFileIOFn</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="returnvalue">BonoboPersistFile</span></a> *
</td>
<td class="function_name">
<a class="link" href="libbonobo-bonobo-persist-file.html#bonobo-persist-file-new" title="bonobo_persist_file_new ()">bonobo_persist_file_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="returnvalue">BonoboPersistFile</span></a> *
</td>
<td class="function_name">
<a class="link" href="libbonobo-bonobo-persist-file.html#bonobo-persist-file-construct" title="bonobo_persist_file_construct ()">bonobo_persist_file_construct</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="BonoboPersistFile"></a><div class="refsect1">
<a name="libbonobo-bonobo-persist-file.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">struct</td>
<td class="function_name"><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile-struct" title="struct BonoboPersistFile">BonoboPersistFile</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFileClass" title="BonoboPersistFileClass">BonoboPersistFileClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-file.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
        <span class="lineart">╰──</span> <a class="link" href="libbonobo-bonobo-persist.html#BonoboPersist">BonoboPersist</a>
            <span class="lineart">╰──</span> BonoboPersistFile
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-file.description"></a><h2>Description</h2>
<p>
The PersistFile interface is a useful interface for Bonoboizing
legacy applications, however, for new / correct applications it
is far preferable to implement the <a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a> interface,
since this will not only result in a nice clean to your application
architecture, but also allow the transparent use of local, remote,
and synthetic streams.
</p>
<p>
This interface works by connecting callbacks to the methods, in
a pretty deprecated fashion, it is probably better nowadays to
simply sub-class the BonoboXObject and override the epv methods.
Either way, after all the caveats here is an example use:
  </p>
<div class="example">
<a name="id-1.7.7.7.3.1"></a><p class="title"><b>Example 25. Persist file implementation</b></p>
<div class="example-contents"><pre class="programlisting">
static gint
load_from_file (BonoboPersistFile *pf,
                const CORBA_char  *filename,
		CORBA_Environment *ev,
                void              *closure)
{
	EogImageData *image_data = closure;
	g_warning ("Load from '%s'", filename);
	return 0; /* Return 0 on success */
}
static gint
save_to_file (BonoboPersistFile *pf,
              const CORBA_char  *filename,
              CORBA_Environment *ev,
              void              *closure)
{
	EogImageData *image_data = closure;
	g_warning ("Save to '%s'", filename);
	return 0; /* Return 0 on success */
}
    </pre></div>
</div>
<p><br class="example-break">
Having implemented the callbacks we then have to register them
and aggregate the interface to our object:
  </p>
<div class="example">
<a name="id-1.7.7.7.3.2"></a><p class="title"><b>Example 26. Aggregating a new PersistFile</b></p>
<div class="example-contents"><pre class="programlisting">
EogImageData *
eog_image_data_construct (EogImageData *image_data)
{
	BonoboObject        *retval;
	BonoboPersistFile   *file;
	file = bonobo_persist_file_new (
		load_from_file, save_to_file, image_data);
	if (file == NULL) {
		bonobo_object_unref (BONOBO_OBJECT (image_data));
		return NULL;
	}
	bonobo_object_add_interface (BONOBO_OBJECT (image_data),
				     BONOBO_OBJECT (file));
	return image_data;
}
    </pre></div>
</div>
<p><br class="example-break">
Note again, that you should be writing a BonoboPersistStream
interface, however if you have already done this you might like
to just have hooks through so that old apps can use the PersistFile
interface:
  </p>
<div class="example">
<a name="id-1.7.7.7.3.3"></a><p class="title"><b>Example 27. Chaining to a <span class="type">PersistStream</span> implementation</b></p>
<div class="example-contents"><pre class="programlisting">
static gint
load_from_file (BonoboPersistFile *pf,
                const CORBA_char  *filename,
		CORBA_Environment *ev,
                void              *closure)
{
	Bonobo_PersistStream ps = closure;
	BonoboStream *stream;
	stream = bonobo_stream_open (
		BONOBO_IO_DRIVER_FS,
		filename, Bonobo_STORAGE_READ,
		0);
	if (!stream)
		return 0;
	.. extract content type from file ...
	Bonobo_PersistStream_load (ps, type, ev);
	return 0; /* Return 0 on success */
}
static gint
save_to_file (BonoboPersistFile *pf,
              const CORBA_char  *filename,
              CORBA_Environment *ev,
              void              *closure)
{
	Bonobo_PersistStream ps = closure;
	BonoboStream *stream;
	stream = bonobo_stream_open (
		BONOBO_IO_DRIVER_FS,
		filename, Bonobo_STORAGE_WRITE | Bonobo_STORAGE_CREATE,
		S_IRUSR | S_IWUSR | S_IRGRP);
	if (!stream)
		return 0;
	.. work out content type we want to save ...
	Bonobo_PersistStream_save (ps, type, ev);
	return 0; /* Return 0 on success */
}
     </pre></div>
</div>
<p><br class="example-break">
  The mime type data can be extracted from gnome-vfs or gnome-mime.
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-file.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="BonoboPersistFileIOFn"></a><h3>BonoboPersistFileIOFn ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
<span class="c_punctuation">(</span>*BonoboPersistFileIOFn<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="type">BonoboPersistFile</span></a> *pf</code></em>,
                          <em class="parameter"><code>const <span class="type">CORBA_char</span> *uri</code></em>,
                          <em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>,
                          <em class="parameter"><code><span class="type">void</span> *closure</code></em>);</pre>
<div class="warning"><p><code class="literal">BonoboPersistFileIOFn</code> is deprecated and should not be used in newly-written code.</p></div>
<p>
</p>
<div class="refsect3">
<a name="id-1.7.7.8.2.6"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-persist-file-new"></a><h3>bonobo_persist_file_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="returnvalue">BonoboPersistFile</span></a> *
bonobo_persist_file_new (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFileIOFn" title="BonoboPersistFileIOFn ()"><span class="type">BonoboPersistFileIOFn</span></a> load_fn</code></em>,
                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFileIOFn" title="BonoboPersistFileIOFn ()"><span class="type">BonoboPersistFileIOFn</span></a> save_fn</code></em>,
                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *iid</code></em>,
                         <em class="parameter"><code><span class="type">void</span> *closure</code></em>);</pre>
<div class="warning"><p><code class="literal">bonobo_persist_file_new</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates a BonoboPersistFile object.  The <em class="parameter"><code>load_fn</code></em>
 and <em class="parameter"><code>save_fn</code></em>

parameters might be NULL.  If this is the case, the load and save 
operations are performed by the class load and save methods</p>
<div class="refsect3">
<a name="id-1.7.7.8.3.6"></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>load_fn</p></td>
<td class="parameter_description"><p>Loading routine</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>save_fn</p></td>
<td class="parameter_description"><p>Saving routine</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iid</p></td>
<td class="parameter_description"><p>OAF IID of the object this interface is aggregated to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>closure</p></td>
<td class="parameter_description"><p>Data passed to IO routines.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.7.8.3.7"></a><h4>Returns</h4>
<p> the <a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="type">BonoboPersistFile</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-persist-file-construct"></a><h3>bonobo_persist_file_construct ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="returnvalue">BonoboPersistFile</span></a> *
bonobo_persist_file_construct (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="type">BonoboPersistFile</span></a> *pf</code></em>,
                               <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFileIOFn" title="BonoboPersistFileIOFn ()"><span class="type">BonoboPersistFileIOFn</span></a> load_fn</code></em>,
                               <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFileIOFn" title="BonoboPersistFileIOFn ()"><span class="type">BonoboPersistFileIOFn</span></a> save_fn</code></em>,
                               <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *iid</code></em>,
                               <em class="parameter"><code><span class="type">void</span> *closure</code></em>);</pre>
<div class="warning"><p><code class="literal">bonobo_persist_file_construct</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Initializes the BonoboPersistFile object.  The <em class="parameter"><code>load_fn</code></em>
 and <em class="parameter"><code>save_fn</code></em>

parameters might be NULL.  If this is the case, the load and save 
operations are performed by the class load and save methods</p>
<div class="refsect3">
<a name="id-1.7.7.8.4.6"></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>pf</p></td>
<td class="parameter_description"><p>A BonoboPersistFile</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>load_fn</p></td>
<td class="parameter_description"><p>Loading routine</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>save_fn</p></td>
<td class="parameter_description"><p>Saving routine</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iid</p></td>
<td class="parameter_description"><p>OAF IID of the object this interface is aggregated to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>closure</p></td>
<td class="parameter_description"><p>Data passed to IO routines.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.7.8.4.7"></a><h4>Returns</h4>
<p> the <a class="link" href="libbonobo-bonobo-persist-file.html#BonoboPersistFile"><span class="type">BonoboPersistFile</span></a>.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-file.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BonoboPersistFile-struct"></a><h3>struct BonoboPersistFile</h3>
<pre class="programlisting">struct BonoboPersistFile;</pre>
<div class="warning"><p><code class="literal">BonoboPersistFile</code> is deprecated and should not be used in newly-written code.</p></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPersistFileClass"></a><h3>BonoboPersistFileClass</h3>
<pre class="programlisting">typedef struct {
	BonoboPersistClass parent_class;

	POA_Bonobo_PersistFile__epv epv;

	/* methods */
	int   (*load)             (BonoboPersistFile *ps,
				   const CORBA_char  *uri,
				   CORBA_Environment *ev);

	int   (*save)             (BonoboPersistFile *ps,
				   const CORBA_char  *uri,
				   CORBA_Environment *ev);

	char *(*get_current_file) (BonoboPersistFile *ps,
				   CORBA_Environment *ev);
} BonoboPersistFileClass;
</pre>
<div class="warning"><p><code class="literal">BonoboPersistFileClass</code> is deprecated and should not be used in newly-written code.</p></div>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-file.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a>, <a class="link" href="libbonobo-bonobo-persist.html#BonoboPersist"><span class="type">BonoboPersist</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.