File: //usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-persist-stream.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>BonoboPersistStream</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" 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.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="general.html" title="General">
<link rel="chapter" href="factories.html" title="Objects, Factories, Reference Counting">
<link rel="chapter" href="property-bags.html" title="Property Bags, Events, Listeners">
<link rel="chapter" href="monikers.html" title="Monikers">
<link rel="chapter" href="streams.html" title="Storages and Streams">
<link rel="chapter" href="persist.html" title="Persistency">
<link rel="chapter" href="misc.html" title="Miscellaneous">
</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"><nobr><a href="#id2784168" class="shortcut">Top</a>
 | 
<a href="#id2784463" class="shortcut">Description</a>
 | 
<a href="#id2784423" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-persist-stream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2784168"></a><span class="refentrytitle">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">
<h2>Synopsis</h2>
<a name="BonoboPersistStream"></a><pre class="synopsis">
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream-struct">BonoboPersistStream</a>;
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamClass">BonoboPersistStreamClass</a>;
void (<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">*BonoboPersistStreamIOFn</a>) (<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a> *ps,
const Bonobo_Stream stream,
Bonobo_Persist_ContentType type,
void *closure,
CORBA_Environment *ev);
Bonobo_Persist_ContentTypeList* (<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn">*BonoboPersistStreamTypesFn</a>)
(<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a> *ps,
void *closure,
CORBA_Environment *ev);
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a>* <a href="libbonobo-bonobo-persist-stream.html#bonobo-persist-stream-new">bonobo_persist_stream_new</a>
(<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> load_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> save_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn">BonoboPersistStreamTypesFn</a> types_fn,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *iid,
void *closure);
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a>* <a href="libbonobo-bonobo-persist-stream.html#bonobo-persist-stream-construct">bonobo_persist_stream_construct</a>
(<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a> *ps,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> load_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> save_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn">BonoboPersistStreamTypesFn</a> types_fn,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *iid,
void *closure);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2784423"></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 href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
+----<a href="libbonobo-bonobo-persist.html#BonoboPersist">BonoboPersist</a>
+----BonoboPersistStream
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2784463"></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="id2784499"></a><p class="title"><b>Example 4. Implementing the PersistStream callbacks</b></p>
<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 '<code class="literal">s</code>'", 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 '<code class="literal">s</code>'", 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>
<p>
Having implemented the callbacks we then have to register them
and aggregate the interface to our object:
</p>
<div class="example">
<a name="id2784550"></a><p class="title"><b>Example 5. Aggregating a new PersistStream</b></p>
<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>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2784572"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2784582"></a><h3>
<a name="BonoboPersistStream-struct"></a>BonoboPersistStream</h3>
<a class="indexterm" name="id2784596"></a><pre class="programlisting">typedef struct _BonoboPersistStream 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" lang="en">
<a name="id2784624"></a><h3>
<a name="BonoboPersistStreamClass"></a>BonoboPersistStreamClass</h3>
<a class="indexterm" name="id2784640"></a><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" lang="en">
<a name="id2784678"></a><h3>
<a name="BonoboPersistStreamIOFn"></a>BonoboPersistStreamIOFn ()</h3>
<a class="indexterm" name="id2784693"></a><pre class="programlisting">void (*BonoboPersistStreamIOFn) (<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a> *ps,
const Bonobo_Stream stream,
Bonobo_Persist_ContentType type,
void *closure,
CORBA_Environment *ev);</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 class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ps</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>stream</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>closure</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ev</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2784838"></a><h3>
<a name="BonoboPersistStreamTypesFn"></a>BonoboPersistStreamTypesFn ()</h3>
<a class="indexterm" name="id2784855"></a><pre class="programlisting">Bonobo_Persist_ContentTypeList* (*BonoboPersistStreamTypesFn)
(<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a> *ps,
void *closure,
CORBA_Environment *ev);</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 class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ps</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>closure</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ev</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2784967"></a><h3>
<a name="bonobo-persist-stream-new"></a>bonobo_persist_stream_new ()</h3>
<a class="indexterm" name="id2784984"></a><pre class="programlisting"><a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a>* bonobo_persist_stream_new
(<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> load_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> save_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn">BonoboPersistStreamTypesFn</a> types_fn,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *iid,
void *closure);</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/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>, the corresponding operation is performed by the class load
and save routines.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>load_fn</code></em> :</span></td>
<td> Loading routine
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>save_fn</code></em> :</span></td>
<td> Saving routine
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>types_fn</code></em> :</span></td>
<td> get_content_types routine
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>iid</code></em> :</span></td>
<td> OAF IID of the object this interface is aggregated to
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>closure</code></em> :</span></td>
<td> Data passed to IO routines.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the newly-created BonoboPersistStream object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2785168"></a><h3>
<a name="bonobo-persist-stream-construct"></a>bonobo_persist_stream_construct ()</h3>
<a class="indexterm" name="id2785184"></a><pre class="programlisting"><a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a>* bonobo_persist_stream_construct
(<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStream">BonoboPersistStream</a> *ps,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> load_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamIOFn">BonoboPersistStreamIOFn</a> save_fn,
<a href="libbonobo-bonobo-persist-stream.html#BonoboPersistStreamTypesFn">BonoboPersistStreamTypesFn</a> types_fn,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *iid,
void *closure);</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/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>, the
corresponding operation is performed by the class load and save
routines.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>ps</code></em> :</span></td>
<td> A BonoboPersistStream object
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>load_fn</code></em> :</span></td>
<td> Loading routine
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>save_fn</code></em> :</span></td>
<td> Saving routine
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>types_fn</code></em> :</span></td>
<td> returns the supported types
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>iid</code></em> :</span></td>
<td> OAF IID of the object this interface is aggregated to
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>closure</code></em> :</span></td>
<td> Data passed to IO routines.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The initialized BonoboPersistStream object.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>