152 lines
8.1 KiB
XML
152 lines
8.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="libgimpconfig-gimpconfig-serialize">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">gimpconfig-serialize</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMPCONFIG Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpconfig-serialize</refname>
|
|
<refpurpose>Serializing for libgimpconfig.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-serialize-properties">gimp_config_serialize_properties</link> (<link linkend="GimpConfig">GimpConfig</link> *config,
|
|
<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-serialize-changed-properties">gimp_config_serialize_changed_properties</link>
|
|
(<link linkend="GimpConfig">GimpConfig</link> *config,
|
|
<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-serialize-property">gimp_config_serialize_property</link> (<link linkend="GimpConfig">GimpConfig</link> *config,
|
|
<link linkend="GParamSpec">GParamSpec</link> *param_spec,
|
|
<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-config-serialize-value">gimp_config_serialize_value</link> (const <link linkend="GValue">GValue</link> *value,
|
|
<link linkend="GString">GString</link> *str,
|
|
<link linkend="gboolean">gboolean</link> escaped);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
Serializing interface for libgimpconfig.
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="gimp-config-serialize-properties" role="function" condition="since:GIMP 2.4"/>gimp_config_serialize_properties ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_config_serialize_properties</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_serialize_properties (<link linkend="GimpConfig">GimpConfig</link> *config,
|
|
<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);</programlisting>
|
|
<para>
|
|
This function serializes a single object property to the <parameter>writer</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>config</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpConfig"><type>GimpConfig</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>writer</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-config-serialize-changed-properties" role="function" condition="since:GIMP 2.4"/>gimp_config_serialize_changed_properties ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_config_serialize_changed_properties</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_serialize_changed_properties
|
|
(<link linkend="GimpConfig">GimpConfig</link> *config,
|
|
<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);</programlisting>
|
|
<para>
|
|
This function writes all object properties that have been changed from
|
|
their default values to the <parameter>writer</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>config</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpConfig"><type>GimpConfig</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>writer</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpConfigWriter"><type>GimpConfigWriter</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-config-serialize-property" role="function"/>gimp_config_serialize_property ()</title>
|
|
<indexterm><primary>gimp_config_serialize_property</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_serialize_property (<link linkend="GimpConfig">GimpConfig</link> *config,
|
|
<link linkend="GParamSpec">GParamSpec</link> *param_spec,
|
|
<link linkend="GimpConfigWriter">GimpConfigWriter</link> *writer);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>config</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>param_spec</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>writer</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-config-serialize-value" role="function" condition="since:GIMP 2.4"/>gimp_config_serialize_value ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_config_serialize_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_config_serialize_value (const <link linkend="GValue">GValue</link> *value,
|
|
<link linkend="GString">GString</link> *str,
|
|
<link linkend="gboolean">gboolean</link> escaped);</programlisting>
|
|
<para>
|
|
This utility function appends a string representation of <link linkend="GValue"><type>GValue</type></link> to <parameter>str</parameter>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>value</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GValue"><type>GValue</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>str</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="Gstring"><type>Gstring</type></link>.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>escaped</parameter> :</term>
|
|
<listitem><simpara> whether to escape string values.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if serialization succeeded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|