← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpconfig/xml/gimpconfig-utils.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpconfig/xml/gimpconfig-utils.xml
12
12
<refnamediv>
13
13
<refname>gimpconfig-utils</refname>
14
14
<refpurpose>Miscellaneous utility functions for libgimpconfig.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimpconfig-gimpconfig-utils.synopsis" role="synopsis">
19
18
<title role="synopsis.title">Synopsis</title>
20
19
 
21
20
<synopsis>
22
 
<link linkend="GList">GList</link>*              <link linkend="gimp-config-diff">gimp_config_diff</link>                    (<link linkend="GObject">GObject</link> *a,
 
21
<link linkend="GList">GList</link> *             <link linkend="gimp-config-diff">gimp_config_diff</link>                    (<link linkend="GObject">GObject</link> *a,
23
22
                                                         <link linkend="GObject">GObject</link> *b,
24
23
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);
25
24
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-config-sync">gimp_config_sync</link>                    (<link linkend="GObject">GObject</link> *src,
45
44
<title role="desc.title">Description</title>
46
45
<para>
47
46
Miscellaneous utility functions for libgimpconfig.
48
 
 
49
47
</para>
50
48
</refsect1>
51
49
 
53
51
<title role="details.title">Details</title>
54
52
<refsect2 id="gimp-config-diff" role="function" condition="since:GIMP 2.4">
55
53
<title>gimp_config_diff ()</title>
56
 
<indexterm zone="gimp-config-diff" role="GIMP 2.4"><primary>gimp_config_diff</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gimp_config_diff                    (<link linkend="GObject">GObject</link> *a,
 
54
<indexterm zone="gimp-config-diff" role="GIMP 2.4"><primary sortas="gimp_config_diff">gimp_config_diff</primary></indexterm><programlisting><link linkend="GList">GList</link> *             gimp_config_diff                    (<link linkend="GObject">GObject</link> *a,
57
55
                                                         <link linkend="GObject">GObject</link> *b,
58
56
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);</programlisting>
59
57
<para>
65
63
exist in both object classes and are of the same value_type are
66
64
compared.</para>
67
65
<para>
68
 
 
69
66
</para><variablelist role="params">
70
 
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
67
<varlistentry><term><parameter>a</parameter>&#160;:</term>
71
68
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link>
72
69
</simpara></listitem></varlistentry>
73
 
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
 
70
<varlistentry><term><parameter>b</parameter>&#160;:</term>
74
71
<listitem><simpara> another <link linkend="GObject"><type>GObject</type></link> object
75
72
</simpara></listitem></varlistentry>
76
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
73
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
77
74
<listitem><simpara> a mask of GParamFlags
78
75
</simpara></listitem></varlistentry>
79
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a GList of differing GParamSpecs.
 
76
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a GList of differing GParamSpecs.
80
77
 
81
78
</simpara></listitem></varlistentry>
82
 
</variablelist><para role="since">Since  GIMP 2.4
83
 
</para></refsect2>
 
79
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
84
80
<refsect2 id="gimp-config-sync" role="function" condition="since:GIMP 2.4">
85
81
<title>gimp_config_sync ()</title>
86
 
<indexterm zone="gimp-config-sync" role="GIMP 2.4"><primary>gimp_config_sync</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_sync                    (<link linkend="GObject">GObject</link> *src,
 
82
<indexterm zone="gimp-config-sync" role="GIMP 2.4"><primary sortas="gimp_config_sync">gimp_config_sync</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_config_sync                    (<link linkend="GObject">GObject</link> *src,
87
83
                                                         <link linkend="GObject">GObject</link> *dest,
88
84
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);</programlisting>
89
85
<para>
99
95
exist in both object classes and are of the same value_type are
100
96
synchronized</para>
101
97
<para>
102
 
 
103
98
</para><variablelist role="params">
104
 
<varlistentry><term><parameter>src</parameter>&nbsp;:</term>
 
99
<varlistentry><term><parameter>src</parameter>&#160;:</term>
105
100
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link>
106
101
</simpara></listitem></varlistentry>
107
 
<varlistentry><term><parameter>dest</parameter>&nbsp;:</term>
 
102
<varlistentry><term><parameter>dest</parameter>&#160;:</term>
108
103
<listitem><simpara> another <link linkend="GObject"><type>GObject</type></link>
109
104
</simpara></listitem></varlistentry>
110
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
105
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
111
106
<listitem><simpara> a mask of GParamFlags
112
107
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>dest</parameter> was modified, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
 
108
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>dest</parameter> was modified, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> otherwise
114
109
 
115
110
</simpara></listitem></varlistentry>
116
 
</variablelist><para role="since">Since  GIMP 2.4
117
 
</para></refsect2>
 
111
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
118
112
<refsect2 id="gimp-config-reset-properties" role="function" condition="since:GIMP 2.4">
119
113
<title>gimp_config_reset_properties ()</title>
120
 
<indexterm zone="gimp-config-reset-properties" role="GIMP 2.4"><primary>gimp_config_reset_properties</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_config_reset_properties        (<link linkend="GObject">GObject</link> *object);</programlisting>
 
114
<indexterm zone="gimp-config-reset-properties" role="GIMP 2.4"><primary sortas="gimp_config_reset_properties">gimp_config_reset_properties</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_config_reset_properties        (<link linkend="GObject">GObject</link> *object);</programlisting>
121
115
<para>
122
116
Resets all writable properties of <parameter>object</parameter> to the default values as
123
117
defined in their <link linkend="GParamSpec"><type>GParamSpec</type></link>. Properties marked as "construct-only"
126
120
<para>
127
121
If you want to reset a <link linkend="GimpConfig"><type>GimpConfig</type></link> object, please use <link linkend="gimp-config-reset"><function>gimp_config_reset()</function></link>.</para>
128
122
<para>
129
 
 
130
123
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
 
124
<varlistentry><term><parameter>object</parameter>&#160;:</term>
132
125
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link>
133
126
</simpara></listitem></varlistentry>
134
 
</variablelist><para role="since">Since  GIMP 2.4
135
 
</para></refsect2>
 
127
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
136
128
<refsect2 id="gimp-config-reset-property" role="function" condition="since:GIMP 2.4">
137
129
<title>gimp_config_reset_property ()</title>
138
 
<indexterm zone="gimp-config-reset-property" role="GIMP 2.4"><primary>gimp_config_reset_property</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_config_reset_property          (<link linkend="GObject">GObject</link> *object,
 
130
<indexterm zone="gimp-config-reset-property" role="GIMP 2.4"><primary sortas="gimp_config_reset_property">gimp_config_reset_property</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_config_reset_property          (<link linkend="GObject">GObject</link> *object,
139
131
                                                         const <link linkend="gchar">gchar</link> *property_name);</programlisting>
140
132
<para>
141
133
Resets the property named <parameter>property_name</parameter> to its default value.  The
142
134
property must be writable and must not be marked as "construct-only".</para>
143
135
<para>
144
 
 
145
136
</para><variablelist role="params">
146
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
 
137
<varlistentry><term><parameter>object</parameter>&#160;:</term>
147
138
<listitem><simpara> a <link linkend="GObject"><type>GObject</type></link>
148
139
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>property_name</parameter>&nbsp;:</term>
 
140
<varlistentry><term><parameter>property_name</parameter>&#160;:</term>
150
141
<listitem><simpara> name of the property to reset
151
142
</simpara></listitem></varlistentry>
152
 
</variablelist><para role="since">Since  GIMP 2.4
153
 
</para></refsect2>
 
143
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
154
144
<refsect2 id="gimp-config-string-append-escaped" role="function" condition="since:GIMP 2.4">
155
145
<title>gimp_config_string_append_escaped ()</title>
156
 
<indexterm zone="gimp-config-string-append-escaped" role="GIMP 2.4"><primary>gimp_config_string_append_escaped</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_config_string_append_escaped   (<link linkend="GString">GString</link> *string,
 
146
<indexterm zone="gimp-config-string-append-escaped" role="GIMP 2.4"><primary sortas="gimp_config_string_append_escaped">gimp_config_string_append_escaped</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_config_string_append_escaped   (<link linkend="GString">GString</link> *string,
157
147
                                                         const <link linkend="gchar">gchar</link> *val);</programlisting>
158
148
<para>
159
149
Escapes and quotes <parameter>val</parameter> and appends it to <parameter>string</parameter>. The escape
161
151
leaves non-ASCII characters intact and thus preserves UTF-8
162
152
strings. Only control characters and quotes are being escaped.</para>
163
153
<para>
164
 
 
165
154
</para><variablelist role="params">
166
 
<varlistentry><term><parameter>string</parameter>&nbsp;:</term>
 
155
<varlistentry><term><parameter>string</parameter>&#160;:</term>
167
156
<listitem><simpara> pointer to a <link linkend="GString"><type>GString</type></link>
168
157
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
170
 
<listitem><simpara> a string to append or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
158
<varlistentry><term><parameter>val</parameter>&#160;:</term>
 
159
<listitem><simpara> a string to append or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
171
160
</simpara></listitem></varlistentry>
172
 
</variablelist><para role="since">Since  GIMP 2.4
173
 
</para></refsect2>
 
161
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
174
162
 
175
163
</refsect1>
176
164