summaryrefslogtreecommitdiffstats
path: root/devel-docs/libgimpbase/html/libgimpbase-gimpdatafiles.html
blob: 4095f1edbf359405785a6bd2b60197a7d6fdfcd6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpdatafiles: GIMP Base Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="pt01.html" title="Part I. GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpcpuaccel.html" title="gimpcpuaccel">
<link rel="next" href="libgimpbase-gimpenv.html" title="gimpenv">
<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="#libgimpbase-gimpdatafiles.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="libgimpbase-gimpcpuaccel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimpbase-gimpenv.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimpbase-gimpdatafiles"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimpbase-gimpdatafiles.top_of_page"></a>gimpdatafiles</span></h2>
<p>gimpdatafiles — Functions to handle GIMP data files.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimpbase-gimpdatafiles.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">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc" title="GimpDatafileLoaderFunc ()">*GimpDatafileLoaderFunc</a><span class="c_punctuation">)</span> <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="libgimpbase-gimpdatafiles.html#gimp-datafiles-check-extension" title="gimp_datafiles_check_extension ()">gimp_datafiles_check_extension</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories" title="gimp_datafiles_read_directories ()">gimp_datafiles_read_directories</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpdatafiles.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="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libgimpbase-gimpdatafiles.html#GimpDatafileData" title="GimpDatafileData">GimpDatafileData</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpdatafiles.description"></a><h2>Description</h2>
<p>Functions to handle GIMP data files.</p>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpdatafiles.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GimpDatafileLoaderFunc"></a><h3>GimpDatafileLoaderFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpDatafileLoaderFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="libgimpbase-gimpdatafiles.html#GimpDatafileData" title="GimpDatafileData"><span class="type">GimpDatafileData</span></a> *file_data</code></em>,
                           <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-datafiles-check-extension"></a><h3>gimp_datafiles_check_extension ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_datafiles_check_extension (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *extension</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_datafiles_check_extension</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-datafiles-read-directories"></a><h3>gimp_datafiles_read_directories ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_datafiles_read_directories (<em class="parameter"><code>const <span class="type">gchar</span> *path_str</code></em>,
                                 <em class="parameter"><code><span class="type">GFileTest</span> flags</code></em>,
                                 <em class="parameter"><code><a class="link" href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc" title="GimpDatafileLoaderFunc ()"><span class="type">GimpDatafileLoaderFunc</span></a> loader_func</code></em>,
                                 <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_datafiles_read_directories</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimpdatafiles.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpDatafileData"></a><h3>GimpDatafileData</h3>
<pre class="programlisting">typedef struct {
  const gchar *filename;
  const gchar *dirname;
  const gchar *basename;

  time_t       atime;
  time_t       mtime;
  time_t       ctime;
} GimpDatafileData;
</pre>
<p>This structure is passed to the <a class="link" href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc" title="GimpDatafileLoaderFunc ()"><span class="type">GimpDatafileLoaderFunc</span></a> given to
<a class="link" href="libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories" title="gimp_datafiles_read_directories ()"><code class="function">gimp_datafiles_read_directories()</code></a> for each file encountered in the
data path.</p>
<div class="refsect3">
<a name="GimpDatafileData.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="GimpDatafileData.filename"></a>filename</code></em>;</p></td>
<td class="struct_member_description"><p>the data file's full path.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="GimpDatafileData.dirname"></a>dirname</code></em>;</p></td>
<td class="struct_member_description"><p>the folder the data file is in.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="GimpDatafileData.basename"></a>basename</code></em>;</p></td>
<td class="struct_member_description"><p>the data file's basename.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">time_t</span> <em class="structfield"><code><a name="GimpDatafileData.atime"></a>atime</code></em>;</p></td>
<td class="struct_member_description"><p>the last time the file was accessed for reading.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">time_t</span> <em class="structfield"><code><a name="GimpDatafileData.mtime"></a>mtime</code></em>;</p></td>
<td class="struct_member_description"><p>the last time the file was modified.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">time_t</span> <em class="structfield"><code><a name="GimpDatafileData.ctime"></a>ctime</code></em>;</p></td>
<td class="struct_member_description"><p>the time the file was created.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>