Files
gimp/devel-docs/libgimpconfig/html/libgimpconfig-gimpconfig-serialize.html
2010-08-11 01:20:31 -04:00

227 lines
9.6 KiB
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>gimpconfig-serialize</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<link rel="start" href="index.html" title="GIMP Config Library Reference Manual">
<link rel="up" href="libgimpconfig.html" title="Part&#160;I.&#160;GIMP Config Library">
<link rel="prev" href="libgimpconfig-gimpconfig-deserialize.html" title="gimpconfig-deserialize">
<link rel="next" href="libgimpconfig-GimpConfigError.html" title="gimpconfig-error">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpconfig.html" title="Part&#160;I.&#160;GIMP Config Library">
<link rel="chapter" href="libgimpconfig-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimpconfig-index.html" title="Index">
<link rel="index" href="libgimpconfig-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpconfig-index-deprecated.html" title="Index of deprecated symbols">
</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="libgimpconfig-gimpconfig-deserialize.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpconfig.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">GIMP Config Library Reference Manual</th>
<td><a accesskey="n" href="libgimpconfig-GimpConfigError.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="#id2548652" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2548287" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpconfig-gimpconfig-serialize"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2548652"></a><span class="refentrytitle">gimpconfig-serialize</span>
</h2>
<p>gimpconfig-serialize &#8212; Serializing for libgimpconfig.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gboolean <a href="libgimpconfig-gimpconfig-serialize.html#gimp-config-serialize-properties">gimp_config_serialize_properties</a>
(<a href="libgimpconfig-GimpConfig.html#GimpConfig">GimpConfig</a> *config,
<a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter">GimpConfigWriter</a> *writer);
gboolean <a href="libgimpconfig-gimpconfig-serialize.html#gimp-config-serialize-changed-properties">gimp_config_serialize_changed_properties</a>
(<a href="libgimpconfig-GimpConfig.html#GimpConfig">GimpConfig</a> *config,
<a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter">GimpConfigWriter</a> *writer);
gboolean <a href="libgimpconfig-gimpconfig-serialize.html#gimp-config-serialize-property">gimp_config_serialize_property</a> (<a href="libgimpconfig-GimpConfig.html#GimpConfig">GimpConfig</a> *config,
GParamSpec *param_spec,
<a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter">GimpConfigWriter</a> *writer);
gboolean <a href="libgimpconfig-gimpconfig-serialize.html#gimp-config-serialize-value">gimp_config_serialize_value</a> (const GValue *value,
GString *str,
gboolean escaped);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2548287"></a><h2>Description</h2>
<p>
Serializing interface for libgimpconfig.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2548302"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2553158"></a><h3>
<a name="gimp-config-serialize-properties"></a>gimp_config_serialize_properties ()</h3>
<a class="indexterm" name="id2553172"></a><pre class="programlisting">gboolean gimp_config_serialize_properties
(<a href="libgimpconfig-GimpConfig.html#GimpConfig">GimpConfig</a> *config,
<a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter">GimpConfigWriter</a> *writer);</pre>
<p>
This function serializes a single object property to the <em class="parameter"><code>writer</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>config</code></em>&#160;:</span></td>
<td> a <a href="libgimpconfig-GimpConfig.html#GimpConfig"><span class="type">GimpConfig</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>writer</code></em>&#160;:</span></td>
<td> a <a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583577"></a><h3>
<a name="gimp-config-serialize-changed-properties"></a>gimp_config_serialize_changed_properties ()</h3>
<a class="indexterm" name="id2583590"></a><pre class="programlisting">gboolean gimp_config_serialize_changed_properties
(<a href="libgimpconfig-GimpConfig.html#GimpConfig">GimpConfig</a> *config,
<a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter">GimpConfigWriter</a> *writer);</pre>
<p>
This function writes all object properties that have been changed from
their default values to the <em class="parameter"><code>writer</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>config</code></em>&#160;:</span></td>
<td> a <a href="libgimpconfig-GimpConfig.html#GimpConfig"><span class="type">GimpConfig</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>writer</code></em>&#160;:</span></td>
<td> a <a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583719"></a><h3>
<a name="gimp-config-serialize-property"></a>gimp_config_serialize_property ()</h3>
<a class="indexterm" name="id2567990"></a><pre class="programlisting">gboolean gimp_config_serialize_property (<a href="libgimpconfig-GimpConfig.html#GimpConfig">GimpConfig</a> *config,
GParamSpec *param_spec,
<a href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter">GimpConfigWriter</a> *writer);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>config</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>param_spec</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>writer</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568088"></a><h3>
<a name="gimp-config-serialize-value"></a>gimp_config_serialize_value ()</h3>
<a class="indexterm" name="id2568103"></a><pre class="programlisting">gboolean gimp_config_serialize_value (const GValue *value,
GString *str,
gboolean escaped);</pre>
<p>
This utility function appends a string representation of <span class="type">GValue</span> to <em class="parameter"><code>str</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> a <span class="type">GValue</span>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td> a <span class="type">Gstring</span>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>escaped</code></em>&#160;:</span></td>
<td> whether to escape string values.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>