← Back to branch summary

~ubuntu-branches/debian/experimental/thunar/experimental

« back to all changes in this revision

Viewing changes to docs/reference/thunar-vfs/xml/thunar-vfs-info.xml

  • Committer: Bazaar Package Importer
  • Author(s): Yves-Alexis Perez
  • Date: 2006-01-02 23:42:32 UTC
  • Revision ID: james.westby@ubuntu.com-20060102234232-8xeq0lqhyn70syr0
Tags: upstream-0.1.4svn+r18850
Import upstream version 0.1.4svn+r18850

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/thunar-vfs/xml/thunar-vfs-info.xml
 
1
<refentry id="thunar-vfs-ThunarVfsInfo">
 
2
<refmeta>
 
3
<refentrytitle>ThunarVfsInfo</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>THUNAR-VFS Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>ThunarVfsInfo</refname><refpurpose></refpurpose>
 
10
</refnamediv>
 
11
 
 
12
<refsynopsisdiv><title>Synopsis</title>
 
13
 
 
14
<synopsis>
 
15
 
 
16
#include &lt;thunar-vfs/thunar-vfs.h&gt;
 
17
 
 
18
 
 
19
            <link linkend="ThunarVfsInfo">ThunarVfsInfo</link>;
 
20
<link linkend="ThunarVfsInfo">ThunarVfsInfo</link>* <link linkend="thunar-vfs-info-new-for-path">thunar_vfs_info_new_for_path</link> (<link linkend="ThunarVfsPath">ThunarVfsPath</link> *path,
 
21
                                             <link linkend="GError">GError</link> **error);
 
22
<link linkend="ThunarVfsInfo">ThunarVfsInfo</link>* <link linkend="thunar-vfs-info-ref">thunar_vfs_info_ref</link>          (<link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info);
 
23
<link linkend="void">void</link>        <link linkend="thunar-vfs-info-unref">thunar_vfs_info_unref</link>           (<link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info);
 
24
<link linkend="gboolean">gboolean</link>    <link linkend="thunar-vfs-info-execute">thunar_vfs_info_execute</link>         (const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info,
 
25
                                             <link linkend="GdkScreen">GdkScreen</link> *screen,
 
26
                                             <link linkend="GList">GList</link> *path_list,
 
27
                                             <link linkend="GError">GError</link> **error);
 
28
<link linkend="gboolean">gboolean</link>    <link linkend="thunar-vfs-info-rename">thunar_vfs_info_rename</link>          (<link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info,
 
29
                                             const <link linkend="gchar">gchar</link> *name,
 
30
                                             <link linkend="GError">GError</link> **error);
 
31
<link linkend="gboolean">gboolean</link>    <link linkend="thunar-vfs-info-matches">thunar_vfs_info_matches</link>         (const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *a,
 
32
                                             const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *b);
 
33
<link linkend="void">void</link>        <link linkend="thunar-vfs-info-list-free">thunar_vfs_info_list_free</link>       (<link linkend="GList">GList</link> *info_list);
 
34
 
 
35
 
 
36
</synopsis>
 
37
</refsynopsisdiv>
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
<refsect1>
 
48
<title>Description</title>
 
49
<para>
 
50
 
 
51
</para>
 
52
</refsect1>
 
53
 
 
54
<refsect1>
 
55
<title>Details</title>
 
56
<refsect2>
 
57
<title><anchor id="ThunarVfsInfo"/>ThunarVfsInfo</title>
 
58
<indexterm><primary>ThunarVfsInfo</primary></indexterm><programlisting>typedef struct {
 
59
  /* File type */
 
60
  ThunarVfsFileType type;
 
61
 
 
62
  /* File permissions and special mode flags */
 
63
  ThunarVfsFileMode mode;
 
64
 
 
65
  /* File flags */
 
66
  ThunarVfsFileFlags flags;
 
67
 
 
68
  /* Owner's user id */
 
69
  ThunarVfsUserId uid;
 
70
 
 
71
  /* Owner's group id */
 
72
  ThunarVfsGroupId gid;
 
73
 
 
74
  /* Size in bytes */
 
75
  ThunarVfsFileSize size;
 
76
 
 
77
  /* time of last access */
 
78
  ThunarVfsFileTime atime;
 
79
 
 
80
  /* time of last modification */
 
81
  ThunarVfsFileTime mtime;
 
82
 
 
83
  /* time of last status change */
 
84
  ThunarVfsFileTime ctime;
 
85
 
 
86
  /* inode id */
 
87
  ThunarVfsFileInode inode;
 
88
 
 
89
  /* device id */
 
90
  ThunarVfsFileDevice device;
 
91
 
 
92
  /* file's mime type */
 
93
  ThunarVfsMimeInfo *mime_info;
 
94
 
 
95
  /* file's absolute path */
 
96
  ThunarVfsPath *path;
 
97
 
 
98
  /* file's custom icon (path or themed icon name) */
 
99
  gchar *custom_icon;
 
100
 
 
101
  /* file's display name (UTF-8) */
 
102
  gchar *display_name;
 
103
} ThunarVfsInfo;
 
