This file is indexed.

/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-persist-stream.html is in libbonobo2-dev 2.32.1-0ubuntu1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboPersistStream</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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-file.html" title="BonoboPersistFile">
<link rel="next" href="libbonobo-bonobo-persist-client.html" title="bonobo-persist-client">
<meta name="generator" content="GTK-Doc V1.16 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libbonobo-bonobo-persist-file.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="persist.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-persist-client.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-persist-stream.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-persist-stream.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonobo-bonobo-persist-stream.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-persist-stream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-persist-stream.top_of_page"></a>BonoboPersistStream</span></h2>
<p>BonoboPersistStream — Interface for anything that can save / load itself from a Bonobo stream.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-persist-stream.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboPersistStream"></a><pre class="synopsis">struct              <a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream-struct" title="struct BonoboPersistStream">BonoboPersistStream</a>;
                    <a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamClass" title="BonoboPersistStreamClass">BonoboPersistStreamClass</a>;
<span class="returnvalue">void</span>                (<a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()">*BonoboPersistStreamIOFn</a>)          (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a> *ps</code></em>,
                                                         <em class="parameter"><code>const <span class="type">Bonobo_Stream</span> stream</code></em>,
                                                         <em class="parameter"><code><span class="type">Bonobo_Persist_ContentType</span> type</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *closure</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);
<span class="returnvalue">Bonobo_Persist_ContentTypeList</span> * (<a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn" title="BonoboPersistStreamTypesFn ()">*BonoboPersistStreamTypesFn</a>)
                                                        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a> *ps</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *closure</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);
