diff options
Diffstat (limited to '')
| -rw-r--r-- | devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-path.html | 627 |
1 files changed, 627 insertions, 0 deletions
diff --git a/devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-path.html b/devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-path.html new file mode 100644 index 0000000..5cd8e50 --- /dev/null +++ b/devel-docs/libgimpconfig/html/libgimpconfig-GimpConfig-path.html @@ -0,0 +1,627 @@ +<!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-path: 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-params.html" title="GimpConfig-params"> +<link rel="next" href="libgimpconfig-GimpConfig-utils.html" title="GimpConfig-utils"> +<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-path.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-params.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimpconfig-GimpConfig-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimpconfig-GimpConfig-path"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimpconfig-GimpConfig-path.top_of_page"></a>GimpConfig-path</span></h2> +<p>GimpConfig-path — File path utilities for libgimpconfig.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-path.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">GParamSpec</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-param-spec-config-path" title="gimp_param_spec_config_path ()">gimp_param_spec_config_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType"><span class="returnvalue">GimpConfigPathType</span></a> +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-param-spec-config-path-type" title="gimp_param_spec_config_path_type ()">gimp_param_spec_config_path_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()">gimp_config_path_expand</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GList</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand-to-files" title="gimp_config_path_expand_to_files ()">gimp_config_path_expand_to_files</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-unexpand" title="gimp_config_path_unexpand ()">gimp_config_path_unexpand</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">GFile</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-file-new-for-config-path" title="gimp_file_new_for_config_path ()">gimp_file_new_for_config_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-file-get-config-path" title="gimp_file_get_config_path ()">gimp_file_get_config_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-build-data-path" title="gimp_config_build_data_path ()">gimp_config_build_data_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-build-writable-path" title="gimp_config_build_writable_path ()">gimp_config_build_writable_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-build-plug-in-path" title="gimp_config_build_plug_in_path ()">gimp_config_build_plug_in_path</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="libgimpconfig-GimpConfig-path.html#GIMP-VALUE-HOLDS-CONFIG-PATH:CAPS" title="GIMP_VALUE_HOLDS_CONFIG_PATH()">GIMP_VALUE_HOLDS_CONFIG_PATH</a><span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-path.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="libgimpconfig-GimpConfig-path.html#GimpConfigPath" title="GimpConfigPath">GimpConfigPath</a></td> +</tr> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="libgimpconfig-GimpConfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType">GimpConfigPathType</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-path.description"></a><h2>Description</h2> +<p>File path utilities for libgimpconfig.</p> +</div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-path.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-param-spec-config-path"></a><h3>gimp_param_spec_config_path ()</h3> +<pre class="programlisting"><span class="returnvalue">GParamSpec</span> * +gimp_param_spec_config_path (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *nick</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *blurb</code></em>, + <em class="parameter"><code><a class="link" href="libgimpconfig-GimpConfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType"><span class="type">GimpConfigPathType</span></a> type</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *default_value</code></em>, + <em class="parameter"><code><span class="type">GParamFlags</span> flags</code></em>);</pre> +<p>Creates a param spec to hold a filename, dir name, +or list of file or dir names. +See <code class="function">g_param_spec_internal()</code> for more information.</p> +<div class="refsect3"> +<a name="gimp-param-spec-config-path.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>name</p></td> +<td class="parameter_description"><p>Canonical name of the param</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>nick</p></td> +<td class="parameter_description"><p>Nickname of the param</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>blurb</p></td> +<td class="parameter_description"><p>Brief description of param.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>a <a class="link" href="libgimpconfig-GimpConfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType"><span class="type">GimpConfigPathType</span></a> value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>default_value</p></td> +<td class="parameter_description"><p>Value to use if none is assigned.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>a combination of <span class="type">GParamFlags</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-param-spec-config-path.returns"></a><h4>Returns</h4> +<p> a newly allocated <span class="type">GParamSpec</span> instance</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-param-spec-config-path-type"></a><h3>gimp_param_spec_config_path_type ()</h3> +<pre class="programlisting"><a class="link" href="libgimpconfig-GimpConfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType"><span class="returnvalue">GimpConfigPathType</span></a> +gimp_param_spec_config_path_type (<em class="parameter"><code><span class="type">GParamSpec</span> *pspec</code></em>);</pre> +<p>Tells whether the path param encodes a filename, +dir name, or list of file or dir names.</p> +<div class="refsect3"> +<a name="gimp-param-spec-config-path-type.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>pspec</p></td> +<td class="parameter_description"><p>A <span class="type">GParamSpec</span> for a path param</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-param-spec-config-path-type.returns"></a><h4>Returns</h4> +<p> a <a class="link" href="libgimpconfig-GimpConfig-path.html#GimpConfigPathType" title="enum GimpConfigPathType"><span class="type">GimpConfigPathType</span></a> value</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-path-expand"></a><h3>gimp_config_path_expand ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_config_path_expand (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> recode</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>Paths as stored in gimprc and other config files have to be treated +special. The string may contain special identifiers such as for +example ${gimp_dir} that have to be substituted before use. Also +the user's filesystem may be in a different encoding than UTF-8 +(which is what is used for the gimprc). This function does the +variable substitution for you and can also attempt to convert to +the filesystem encoding.</p> +<p>To reverse the expansion, use <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-unexpand" title="gimp_config_path_unexpand ()"><code class="function">gimp_config_path_unexpand()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-config-path-expand.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>path</p></td> +<td class="parameter_description"><p>a NUL-terminated string in UTF-8 encoding</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>recode</p></td> +<td class="parameter_description"><p>whether to convert to the filesystem's encoding</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for errors</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-path-expand.returns"></a><h4>Returns</h4> +<p> a newly allocated NUL-terminated string</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-path-expand-to-files"></a><h3>gimp_config_path_expand_to_files ()</h3> +<pre class="programlisting"><span class="returnvalue">GList</span> * +gimp_config_path_expand_to_files (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>Paths as stored in the gimprc have to be treated special. The +string may contain special identifiers such as for example +${gimp_dir} that have to be substituted before use. Also the user's +filesystem may be in a different encoding than UTF-8 (which is what +is used for the gimprc).</p> +<p>This function runs <em class="parameter"><code>path</code></em> + through <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a> and +<a href="../html/libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a>, then turns the filenames returned by +<a href="../html/libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a> into GFile using <code class="function">g_file_new_for_path()</code>.</p> +<div class="refsect3"> +<a name="gimp-config-path-expand-to-files.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>path</p></td> +<td class="parameter_description"><p>a NUL-terminated string in UTF-8 encoding</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for errors</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-path-expand-to-files.returns"></a><h4>Returns</h4> +<p> a <span class="type">GList</span> of newly allocated <span class="type">GFile</span> objects.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-config-path-unexpand"></a><h3>gimp_config_path_unexpand ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_config_path_unexpand (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> recode</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>The inverse operation of <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a></p> +<p>This function takes a <em class="parameter"><code>path</code></em> + and tries to substitute the first +elements by well-known special identifiers such as for example +${gimp_dir}. The unexpanded path can then be stored in gimprc and +other config files.</p> +<p>If <em class="parameter"><code>recode</code></em> + is <code class="literal">TRUE</code> then <em class="parameter"><code>path</code></em> + is in local filesystem encoding, +if <em class="parameter"><code>recode</code></em> + is <code class="literal">FALSE</code> then <em class="parameter"><code>path</code></em> + is assumed to be UTF-8.</p> +<div class="refsect3"> +<a name="gimp-config-path-unexpand.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>path</p></td> +<td class="parameter_description"><p>a NUL-terminated string</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>recode</p></td> +<td class="parameter_description"><p>whether <em class="parameter"><code>path</code></em> +is in filesystem encoding or UTF-8</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for errors</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-path-unexpand.returns"></a><h4>Returns</h4> +<p> a newly allocated NUL-terminated UTF-8 string</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-file-new-for-config-path"></a><h3>gimp_file_new_for_config_path ()</h3> +<pre class="programlisting"><span class="returnvalue">GFile</span> * +gimp_file_new_for_config_path (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>Expands <em class="parameter"><code>path</code></em> + using <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a> and returns a <span class="type">GFile</span> +for the expanded path.</p> +<p>To reverse the expansion, use <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-file-get-config-path" title="gimp_file_get_config_path ()"><code class="function">gimp_file_get_config_path()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-file-new-for-config-path.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>path</p></td> +<td class="parameter_description"><p>a NUL-terminated string in UTF-8 encoding</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for errors</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-file-new-for-config-path.returns"></a><h4>Returns</h4> +<p> a newly allocated <span class="type">GFile</span>, or <code class="literal">NULL</code> if the expansion failed.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-file-get-config-path"></a><h3>gimp_file_get_config_path ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_file_get_config_path (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>, + <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<p>Unexpands <em class="parameter"><code>file</code></em> +'s path using <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-unexpand" title="gimp_config_path_unexpand ()"><code class="function">gimp_config_path_unexpand()</code></a> and +returns the unexpanded path.</p> +<p>The inverse operation of <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-file-new-for-config-path" title="gimp_file_new_for_config_path ()"><code class="function">gimp_file_new_for_config_path()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-file-get-config-path.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>file</p></td> +<td class="parameter_description"><p>a <span class="type">GFile</span></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>return location for errors</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-file-get-config-path.returns"></a><h4>Returns</h4> +<p> a newly allocated NUL-terminated UTF-8 string, or <code class="literal">NULL</code> if +unexpanding failed.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-config-build-data-path"></a><h3>gimp_config_build_data_path ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_config_build_data_path (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Creates a search path as it is used in the gimprc file. The path +returned by <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-build-data-path" title="gimp_config_build_data_path ()"><code class="function">gimp_config_build_data_path()</code></a> includes a directory +below the user's gimp directory and one in the system-wide data +directory.</p> +<p>Note that you cannot use this path directly with <a href="../html/libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a>. +As it is in the gimprc notation, you first need to expand and +recode it using <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-config-build-data-path.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>name</p></td> +<td class="parameter_description"><p>directory name (in UTF-8 encoding)</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-build-data-path.returns"></a><h4>Returns</h4> +<p> a newly allocated string</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-build-writable-path"></a><h3>gimp_config_build_writable_path ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_config_build_writable_path (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Creates a search path as it is used in the gimprc file. The path +returned by <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-build-writable-path" title="gimp_config_build_writable_path ()"><code class="function">gimp_config_build_writable_path()</code></a> is just the writable +parts of the search path constructed by <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-build-data-path" title="gimp_config_build_data_path ()"><code class="function">gimp_config_build_data_path()</code></a>.</p> +<p>Note that you cannot use this path directly with <a href="../html/libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a>. +As it is in the gimprc notation, you first need to expand and +recode it using <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-config-build-writable-path.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>name</p></td> +<td class="parameter_description"><p>directory name (in UTF-8 encoding)</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-build-writable-path.returns"></a><h4>Returns</h4> +<p> a newly allocated string</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-build-plug-in-path"></a><h3>gimp_config_build_plug_in_path ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_config_build_plug_in_path (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Creates a search path as it is used in the gimprc file. The path +returned by <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-build-plug-in-path" title="gimp_config_build_plug_in_path ()"><code class="function">gimp_config_build_plug_in_path()</code></a> includes a directory +below the user's gimp directory and one in the system-wide plug-in +directory.</p> +<p>Note that you cannot use this path directly with <a href="../html/libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a>. +As it is in the gimprc notation, you first need to expand and +recode it using <a class="link" href="libgimpconfig-GimpConfig-path.html#gimp-config-path-expand" title="gimp_config_path_expand ()"><code class="function">gimp_config_path_expand()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-config-build-plug-in-path.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>name</p></td> +<td class="parameter_description"><p>directory name (in UTF-8 encoding)</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-config-build-plug-in-path.returns"></a><h4>Returns</h4> +<p> a newly allocated string</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-VALUE-HOLDS-CONFIG-PATH:CAPS"></a><h3>GIMP_VALUE_HOLDS_CONFIG_PATH()</h3> +<pre class="programlisting">#define GIMP_VALUE_HOLDS_CONFIG_PATH(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_CONFIG_PATH)) +</pre> +</div> +</div> +<div class="refsect1"> +<a name="libgimpconfig-GimpConfig-path.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpConfigPath"></a><h3>GimpConfigPath</h3> +<pre class="programlisting">typedef gchar * GimpConfigPath; /* to satisfy docs */ +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GimpConfigPathType"></a><h3>enum GimpConfigPathType</h3> +<p>Types of config paths.</p> +<div class="refsect3"> +<a name="GimpConfigPathType.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="GIMP-CONFIG-PATH-FILE:CAPS"></a>GIMP_CONFIG_PATH_FILE</p></td> +<td class="enum_member_description"> +<p>A single file</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-CONFIG-PATH-FILE-LIST:CAPS"></a>GIMP_CONFIG_PATH_FILE_LIST</p></td> +<td class="enum_member_description"> +<p>A list of files</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-CONFIG-PATH-DIR:CAPS"></a>GIMP_CONFIG_PATH_DIR</p></td> +<td class="enum_member_description"> +<p>A single folder</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-CONFIG-PATH-DIR-LIST:CAPS"></a>GIMP_CONFIG_PATH_DIR_LIST</p></td> +<td class="enum_member_description"> +<p>A list of folders</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |