diff options
Diffstat (limited to 'devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-serialize.html')
| -rw-r--r-- | devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-serialize.html | 296 |
1 files changed, 296 insertions, 0 deletions
diff --git a/devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-serialize.html b/devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-serialize.html new file mode 100644 index 0000000..8c77f83 --- /dev/null +++ b/devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-serialize.html @@ -0,0 +1,296 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpConfig-serialize: GIMP Config Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Config Library Reference Manual"> +<link rel="up" href="pt01.html" title="Part I. 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.32 (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="5"><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="#libgimpconfig-GimpConfig-serialize.description" class="shortcut">Description</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="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimpconfig-GimpConfig-deserialize.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimpconfig-GimpConfigError.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimpconfig-GimpConfig-serialize"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimpconfig-GimpConfig-serialize.top_of_page"></a>GimpConfig-serialize</span></h2> +<p>GimpConfig-serialize — Serializing for libgimpconfig.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-serialize.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-serialize.html#gimp-config-serialize-properties" title="gimp_config_serialize_properties ()">gimp_config_serialize_properties</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-serialize.html#gimp-config-serialize-changed-properties" title="gimp_config_serialize_changed_properties ()">gimp_config_serialize_changed_properties</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-serialize.html#gimp-config-serialize-property" title="gimp_config_serialize_property ()">gimp_config_serialize_property</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-serialize.html#gimp-config-serialize-property-by-name" title="gimp_config_serialize_property_by_name ()">gimp_config_serialize_property_by_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-serialize.html#gimp-config-serialize-value" title="gimp_config_serialize_value ()">gimp_config_serialize_value</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-serialize.description"></a><h2>Description</h2> +<p>Serializing interface for libgimpconfig.</p> +</div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-serialize.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-config-serialize-properties"></a><h3>gimp_config_serialize_properties ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_config_serialize_properties (<em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a> *config</code></em>, + <em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a> *writer</code></em>);</pre> +<p>This function writes all object properties to the <em class="parameter"><code>writer</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-config-serialize-properties.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-serialize-properties.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-config-serialize-changed-properties"></a><h3>gimp_config_serialize_changed_properties ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_config_serialize_changed_properties + (<em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a> *config</code></em>, + <em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a> *writer</code></em>);</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> +<div class="refsect3"> +<a name="gimp-config-serialize-changed-properties.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-serialize-changed-properties.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-config-serialize-property"></a><h3>gimp_config_serialize_property ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_config_serialize_property (<em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a> *config</code></em>, + <em class="parameter"><code><span class="type">GParamSpec</span> *param_spec</code></em>, + <em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a> *writer</code></em>);</pre> +<p>This function serializes a single object property to the <em class="parameter"><code>writer</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-config-serialize-property.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>param_spec</p></td> +<td class="parameter_description"><p>a <span class="type">GParamSpec</span>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-serialize-property.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-config-serialize-property-by-name"></a><h3>gimp_config_serialize_property_by_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_config_serialize_property_by_name + (<em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a> *config</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>, + <em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a> *writer</code></em>);</pre> +<p>This function serializes a single object property to the <em class="parameter"><code>writer</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-config-serialize-property-by-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>config</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfig.html#GimpConfig" title="GimpConfig"><span class="type">GimpConfig</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>prop_name</p></td> +<td class="parameter_description"><p>the property's name.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfigWriter.html#GimpConfigWriter" title="GimpConfigWriter"><span class="type">GimpConfigWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-serialize-property-by-name.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-6.html#api-index-2.6">2.6</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-config-serialize-value"></a><h3>gimp_config_serialize_value ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_config_serialize_value (<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>, + <em class="parameter"><code><span class="type">GString</span> *str</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> escaped</code></em>);</pre> +<p>This utility function appends a string representation of <span class="type">GValue</span> to <em class="parameter"><code>str</code></em> +.</p> +<div class="refsect3"> +<a name="gimp-config-serialize-value.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>value</p></td> +<td class="parameter_description"><p>a <span class="type">GValue</span>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>str</p></td> +<td class="parameter_description"><p>a <span class="type">GString</span>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>escaped</p></td> +<td class="parameter_description"><p>whether to escape string values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-serialize-value.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if serialization succeeded, <code class="literal">FALSE</code> otherwise.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |