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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ParoleFile</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Parole Plugins Reference Manual">
<link rel="up" href="Utils.html" title="Part V. Parole Utilities">
<link rel="prev" href="Utils.html" title="Part V. Parole Utilities">
<link rel="next" href="Parole-Plugins-parole-filters.html" title="Parole Filters">
<meta name="generator" content="GTK-Doc V1.17 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="Utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Utils.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Parole Plugins Reference Manual</th>
<td><a accesskey="n" href="Parole-Plugins-parole-filters.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ParoleFile.synopsis" class="shortcut">Top</a>
|
<a href="#ParoleFile.description" class="shortcut">Description</a>
|
<a href="#ParoleFile.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ParoleFile.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="ParoleFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ParoleFile.top_of_page"></a>ParoleFile</span></h2>
<p>ParoleFile — Simple file handling.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ParoleFile.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="ParoleFile.html#ParoleFile-struct" title="struct ParoleFile">ParoleFile</a>;
<a class="link" href="ParoleFile.html" title="ParoleFile"><span class="returnvalue">ParoleFile</span></a> * <a class="link" href="ParoleFile.html#parole-file-new" title="parole_file_new ()">parole_file_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
<a class="link" href="ParoleFile.html" title="ParoleFile"><span class="returnvalue">ParoleFile</span></a> * <a class="link" href="ParoleFile.html#parole-file-new-with-display-name" title="parole_file_new_with_display_name ()">parole_file_new_with_display_name</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *display_name</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * <a class="link" href="ParoleFile.html#parole-file-get-file-name" title="parole_file_get_file_name ()">parole_file_get_file_name</a> (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * <a class="link" href="ParoleFile.html#parole-file-get-display-name" title="parole_file_get_display_name ()">parole_file_get_display_name</a> (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * <a class="link" href="ParoleFile.html#parole-file-get-uri" title="parole_file_get_uri ()">parole_file_get_uri</a> (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * <a class="link" href="ParoleFile.html#parole-file-get-content-type" title="parole_file_get_content_type ()">parole_file_get_content_type</a> (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ParoleFile.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----ParoleFile
</pre>
</div>
<div class="refsect1">
<a name="ParoleFile.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="ParoleFile.html#ParoleFile--content-type" title='The "content-type" property'>content-type</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="ParoleFile.html#ParoleFile--display-name" title='The "display-name" property'>display-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
"<a class="link" href="ParoleFile.html#ParoleFile--filename" title='The "filename" property'>filename</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
"<a class="link" href="ParoleFile.html#ParoleFile--uri" title='The "uri" property'>uri</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
</pre>
</div>
<div class="refsect1">
<a name="ParoleFile.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="ParoleFile.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ParoleFile-struct"></a><h3>struct ParoleFile</h3>
<pre class="programlisting">struct ParoleFile;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-file-new"></a><h3>parole_file_new ()</h3>
<pre class="programlisting"><a class="link" href="ParoleFile.html" title="ParoleFile"><span class="returnvalue">ParoleFile</span></a> * parole_file_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>filename.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> object.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-file-new-with-display-name"></a><h3>parole_file_new_with_display_name ()</h3>
<pre class="programlisting"><a class="link" href="ParoleFile.html" title="ParoleFile"><span class="returnvalue">ParoleFile</span></a> * parole_file_new_with_display_name (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *display_name</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>filename.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> object.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-file-get-file-name"></a><h3>parole_file_get_file_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * parole_file_get_file_name (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the file name.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-file-get-display-name"></a><h3>parole_file_get_display_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * parole_file_get_display_name (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the display name.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-file-get-uri"></a><h3>parole_file_get_uri ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * parole_file_get_uri (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the file uri.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-file-get-content-type"></a><h3>parole_file_get_content_type ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> const * parole_file_get_content_type (<em class="parameter"><code>const <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a> *file</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a <a class="link" href="ParoleFile.html" title="ParoleFile"><span class="type">ParoleFile</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the content type of the file.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
</div>
<div class="refsect1">
<a name="ParoleFile.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ParoleFile--content-type"></a><h3>The <code class="literal">"content-type"</code> property</h3>
<pre class="programlisting"> "content-type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
The content type of the file.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ParoleFile--display-name"></a><h3>The <code class="literal">"display-name"</code> property</h3>
<pre class="programlisting"> "display-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
<p>
A UTF-8 name that can be displayed in the UI.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ParoleFile--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
<pre class="programlisting"> "filename" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
<p>
The file name of the file.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ParoleFile--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
<pre class="programlisting"> "uri" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
The uri of the file.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|
