← 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-path.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-path.xml
12
12
<refnamediv>
13
13
<refname>gimpconfig-path</refname>
14
14
<refpurpose></refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimpconfig-gimpconfig-path.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
enum                <link linkend="GimpConfigPathType">GimpConfigPathType</link>;
23
 
<link linkend="GParamSpec">GParamSpec</link>*         <link linkend="gimp-param-spec-config-path">gimp_param_spec_config_path</link>         (const <link linkend="gchar">gchar</link> *name,
 
22
<link linkend="GParamSpec">GParamSpec</link> *        <link linkend="gimp-param-spec-config-path">gimp_param_spec_config_path</link>         (const <link linkend="gchar">gchar</link> *name,
24
23
                                                         const <link linkend="gchar">gchar</link> *nick,
25
24
                                                         const <link linkend="gchar">gchar</link> *blurb,
26
25
                                                         <link linkend="GimpConfigPathType">GimpConfigPathType</link> type,
27
26
                                                         const <link linkend="gchar">gchar</link> *default_value,
28
27
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);
29
28
<link linkend="GimpConfigPathType">GimpConfigPathType</link>  <link linkend="gimp-param-spec-config-path-type">gimp_param_spec_config_path_type</link>    (<link linkend="GParamSpec">GParamSpec</link> *pspec);
30
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-config-path-expand">gimp_config_path_expand</link>             (const <link linkend="gchar">gchar</link> *path,
 
29
<link linkend="gchar">gchar</link> *             <link linkend="gimp-config-path-expand">gimp_config_path_expand</link>             (const <link linkend="gchar">gchar</link> *path,
31
30
                                                         <link linkend="gboolean">gboolean</link> recode,
32
31
                                                         <link linkend="GError">GError</link> **error);
33
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-config-build-data-path">gimp_config_build_data_path</link>         (const <link linkend="gchar">gchar</link> *name);
34
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-config-build-writable-path">gimp_config_build_writable_path</link>     (const <link linkend="gchar">gchar</link> *name);
35
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-config-build-plug-in-path">gimp_config_build_plug_in_path</link>      (const <link linkend="gchar">gchar</link> *name);
36
 
#define             <link linkend="GIMP-VALUE-HOLDS-CONFIG-PATH:CAPS">GIMP_VALUE_HOLDS_CONFIG_PATH</link>        (value)
 
32
<link linkend="gchar">gchar</link> *             <link linkend="gimp-config-build-data-path">gimp_config_build_data_path</link>         (const <link linkend="gchar">gchar</link> *name);
 
33
<link linkend="gchar">gchar</link> *             <link linkend="gimp-config-build-writable-path">gimp_config_build_writable_path</link>     (const <link linkend="gchar">gchar</link> *name);
 
34
<link linkend="gchar">gchar</link> *             <link linkend="gimp-config-build-plug-in-path">gimp_config_build_plug_in_path</link>      (const <link linkend="gchar">gchar</link> *name);
 
35
#define             <link linkend="GIMP-VALUE-HOLDS-CONFIG-PATH--CAPS">GIMP_VALUE_HOLDS_CONFIG_PATH</link>        (value)
37
36
</synopsis>
38
37
</refsynopsisdiv>
39
38
 
48
47
<refsect1 id="libgimpconfig-gimpconfig-path.description" role="desc">
49
48
<title role="desc.title">Description</title>
50
49
<para>
51
 
 
52
50
</para>
53
51
</refsect1>
54
52
 
56
54
<title role="details.title">Details</title>
57
55
<refsect2 id="GimpConfigPathType" role="enum">
58
56
<title>enum GimpConfigPathType</title>
59
 
<indexterm zone="GimpConfigPathType"><primary>GimpConfigPathType</primary></indexterm><programlisting>typedef enum
 
57
<indexterm zone="GimpConfigPathType"><primary sortas="GimpConfigPathType">GimpConfigPathType</primary></indexterm><programlisting>typedef enum
60
58
{
61
59
  GIMP_CONFIG_PATH_FILE,
62
60
  GIMP_CONFIG_PATH_FILE_LIST,
65
63
} GimpConfigPathType;
66
64
</programlisting>
67
65
<para>
68
 
 
69
66
</para></refsect2>
70
67
<refsect2 id="gimp-param-spec-config-path" role="function" condition="since:GIMP 2.4">
71
68
<title>gimp_param_spec_config_path ()</title>
72
 
<indexterm zone="gimp-param-spec-config-path" role="GIMP 2.4"><primary>gimp_param_spec_config_path</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link>*         gimp_param_spec_config_path         (const <link linkend="gchar">gchar</link> *name,
 
69
<indexterm zone="gimp-param-spec-config-path" role="GIMP 2.4"><primary sortas="gimp_param_spec_config_path">gimp_param_spec_config_path</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link> *        gimp_param_spec_config_path         (const <link linkend="gchar">gchar</link> *name,
73
70
                                                         const <link linkend="gchar">gchar</link> *nick,
74
71
                                                         const <link linkend="gchar">gchar</link> *blurb,
75
72
                                                         <link linkend="GimpConfigPathType">GimpConfigPathType</link> type,
80
77
or list of file or dir names.
81
78
See <link linkend="g-param-spec-internal"><function>g_param_spec_internal()</function></link> for more information.</para>
82
79
<para>
83
 
 
84
80
</para><variablelist role="params">
85
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
81
<varlistentry><term><parameter>name</parameter>&#160;:</term>
86
82
<listitem><simpara>          Canonical name of the param
87
83
</simpara></listitem></varlistentry>
88
 
<varlistentry><term><parameter>nick</parameter>&nbsp;:</term>
 
84
<varlistentry><term><parameter>nick</parameter>&#160;:</term>
89
85
<listitem><simpara>          Nickname of the param
90
86
</simpara></listitem></varlistentry>
91
 
<varlistentry><term><parameter>blurb</parameter>&nbsp;:</term>
 
87
<varlistentry><term><parameter>blurb</parameter>&#160;:</term>
92
88
<listitem><simpara>         Brief desciption of param.
93
89
</simpara></listitem></varlistentry>
94
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
90
<varlistentry><term><parameter>type</parameter>&#160;:</term>
95
91
<listitem><simpara>          a <link linkend="GimpParamConfigPathType"><type>GimpParamConfigPathType</type></link> value.
96
92
</simpara></listitem></varlistentry>
97
 
<varlistentry><term><parameter>default_value</parameter>&nbsp;:</term>
 
93
<varlistentry><term><parameter>default_value</parameter>&#160;:</term>
98
94
<listitem><simpara> Value to use if none is assigned.
99
95
</simpara></listitem></varlistentry>
100
 
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
96
<varlistentry><term><parameter>flags</parameter>&#160;:</term>
101
97
<listitem><simpara>         a combination of <link linkend="GParamFlags"><type>GParamFlags</type></link>
102
98
</simpara></listitem></varlistentry>
103
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
 
99
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
104
100
 
105
101
</simpara></listitem></varlistentry>
106
 
</variablelist><para role="since">Since  GIMP 2.4
107
 
</para></refsect2>
 
102
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
108
103
<refsect2 id="gimp-param-spec-config-path-type" role="function" condition="since:GIMP 2.4">
109
104
<title>gimp_param_spec_config_path_type ()</title>
110
 
<indexterm zone="gimp-param-spec-config-path-type" role="GIMP 2.4"><primary>gimp_param_spec_config_path_type</primary></indexterm><programlisting><link linkend="GimpConfigPathType">GimpConfigPathType</link>  gimp_param_spec_config_path_type    (<link linkend="GParamSpec">GParamSpec</link> *pspec);</programlisting>
 
105
<indexterm zone="gimp-param-spec-config-path-type" role="GIMP 2.4"><primary sortas="gimp_param_spec_config_path_type">gimp_param_spec_config_path_type</primary></indexterm><programlisting><link linkend="GimpConfigPathType">GimpConfigPathType</link>  gimp_param_spec_config_path_type    (<link linkend="GParamSpec">GParamSpec</link> *pspec);</programlisting>
111
106
<para>
112
107
Tells whether the path param encodes a filename,
113
108
dir name, or list of file or dir names.</para>
114
109
<para>
115
 
 
116
110
</para><variablelist role="params">
117
 
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
 
111
<varlistentry><term><parameter>pspec</parameter>&#160;:</term>
118
112
<listitem><simpara>         A <link linkend="GParamSpec"><type>GParamSpec</type></link> for a path param
119
113
</simpara></listitem></varlistentry>
120
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GimpConfigPathType"><type>GimpConfigPathType</type></link> value
 
114
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GimpConfigPathType"><type>GimpConfigPathType</type></link> value
121
115
 
122
116
</simpara></listitem></varlistentry>
123
 
</variablelist><para role="since">Since  GIMP 2.4
124
 
</para></refsect2>
 
117
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
125
118
<refsect2 id="gimp-config-path-expand" role="function" condition="since:GIMP 2.4">
126
119
<title>gimp_config_path_expand ()</title>
127
 
<indexterm zone="gimp-config-path-expand" role="GIMP 2.4"><primary>gimp_config_path_expand</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_config_path_expand             (const <link linkend="gchar">gchar</link> *path,
 
120
<indexterm zone="gimp-config-path-expand" role="GIMP 2.4"><primary sortas="gimp_config_path_expand">gimp_config_path_expand</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gimp_config_path_expand             (const <link linkend="gchar">gchar</link> *path,
128
121
                                                         <link linkend="gboolean">gboolean</link> recode,
129
122
                                                         <link linkend="GError">GError</link> **error);</programlisting>
130
123
<para>
136
129
substitution for you and can also attempt to convert to the
137
130
filesystem encoding.</para>
138
131
<para>
139
 
 
140
132
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
142
 
<listitem><simpara> a <link linkend="NUL:CAPS"><literal>NUL</literal></link>-terminated string in UTF-8 encoding
 
133
<varlistentry><term><parameter>path</parameter>&#160;:</term>
 
134
<listitem><simpara> a <link linkend="NUL--CAPS"><literal>NUL</literal></link>-terminated string in UTF-8 encoding
143
135
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>recode</parameter>&nbsp;:</term>
 
136
<varlistentry><term><parameter>recode</parameter>&#160;:</term>
145
137
<listitem><simpara> whether to convert to the filesystem's encoding
146
138
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
139
<varlistentry><term><parameter>error</parameter>&#160;:</term>
148
140
<listitem><simpara> return location for errors
149
141
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="NUL:CAPS"><literal>NUL</literal></link>-terminated string
 
142
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated <link linkend="NUL--CAPS"><literal>NUL</literal></link>-terminated string
151
143
 
152
144
</simpara></listitem></varlistentry>
153
 
</variablelist><para role="since">Since  GIMP 2.4
154
 
</para></refsect2>
 
145
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
155
146
<refsect2 id="gimp-config-build-data-path" role="function" condition="since:GIMP 2.4">
156
147
<title>gimp_config_build_data_path ()</title>
157
 
<indexterm zone="gimp-config-build-data-path" role="GIMP 2.4"><primary>gimp_config_build_data_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_config_build_data_path         (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
148
<indexterm zone="gimp-config-build-data-path" role="GIMP 2.4"><primary sortas="gimp_config_build_data_path">gimp_config_build_data_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gimp_config_build_data_path         (const <link linkend="gchar">gchar</link> *name);</programlisting>
158
149
<para>
159
150
Creates a search path as it is used in the gimprc file.  The path
160
151
returned by <link linkend="gimp-config-build-data-path"><function>gimp_config_build_data_path()</function></link> includes a directory
166
157
As it is in the gimprc notation, you first need to expand and
167
158
recode it using <link linkend="gimp-config-path-expand"><function>gimp_config_path_expand()</function></link>.</para>
168
159
<para>
169
 
 
170
160
</para><variablelist role="params">
171
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
161
<varlistentry><term><parameter>name</parameter>&#160;:</term>
172
162
<listitem><simpara> directory name (in UTF-8 encoding)
173
163
</simpara></listitem></varlistentry>
174
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string
 
164
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated string
175
165
 
176
166
</simpara></listitem></varlistentry>
177
 
</variablelist><para role="since">Since  GIMP 2.4
178
 
</para></refsect2>
 
167
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
179
168
<refsect2 id="gimp-config-build-writable-path" role="function" condition="since:GIMP 2.4">
180
169
<title>gimp_config_build_writable_path ()</title>
181
 
<indexterm zone="gimp-config-build-writable-path" role="GIMP 2.4"><primary>gimp_config_build_writable_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_config_build_writable_path     (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
170
<indexterm zone="gimp-config-build-writable-path" role="GIMP 2.4"><primary sortas="gimp_config_build_writable_path">gimp_config_build_writable_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gimp_config_build_writable_path     (const <link linkend="gchar">gchar</link> *name);</programlisting>
182
171
<para>
183
172
Creates a search path as it is used in the gimprc file.  The path
184
173
returned by <link linkend="gimp-config-build-writable-path"><function>gimp_config_build_writable_path()</function></link> is just the writable
189
178
As it is in the gimprc notation, you first need to expand and
190
179
recode it using <link linkend="gimp-config-path-expand"><function>gimp_config_path_expand()</function></link>.</para>
191
180
<para>
192
 
 
193
181
</para><variablelist role="params">
194
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
182
<varlistentry><term><parameter>name</parameter>&#160;:</term>
195
183
<listitem><simpara> directory name (in UTF-8 encoding)
196
184
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string
 
185
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated string
198
186
 
199
187
</simpara></listitem></varlistentry>
200
 
</variablelist><para role="since">Since  GIMP 2.4
201
 
</para></refsect2>
 
188
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
202
189
<refsect2 id="gimp-config-build-plug-in-path" role="function" condition="since:GIMP 2.4">
203
190
<title>gimp_config_build_plug_in_path ()</title>
204
 
<indexterm zone="gimp-config-build-plug-in-path" role="GIMP 2.4"><primary>gimp_config_build_plug_in_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_config_build_plug_in_path      (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
191
<indexterm zone="gimp-config-build-plug-in-path" role="GIMP 2.4"><primary sortas="gimp_config_build_plug_in_path">gimp_config_build_plug_in_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             gimp_config_build_plug_in_path      (const <link linkend="gchar">gchar</link> *name);</programlisting>
205
192
<para>
206
193
Creates a search path as it is used in the gimprc file.  The path
207
194
returned by <link linkend="gimp-config-build-plug-in-path"><function>gimp_config_build_plug_in_path()</function></link> includes a directory
213
200
As it is in the gimprc notation, you first need to expand and
214
201
recode it using <link linkend="gimp-config-path-expand"><function>gimp_config_path_expand()</function></link>.</para>
215
202
<para>
216
 
 
217
203
</para><variablelist role="params">
218
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
204
<varlistentry><term><parameter>name</parameter>&#160;:</term>
219
205
<listitem><simpara> directory name (in UTF-8 encoding)
220
206
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string
 
207
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly allocated string
222
208
 
223
209
</simpara></listitem></varlistentry>
224
 
</variablelist><para role="since">Since  GIMP 2.4
225
 
</para></refsect2>
226
 
<refsect2 id="GIMP-VALUE-HOLDS-CONFIG-PATH:CAPS" role="macro">
 
210
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
 
211
<refsect2 id="GIMP-VALUE-HOLDS-CONFIG-PATH--CAPS" role="macro">
227
212
<title>GIMP_VALUE_HOLDS_CONFIG_PATH()</title>
228
 
<indexterm zone="GIMP-VALUE-HOLDS-CONFIG-PATH:CAPS"><primary>GIMP_VALUE_HOLDS_CONFIG_PATH</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_CONFIG_PATH(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_CONFIG_PATH))
 
213
<indexterm zone="GIMP-VALUE-HOLDS-CONFIG-PATH--CAPS"><primary sortas="GIMP_VALUE_HOLDS_CONFIG_PATH">GIMP_VALUE_HOLDS_CONFIG_PATH</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_CONFIG_PATH(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_CONFIG_PATH))
229
214
</programlisting>
230
215
<para>
231
 
 
232
216
</para><variablelist role="params">
233
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
217
<varlistentry><term><parameter>value</parameter>&#160;:</term>
234
218
<listitem><simpara>
235
 
 
236
 
 
237
219
</simpara></listitem></varlistentry>
238
220
</variablelist></refsect2>
239
221