104
</programlisting>
 
105
<para>
 
106
The <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link> structure provides information about a file system
 
107
entity.</para>
 
108
<para>
 
109
 
 
110
</para></refsect2>
 
111
<refsect2>
 
112
<title><anchor id="thunar-vfs-info-new-for-path"/>thunar_vfs_info_new_for_path ()</title>
 
113
<indexterm><primary>thunar_vfs_info_new_for_path</primary></indexterm><programlisting><link linkend="ThunarVfsInfo">ThunarVfsInfo</link>* thunar_vfs_info_new_for_path (<link linkend="ThunarVfsPath">ThunarVfsPath</link> *path,
 
114
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
115
<para>
 
116
Queries the <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link> for the given <parameter>path</parameter>. Returns the
 
117
<link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link> if the operation is successfull, else <literal>NULL</literal>.
 
118
In the latter case, <parameter>error</parameter> will be set to point to a <link linkend="GError"><type>GError</type></link>
 
119
describing the cause of the failure.</para>
 
120
<para>
 
121
 
 
122
</para><variablelist role="params">
 
123
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
124
<listitem><simpara> the <link linkend="ThunarVfsPath"><type>ThunarVfsPath</type></link> of the file whose info should be queried.
 
125
</simpara></listitem></varlistentry>
 
126
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
127
<listitem><simpara> return location for errors or <literal>NULL</literal>.
 
128
</simpara></listitem></varlistentry>
 
129
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link> for <parameter>path</parameter> or <literal>NULL</literal>.
 
130
</simpara></listitem></varlistentry>
 
131
</variablelist></refsect2>
 
132
<refsect2>
 
133
<title><anchor id="thunar-vfs-info-ref"/>thunar_vfs_info_ref ()</title>
 
134
<indexterm><primary>thunar_vfs_info_ref</primary></indexterm><programlisting><link linkend="ThunarVfsInfo">ThunarVfsInfo</link>* thunar_vfs_info_ref          (<link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info);</programlisting>
 
135
<para>
 
136
Increments the reference count on <parameter>info</parameter> by 1 and
 
137
returns a pointer to <parameter>info</parameter>.</para>
 
138
<para>
 
139
 
 
140
</para><variablelist role="params">
 
141
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
142
<listitem><simpara> a <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link>.
 
143
</simpara></listitem></varlistentry>
 
144
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to <parameter>info</parameter>.
 
145
</simpara></listitem></varlistentry>
 
146
</variablelist></refsect2>
 
147
<refsect2>
 
148
<title><anchor id="thunar-vfs-info-unref"/>thunar_vfs_info_unref ()</title>
 
149
<indexterm><primary>thunar_vfs_info_unref</primary></indexterm><programlisting><link linkend="void">void</link>        thunar_vfs_info_unref           (<link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info);</programlisting>
 
150
<para>
 
151
Decrements the reference count on <parameter>info</parameter> by 1 and if
 
152
the reference count drops to zero as a result of this
 
153
operation, the <parameter>info</parameter> will be freed completely.</para>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
158
<listitem><simpara> a <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link>.
 
159
</simpara></listitem></varlistentry>
 
160
</variablelist></refsect2>
 
161
<refsect2>
 
162
<title><anchor id="thunar-vfs-info-execute"/>thunar_vfs_info_execute ()</title>
 
163
<indexterm><primary>thunar_vfs_info_execute</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    thunar_vfs_info_execute         (const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info,
 
164
                                             <link linkend="GdkScreen">GdkScreen</link> *screen,
 
165
                                             <link linkend="GList">GList</link> *path_list,
 
166
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
167
<para>
 
168
Executes the file referred to by <parameter>info</parameter>, given <parameter>path_list</parameter> as parameters,
 
169
on the specified <parameter>screen</parameter>. <parameter>info</parameter> may refer to either a regular,
 
170
executable file, or a <filename>.desktop</filename> file, whose
 
171
type is <literal>Application</literal>.</para>
 
172
<para>
 
173
 
 
174
</para><variablelist role="params">
 
175
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
176
<listitem><simpara> a <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link>.
 
177
</simpara></listitem></varlistentry>
 
178
<varlistentry><term><parameter>screen</parameter>&nbsp;:</term>
 
179
<listitem><simpara> a <link linkend="GdkScreen"><type>GdkScreen</type></link> or <literal>NULL</literal> to use the default <link linkend="GdkScreen"><type>GdkScreen</type></link>.
 
180
</simpara></listitem></varlistentry>
 
181
<varlistentry><term><parameter>path_list</parameter>&nbsp;:</term>
 
182
<listitem><simpara> the list of <link linkend="ThunarVfsPath"><type>ThunarVfsPath</type></link><!---->s to give as parameters
 
183
             to the file referred to by <parameter>info</parameter> on execution.
 
184
</simpara></listitem></varlistentry>
 
185
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
186
<listitem><simpara> return location for errors or <literal>NULL</literal>.
 
187
</simpara></listitem></varlistentry>
 
188
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> on success, else <literal>FALSE</literal>.
 
189
</simpara></listitem></varlistentry>
 
190
</variablelist></refsect2>
 
191
<refsect2>
 
192
<title><anchor id="thunar-vfs-info-rename"/>thunar_vfs_info_rename ()</title>
 
193
<indexterm><primary>thunar_vfs_info_rename</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    thunar_vfs_info_rename          (<link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *info,
 
194
                                             const <link linkend="gchar">gchar</link> *name,
 
195
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
196
<para>
 
197
Tries to rename the file referred to by <parameter>info</parameter> to the
 
198
new <parameter>name</parameter>.
 
199
</para>
 
200
<para>
 
201
The rename operation is smart in that it checks the
 
202
type of <parameter>info</parameter> first, and if <parameter>info</parameter> refers to a
 
203
<filename>.desktop</filename> file, the file name
 
204
won't be touched, but instead the <literal>Name</literal>
 
205
field of the <filename>.desktop</filename> will be
 
206
changed to <parameter>name</parameter>. Else, if <parameter>info</parameter> refers to a regular
 
207
file or directory, the file will be given a new
 
208
name.</para>
 
209
<para>
 
210
 
 
211
</para><variablelist role="params">
 
212
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 
213
<listitem><simpara> a <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link>.
 
214
</simpara></listitem></varlistentry>
 
215
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
216
<listitem><simpara> the new file name in UTF-8 encoding.
 
217
</simpara></listitem></varlistentry>
 
218
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
219
<listitem><simpara> return location for errors or <literal>NULL</literal>.
 
220
</simpara></listitem></varlistentry>
 
221
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> on success, else <literal>FALSE</literal>.
 
222
</simpara></listitem></varlistentry>
 
223
</variablelist></refsect2>
 
224
<refsect2>
 
225
<title><anchor id="thunar-vfs-info-matches"/>thunar_vfs_info_matches ()</title>
 
226
<indexterm><primary>thunar_vfs_info_matches</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    thunar_vfs_info_matches         (const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *a,
 
227
                                             const <link linkend="ThunarVfsInfo">ThunarVfsInfo</link> *b);</programlisting>
 
228
<para>
 
229
Checks whether <parameter>a</parameter> and <parameter>b</parameter> refer to the same file
 
230
and share the same properties.</para>
 
231
<para>
 
232
 
 
233
</para><variablelist role="params">
 
234
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
235
<listitem><simpara> a <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link>.
 
236
</simpara></listitem></varlistentry>
 
237
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
 
238
<listitem><simpara> a <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link>.
 
239
</simpara></listitem></varlistentry>
 
240
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>a</parameter> and <parameter>b</parameter> match.
 
241
</simpara></listitem></varlistentry>
 
242
</variablelist></refsect2>
 
243
<refsect2>
 
244
<title><anchor id="thunar-vfs-info-list-free"/>thunar_vfs_info_list_free ()</title>
 
245
<indexterm><primary>thunar_vfs_info_list_free</primary></indexterm><programlisting><link linkend="void">void</link>        thunar_vfs_info_list_free       (<link linkend="GList">GList</link> *info_list);</programlisting>
 
246
<para>
 
247
Unrefs all <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link><!---->s in <parameter>info_list</parameter> and
 
248
frees the list itself.
 
249
</para>
 
250
<para>
 
251
This method always returns <literal>NULL</literal> for the convenience of
 
252
being able to do:
 
253
<informalexample><programlisting>
 
254
info_list = thunar_vfs_info_list_free (info_list);
 
255
</programlisting></informalexample></para>
 
256
<para>
 
257
 
 
258
</para><variablelist role="params">
 
259
<varlistentry><term><parameter>info_list</parameter>&nbsp;:</term>
 
260
<listitem><simpara> a list <link linkend="ThunarVfsInfo"><type>ThunarVfsInfo</type></link><!---->s.
 
261
</simpara></listitem></varlistentry>
 
262
</variablelist></refsect2>
 
263
 
 
264
</refsect1>
 
265
 
 
266
 
 
267
 
 
268
 
 
269
</refentry>