<a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="returnvalue">BonoboPersistStream</span></a> * <a class="link" href="libbonobo-bonobo-persist-stream.html#bonobo-persist-stream-new" title="bonobo_persist_stream_new ()">bonobo_persist_stream_new</a>         (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> load_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> save_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn" title="BonoboPersistStreamTypesFn ()"><span class="type">BonoboPersistStreamTypesFn</span></a> types_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>);
<a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="returnvalue">BonoboPersistStream</span></a> * <a class="link" href="libbonobo-bonobo-persist-stream.html#bonobo-persist-stream-construct" title="bonobo_persist_stream_construct ()">bonobo_persist_stream_construct</a>   (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a> *ps</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> load_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> save_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn" title="BonoboPersistStreamTypesFn ()"><span class="type">BonoboPersistStreamTypesFn</span></a> types_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>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-stream.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
         +----<a class="link" href="libbonobo-bonobo-persist.html#BonoboPersist">BonoboPersist</a>
               +----BonoboPersistStream
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-stream.description"></a><h2>Description</h2>
<p>
The PersistStream interface is the interface to use for all new
components that are able to load and save themselves to a stream.
It should be associated with any <span class="type">BonoboEmbeddable</span> for use by the
container in creating a compound document.
</p>
<p>
This interface works by connecting callbacks to the methods, in
a somewhat 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>
<p>
  </p>
<div class="example">
<a name="id436920"></a><p class="title"><b>Example 28. Implementing the PersistStream callbacks</b></p>
<div class="example-contents"><pre class="programlisting">
static void
load_from_stream (BonoboPersistStream        *ps,
                  const Bonobo_Stream         stream,
                  Bonobo_Persist_ContentType  type,
                  void                       *closure,
                  CORBA_Environment          *ev)
{
	EogImageData *image_data = closure;
	g_warning ("Load content from stream of type '%s'", type);
}
static gint
save_to_stream (BonoboPersistStream        *ps,
                const Bonobo_Stream         stream,
                Bonobo_Persist_ContentType  type,
                void                       *closure,
                CORBA_Environment          *ev)
{
	EogImageData *image_data = closure;
	g_warning ("Save content to stream with type '%s'", type);
}
static Bonobo_Persist_ContentTypeList *
get_supported_types (BonoboPersistStream *ps,
                     void                *closure,
                     CORBA_Environment   *ev)
{
	return bonobo_persist_generate_content_types (
		2, "text/plain", "text/html");
}
    </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="id436942"></a><p class="title"><b>Example 29. Aggregating a new PersistStream</b></p>
<div class="example-contents"><pre class="programlisting">
EogImageData *
eog_image_data_construct (EogImageData *image_data)
{
	BonoboObject        *retval;
	BonoboPersistStream *ps;
	ps = bonobo_persist_stream_new (
		load_from_stream, save_to_stream,
		get_supported_types, NULL,
		image_data);
	if (ps == NULL) {
		bonobo_object_unref (BONOBO_OBJECT (image_data));
		return NULL;
	}
	bonobo_object_add_interface (BONOBO_OBJECT (image_data),
				     BONOBO_OBJECT (ps));
	return image_data;
}
    </pre></div>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-persist-stream.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboPersistStream-struct"></a><h3>struct BonoboPersistStream</h3>
<pre class="programlisting">struct BonoboPersistStream;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">BonoboPersistStream</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPersistStreamClass"></a><h3>BonoboPersistStreamClass</h3>
<pre class="programlisting">typedef struct {
	BonoboPersistClass parent_class;

	POA_Bonobo_PersistStream__epv epv;

	/* methods */
	void       (*load)         (BonoboPersistStream        *ps,
				    Bonobo_Stream              stream,
				    Bonobo_Persist_ContentType type,
				    CORBA_Environment          *ev);
	void       (*save)         (BonoboPersistStream        *ps,
				    Bonobo_Stream              stream,
				    Bonobo_Persist_ContentType type,
				    CORBA_Environment          *ev);

	Bonobo_Persist_ContentTypeList * (*get_content_types) (BonoboPersistStream *ps,
							       CORBA_Environment   *ev);
} BonoboPersistStreamClass;
</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">BonoboPersistStreamClass</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPersistStreamIOFn"></a><h3>BonoboPersistStreamIOFn ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*BonoboPersistStreamIOFn)          (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a> *ps</code></em>,
                                                         <em class="parameter"><code>const <span class="type">Bonobo_Stream</span> stream</code></em>,
                                                         <em class="parameter"><code><span class="type">Bonobo_Persist_ContentType</span> type</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *closure</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">BonoboPersistStreamIOFn</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboPersistStreamTypesFn"></a><h3>BonoboPersistStreamTypesFn ()</h3>
<pre class="programlisting"><span class="returnvalue">Bonobo_Persist_ContentTypeList</span> * (*BonoboPersistStreamTypesFn)
                                                        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a> *ps</code></em>,
                                                         <em class="parameter"><code><span class="type">void</span> *closure</code></em>,
                                                         <em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">BonoboPersistStreamTypesFn</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-persist-stream-new"></a><h3>bonobo_persist_stream_new ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="returnvalue">BonoboPersistStream</span></a> * bonobo_persist_stream_new         (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> load_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> save_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn" title="BonoboPersistStreamTypesFn ()"><span class="type">BonoboPersistStreamTypesFn</span></a> types_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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">bonobo_persist_stream_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates a new BonoboPersistStream object. The various operations
for the object are performed by the provided callback functions,
which are passed <em class="parameter"><code>closure</code></em> when they are invoked. If any callback is
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the corresponding operation is performed by the class load
and save routines.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>load_fn</code></em> :</span></p></td>
<td>Loading routine</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>save_fn</code></em> :</span></p></td>
<td>Saving routine</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>types_fn</code></em> :</span></p></td>
<td>get_content_types routine</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
<td>OAF IID of the object this interface is aggregated to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>
<td>Data passed to IO routines.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly-created BonoboPersistStream object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-persist-stream-construct"></a><h3>bonobo_persist_stream_construct ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="returnvalue">BonoboPersistStream</span></a> * bonobo_persist_stream_construct   (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream"><span class="type">BonoboPersistStream</span></a> *ps</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> load_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn" title="BonoboPersistStreamIOFn ()"><span class="type">BonoboPersistStreamIOFn</span></a> save_fn</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn" title="BonoboPersistStreamTypesFn ()"><span class="type">BonoboPersistStreamTypesFn</span></a> types_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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">bonobo_persist_stream_construct</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Initializes the BonoboPersistStream object.  The load and save
operations for the object are performed by the provided <em class="parameter"><code>load_fn</code></em>
and <em class="parameter"><code>save_fn</code></em> callback functions, which are passed <em class="parameter"><code>closure</code></em> when
they are invoked.  If either <em class="parameter"><code>load_fn</code></em> or <em class="parameter"><code>save_fn</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the
corresponding operation is performed by the class load and save
routines.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ps</code></em> :</span></p></td>
<td>A BonoboPersistStream object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>load_fn</code></em> :</span></p></td>
<td>Loading routine</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>save_fn</code></em> :</span></p></td>
<td>Saving routine</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>types_fn</code></em> :</span></p></td>
<td>returns the supported types</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iid</code></em> :</span></p></td>
<td>OAF IID of the object this interface is aggregated to</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>closure</code></em> :</span></p></td>
<td>Data passed to IO routines.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The initialized BonoboPersistStream object.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.16</div>
</body>
</html>