← Back to branch summary

~ubuntu-branches/debian/sid/thunar/sid

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2010-05-23 14:12:33 UTC
  • mfrom: (1.1.24 upstream)
  • Revision ID: james.westby@ubuntu.com-20100523141233-ntplken25atdr214
Tags: 1.0.2-1
* New upstream release.
* debian/patches/04_fix-umask-handling.patch: dropped, included upstream.
* debian/control: build-dep on libstartup-notification0-dev (>= 0.4) as
  startup notification support is enabled in debian/rules.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/thunar-vfs/xml/thunar-vfs-volume.xml
1
 
<refentry id="ThunarVfsVolume">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="ThunarVfsVolume.top_of_page">ThunarVfsVolume</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>THUNAR-VFS Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>ThunarVfsVolume</refname>
10
 
<refpurpose></refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
 
</refnamediv>
13
 
 
14
 
<refsynopsisdiv id="ThunarVfsVolume.synopsis" role="synopsis">
15
 
<title role="synopsis.title">Synopsis</title>
16
 
 
17
 
<synopsis>
18
 
 
19
 
#include &lt;thunar-vfs/thunar-vfs.h&gt;
20
 
 
21
 
enum                <link linkend="ThunarVfsVolumeKind">ThunarVfsVolumeKind</link>;
22
 
enum                <link linkend="ThunarVfsVolumeStatus">ThunarVfsVolumeStatus</link>;
23
 
                    <link linkend="ThunarVfsVolume-struct">ThunarVfsVolume</link>;
24
 
<link linkend="ThunarVfsVolumeKind">ThunarVfsVolumeKind</link> <link linkend="thunar-vfs-volume-get-kind">thunar_vfs_volume_get_kind</link>          (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
25
 
const <link linkend="gchar">gchar</link>*        <link linkend="thunar-vfs-volume-get-name">thunar_vfs_volume_get_name</link>          (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
26
 
<link linkend="ThunarVfsVolumeStatus">ThunarVfsVolumeStatus</link> <link linkend="thunar-vfs-volume-get-status">thunar_vfs_volume_get_status</link>      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
27
 
<link linkend="ThunarVfsPath">ThunarVfsPath</link>*      <link linkend="thunar-vfs-volume-get-mount-point">thunar_vfs_volume_get_mount_point</link>   (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
28
 
<link linkend="gboolean">gboolean</link>            <link linkend="thunar-vfs-volume-is-mounted">thunar_vfs_volume_is_mounted</link>        (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
29
 
<link linkend="gboolean">gboolean</link>            <link linkend="thunar-vfs-volume-is-present">thunar_vfs_volume_is_present</link>        (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
30
 
<link linkend="gboolean">gboolean</link>            <link linkend="thunar-vfs-volume-is-ejectable">thunar_vfs_volume_is_ejectable</link>      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
31
 
<link linkend="gboolean">gboolean</link>            <link linkend="thunar-vfs-volume-is-removable">thunar_vfs_volume_is_removable</link>      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);
32
 
const <link linkend="gchar">gchar</link>*        <link linkend="thunar-vfs-volume-lookup-icon-name">thunar_vfs_volume_lookup_icon_name</link>  (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
33
 
                                                         <link linkend="GtkIconTheme">GtkIconTheme</link> *icon_theme);
34
 
<link linkend="gboolean">gboolean</link>            <link linkend="thunar-vfs-volume-eject">thunar_vfs_volume_eject</link>             (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
35
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *window,
36
 
                                                         <link linkend="GError">GError</link> **error);
37
 
<link linkend="gboolean">gboolean</link>            <link linkend="thunar-vfs-volume-mount">thunar_vfs_volume_mount</link>             (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
38
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *window,
39
 
                                                         <link linkend="GError">GError</link> **error);
40
 
<link linkend="gboolean">gboolean</link>            <link linkend="thunar-vfs-volume-unmount">thunar_vfs_volume_unmount</link>           (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
41
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *window,
42
 
                                                         <link linkend="GError">GError</link> **error);
43
 
</synopsis>
44
 
</refsynopsisdiv>
45
 
 
46
 
<refsect1 id="ThunarVfsVolume.object-hierarchy" role="object_hierarchy">
47
 
<title role="object_hierarchy.title">Object Hierarchy</title>
48
 
<synopsis>
49
 
  <link linkend="GObject">GObject</link>
50
 
   +----ThunarVfsVolume
51
 
</synopsis>
52
 
 
53
 
</refsect1>
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
<refsect1 id="ThunarVfsVolume.signals" role="signal_proto">
61
 
<title role="signal_proto.title">Signals</title>
62
 
<synopsis>
63
 
  &quot;<link linkend="ThunarVfsVolume-changed">changed</link>&quot;                                        : Run Last
64
 
  &quot;<link linkend="ThunarVfsVolume-mounted">mounted</link>&quot;                                        : Run Last
65
 
  &quot;<link linkend="ThunarVfsVolume-pre-unmount">pre-unmount</link>&quot;                                    : Run Last
66
 
  &quot;<link linkend="ThunarVfsVolume-unmounted">unmounted</link>&quot;                                      : Run Last
67
 
</synopsis>
68
 
</refsect1>
69
 
 
70
 
 
71
 
<refsect1 id="ThunarVfsVolume.description" role="desc">
72
 
<title role="desc.title">Description</title>
73
 
<para>
74
 
 
75
 
</para>
76
 
</refsect1>
77
 
 
78
 
<refsect1 id="ThunarVfsVolume.details" role="details">
79
 
<title role="details.title">Details</title>
80
 
<refsect2 id="ThunarVfsVolumeKind" role="enum">
81
 
<title>enum ThunarVfsVolumeKind</title>
82
 
<indexterm zone="ThunarVfsVolumeKind"><primary>ThunarVfsVolumeKind</primary></indexterm><programlisting>typedef enum
83
 
{
84
 
  THUNAR_VFS_VOLUME_KIND_UNKNOWN,
85
 
  THUNAR_VFS_VOLUME_KIND_CDROM,
86
 
  THUNAR_VFS_VOLUME_KIND_CDR,
87
 
  THUNAR_VFS_VOLUME_KIND_CDRW,
88
 
  THUNAR_VFS_VOLUME_KIND_DVDROM,
89
 
  THUNAR_VFS_VOLUME_KIND_DVDRAM,
90
 
  THUNAR_VFS_VOLUME_KIND_DVDR,
91
 
  THUNAR_VFS_VOLUME_KIND_DVDRW,
92
 
  THUNAR_VFS_VOLUME_KIND_DVDPLUSR,
93
 
  THUNAR_VFS_VOLUME_KIND_DVDPLUSRW,
94
 
  THUNAR_VFS_VOLUME_KIND_FLOPPY,
95
 
  THUNAR_VFS_VOLUME_KIND_HARDDISK,
96
 
  THUNAR_VFS_VOLUME_KIND_USBSTICK,
97
 
  THUNAR_VFS_VOLUME_KIND_AUDIO_PLAYER,
98
 
  THUNAR_VFS_VOLUME_KIND_AUDIO_CD,
99
 
  THUNAR_VFS_VOLUME_KIND_MEMORY_CARD,
100
 
  THUNAR_VFS_VOLUME_KIND_REMOVABLE_DISK,
101
 
} ThunarVfsVolumeKind;
102
 
</programlisting>
103
 
<para>
104
 
Describes the type of a VFS volume.</para>
105
 
<para>
106
 
 
107
 
</para><variablelist role="enum">
108
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-UNKNOWN:CAPS" role="constant">
109
 
<term><literal>THUNAR_VFS_VOLUME_KIND_UNKNOWN</literal></term>
110
 
<listitem><simpara> Unknown volume.
111
 
</simpara></listitem>
112
 
</varlistentry>
113
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-CDROM:CAPS" role="constant">
114
 
<term><literal>THUNAR_VFS_VOLUME_KIND_CDROM</literal></term>
115
 
<listitem><simpara> CD-ROMs.
116
 
</simpara></listitem>
117
 
</varlistentry>
118
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-CDR:CAPS" role="constant">
119
 
<term><literal>THUNAR_VFS_VOLUME_KIND_CDR</literal></term>
120
 
<listitem><simpara> CD-Rs.
121
 
</simpara></listitem>
122
 
</varlistentry>
123
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-CDRW:CAPS" role="constant">
124
 
<term><literal>THUNAR_VFS_VOLUME_KIND_CDRW</literal></term>
125
 
<listitem><simpara> CD-RWs.
126
 
</simpara></listitem>
127
 
</varlistentry>
128
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-DVDROM:CAPS" role="constant">
129
 
<term><literal>THUNAR_VFS_VOLUME_KIND_DVDROM</literal></term>
130
 
<listitem><simpara> DVD-ROMs.
131
 
</simpara></listitem>
132
 
</varlistentry>
133
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-DVDRAM:CAPS" role="constant">
134
 
<term><literal>THUNAR_VFS_VOLUME_KIND_DVDRAM</literal></term>
135
 
<listitem><simpara> DVD-RAMs.
136
 
</simpara></listitem>
137
 
</varlistentry>
138
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-DVDR:CAPS" role="constant">
139
 
<term><literal>THUNAR_VFS_VOLUME_KIND_DVDR</literal></term>
140
 
<listitem><simpara> DVD-Rs.
141
 
</simpara></listitem>
142
 
</varlistentry>
143
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-DVDRW:CAPS" role="constant">
144
 
<term><literal>THUNAR_VFS_VOLUME_KIND_DVDRW</literal></term>
145
 
<listitem><simpara> DVD-RWs.
146
 
</simpara></listitem>
147
 
</varlistentry>
148
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-DVDPLUSR:CAPS" role="constant">
149
 
<term><literal>THUNAR_VFS_VOLUME_KIND_DVDPLUSR</literal></term>
150
 
<listitem><simpara> DVD+Rs.
151
 
</simpara></listitem>
152
 
</varlistentry>
153
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-DVDPLUSRW:CAPS" role="constant">
154
 
<term><literal>THUNAR_VFS_VOLUME_KIND_DVDPLUSRW</literal></term>
155
 
<listitem><simpara> DVD+RWs.
156
 
</simpara></listitem>
157
 
</varlistentry>
158
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-FLOPPY:CAPS" role="constant">
159
 
<term><literal>THUNAR_VFS_VOLUME_KIND_FLOPPY</literal></term>
160
 
<listitem><simpara> Floppy drives.
161
 
</simpara></listitem>
162
 
</varlistentry>
163
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-HARDDISK:CAPS" role="constant">
164
 
<term><literal>THUNAR_VFS_VOLUME_KIND_HARDDISK</literal></term>
165
 
<listitem><simpara> Hard disk drives.
166
 
</simpara></listitem>
167
 
</varlistentry>
168
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-USBSTICK:CAPS" role="constant">
169
 
<term><literal>THUNAR_VFS_VOLUME_KIND_USBSTICK</literal></term>
170
 
<listitem><simpara> USB sticks.
171
 
</simpara></listitem>
172
 
</varlistentry>
173
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-AUDIO-PLAYER:CAPS" role="constant">
174
 
<term><literal>THUNAR_VFS_VOLUME_KIND_AUDIO_PLAYER</literal></term>
175
 
<listitem><simpara> Portable audio players (i.e. iPod).
176
 
</simpara></listitem>
177
 
</varlistentry>
178
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-AUDIO-CD:CAPS" role="constant">
179
 
<term><literal>THUNAR_VFS_VOLUME_KIND_AUDIO_CD</literal></term>
180
 
<listitem><simpara> Audio CDs.
181
 
</simpara></listitem>
182
 
</varlistentry>
183
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-MEMORY-CARD:CAPS" role="constant">
184
 
<term><literal>THUNAR_VFS_VOLUME_KIND_MEMORY_CARD</literal></term>
185
 
<listitem><simpara> Memory cards.
186
 
</simpara></listitem>
187
 
</varlistentry>
188
 
<varlistentry id="THUNAR-VFS-VOLUME-KIND-REMOVABLE-DISK:CAPS" role="constant">
189
 
<term><literal>THUNAR_VFS_VOLUME_KIND_REMOVABLE_DISK</literal></term>
190
 
<listitem><simpara> Other removable disks.
191
 
</simpara></listitem>
192
 
</varlistentry>
193
 
</variablelist></refsect2>
194
 
<refsect2 id="ThunarVfsVolumeStatus" role="enum">
195
 
<title>enum ThunarVfsVolumeStatus</title>
196
 
<indexterm zone="ThunarVfsVolumeStatus"><primary>ThunarVfsVolumeStatus</primary></indexterm><programlisting>typedef enum /*&lt; flags &gt;*/
197
 
{
198
 
  THUNAR_VFS_VOLUME_STATUS_MOUNTED   = 1 &lt;&lt; 0,
199
 
  THUNAR_VFS_VOLUME_STATUS_PRESENT   = 1 &lt;&lt; 1,
200
 
  THUNAR_VFS_VOLUME_STATUS_MOUNTABLE = 1 &lt;&lt; 2,
201
 
} ThunarVfsVolumeStatus;
202
 
</programlisting>
203
 
<para>
204
 
Describes the current status of a VFS volume.</para>
205
 
<para>
206
 
 
207
 
</para><variablelist role="enum">
208
 
</variablelist></refsect2>
209
 
<refsect2 id="ThunarVfsVolume-struct" role="struct">
210
 
<title>ThunarVfsVolume</title>
211
 
<indexterm zone="ThunarVfsVolume-struct"><primary>ThunarVfsVolume</primary></indexterm><programlisting>typedef struct _ThunarVfsVolume ThunarVfsVolume;</programlisting>
212
 
<para>
213
 
 
214
 
</para></refsect2>
215
 
<refsect2 id="thunar-vfs-volume-get-kind" role="function">
216
 
<title>thunar_vfs_volume_get_kind ()</title>
217
 
<indexterm zone="thunar-vfs-volume-get-kind"><primary>thunar_vfs_volume_get_kind</primary></indexterm><programlisting><link linkend="ThunarVfsVolumeKind">ThunarVfsVolumeKind</link> thunar_vfs_volume_get_kind          (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
218
 
<para>
219
 
Returns the kind of drive/device representd by <parameter>volume</parameter>.</para>
220
 
<para>
221
 
 
222
 
</para><variablelist role="params">
223
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
224
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
225
 
</simpara></listitem></varlistentry>
226
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the kind of <parameter>volume</parameter>.
227
 
</simpara></listitem></varlistentry>
228
 
</variablelist></refsect2>
229
 
<refsect2 id="thunar-vfs-volume-get-name" role="function">
230
 
<title>thunar_vfs_volume_get_name ()</title>
231
 
<indexterm zone="thunar-vfs-volume-get-name"><primary>thunar_vfs_volume_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        thunar_vfs_volume_get_name          (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
232
 
<para>
233
 
Returns the name of the <parameter>volume</parameter>. This is usually the
234
 
name of the device or the label of the medium, if a
235
 
medium is present.</para>
236
 
<para>
237
 
 
238
 
</para><variablelist role="params">
239
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
240
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
241
 
</simpara></listitem></varlistentry>
242
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the name of <parameter>volume</parameter>.
243
 
</simpara></listitem></varlistentry>
244
 
</variablelist></refsect2>
245
 
<refsect2 id="thunar-vfs-volume-get-status" role="function">
246
 
<title>thunar_vfs_volume_get_status ()</title>
247
 
<indexterm zone="thunar-vfs-volume-get-status"><primary>thunar_vfs_volume_get_status</primary></indexterm><programlisting><link linkend="ThunarVfsVolumeStatus">ThunarVfsVolumeStatus</link> thunar_vfs_volume_get_status      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
248
 
<para>
249
 
Determines the current status of the <parameter>volume</parameter>, e.g. whether
250
 
or not the <parameter>volume</parameter> is currently mounted, or whether a
251
 
medium is present.</para>
252
 
<para>
253
 
 
254
 
</para><variablelist role="params">
255
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
256
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
257
 
</simpara></listitem></varlistentry>
258
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the status for <parameter>volume</parameter>.
259
 
</simpara></listitem></varlistentry>
260
 
</variablelist></refsect2>
261
 
<refsect2 id="thunar-vfs-volume-get-mount-point" role="function">
262
 
<title>thunar_vfs_volume_get_mount_point ()</title>
263
 
<indexterm zone="thunar-vfs-volume-get-mount-point"><primary>thunar_vfs_volume_get_mount_point</primary></indexterm><programlisting><link linkend="ThunarVfsPath">ThunarVfsPath</link>*      thunar_vfs_volume_get_mount_point   (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
264
 
<para>
265
 
Determines the current mount point for <parameter>volume</parameter>. If <parameter>volume</parameter>
266
 
is mounted this will be the location at which it is currently
267
 
mounted. Else it will be the location where <parameter>volume</parameter> is most
268
 
probably being mounted. Note that this location may change
269
 
during a call to <link linkend="thunar-vfs-volume-mount"><function>thunar_vfs_volume_mount()</function></link>, so be sure to
270
 
check the mount point after the call to <link linkend="thunar-vfs-volume-mount"><function>thunar_vfs_volume_mount()</function></link>.</para>
271
 
<para>
272
 
 
273
 
</para><variablelist role="params">
274
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
275
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
276
 
</simpara></listitem></varlistentry>
277
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the path which identifies the path where
278
 
              the volume will be mounted (or is already
279
 
              mounted).
280
 
</simpara></listitem></varlistentry>
281
 
</variablelist></refsect2>
282
 
<refsect2 id="thunar-vfs-volume-is-mounted" role="function">
283
 
<title>thunar_vfs_volume_is_mounted ()</title>
284
 
<indexterm zone="thunar-vfs-volume-is-mounted"><primary>thunar_vfs_volume_is_mounted</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            thunar_vfs_volume_is_mounted        (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
285
 
<para>
286
 
Determines whether <parameter>volume</parameter> is currently mounted into the
287
 
filesystem hierarchy.</para>
288
 
<para>
289
 
 
290
 
</para><variablelist role="params">
291
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
292
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
293
 
</simpara></listitem></varlistentry>
294
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>volume</parameter> is mounted, else <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
295
 
</simpara></listitem></varlistentry>
296
 
</variablelist></refsect2>
297
 
<refsect2 id="thunar-vfs-volume-is-present" role="function">
298
 
<title>thunar_vfs_volume_is_present ()</title>
299
 
<indexterm zone="thunar-vfs-volume-is-present"><primary>thunar_vfs_volume_is_present</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            thunar_vfs_volume_is_present        (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
300
 
<para>
301
 
Determines whether a medium is currently inserted for
302
 
<parameter>volume</parameter>, e.g. for a CD-ROM drive, this will be <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
303
 
only if a disc is present in the slot.</para>
304
 
<para>
305
 
 
306
 
</para><variablelist role="params">
307
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
308
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
309
 
</simpara></listitem></varlistentry>
310
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>volume</parameter> is present, else <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
311
 
</simpara></listitem></varlistentry>
312
 
</variablelist></refsect2>
313
 
<refsect2 id="thunar-vfs-volume-is-ejectable" role="function">
314
 
<title>thunar_vfs_volume_is_ejectable ()</title>
315
 
<indexterm zone="thunar-vfs-volume-is-ejectable"><primary>thunar_vfs_volume_is_ejectable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            thunar_vfs_volume_is_ejectable      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
316
 
<para>
317
 
Determines whether the current user is allowed to eject the medium
318
 
for <parameter>volume</parameter>. This method should return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> only if a medium is
319
 
present and the <parameter>volume</parameter> is removable. Still, there's no warranty
320
 
that a call to <link linkend="thunar-vfs-volume-eject"><function>thunar_vfs_volume_eject()</function></link> will succeed.</para>
321
 
<para>
322
 
 
323
 
</para><variablelist role="params">
324
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
325
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
326
 
</simpara></listitem></varlistentry>
327
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> whether the medium for <parameter>volume</parameter> can be ejected.
328
 
</simpara></listitem></varlistentry>
329
 
</variablelist></refsect2>
330
 
<refsect2 id="thunar-vfs-volume-is-removable" role="function">
331
 
<title>thunar_vfs_volume_is_removable ()</title>
332
 
<indexterm zone="thunar-vfs-volume-is-removable"><primary>thunar_vfs_volume_is_removable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            thunar_vfs_volume_is_removable      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume);</programlisting>
333
 
<para>
334
 
Determines whether <parameter>volume</parameter> is a removable device, for example
335
 
a CD-ROM, an USB stick or a floppy drive.</para>
336
 
<para>
337
 
 
338
 
</para><variablelist role="params">
339
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
340
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
341
 
</simpara></listitem></varlistentry>
342
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>volume</parameter> is a removable device, else <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
343
 
</simpara></listitem></varlistentry>
344
 
</variablelist></refsect2>
345
 
<refsect2 id="thunar-vfs-volume-lookup-icon-name" role="function">
346
 
<title>thunar_vfs_volume_lookup_icon_name ()</title>
347
 
<indexterm zone="thunar-vfs-volume-lookup-icon-name"><primary>thunar_vfs_volume_lookup_icon_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        thunar_vfs_volume_lookup_icon_name  (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
348
 
                                                         <link linkend="GtkIconTheme">GtkIconTheme</link> *icon_theme);</programlisting>
349
 
<para>
350
 
Tries to find a suitable icon for <parameter>volume</parameter> in the given <parameter>icon_theme</parameter> and
351
 
returns its name. If no suitable icon is found in <parameter>icon_theme</parameter>, then
352
 
a fallback icon name will be returned. This way you can always count
353
 
on this method to return a valid string.</para>
354
 
<para>
355
 
 
356
 
</para><variablelist role="params">
357
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
358
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
359
 
</simpara></listitem></varlistentry>
360
 
<varlistentry><term><parameter>icon_theme</parameter>&nbsp;:</term>
361
 
<listitem><simpara> a <link linkend="GtkIconTheme"><type>GtkIconTheme</type></link> instance.
362
 
</simpara></listitem></varlistentry>
363
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the icon name.
364
 
</simpara></listitem></varlistentry>
365
 
</variablelist></refsect2>
366
 
<refsect2 id="thunar-vfs-volume-eject" role="function">
367
 
<title>thunar_vfs_volume_eject ()</title>
368
 
<indexterm zone="thunar-vfs-volume-eject"><primary>thunar_vfs_volume_eject</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            thunar_vfs_volume_eject             (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
369
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *window,
370
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
371
 
<para>
372
 
Tries to eject the medium present for <parameter>volume</parameter> (or atleast to
373
 
unmount the <parameter>volume</parameter>).
374
 
</para>
375
 
<para>
376
 
If ejecting <parameter>volume</parameter> requires some complex user interaction
377
 
(basicly everything else than displaying an error dialog), it
378
 
should popup a modal dialog on <parameter>window</parameter> (or on the default
379
 
<link linkend="GdkScreen"><type>GdkScreen</type></link> if <parameter>window</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>). But be aware, that if an
380
 
implementation of <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> performs user interaction
381
 
during a call to this method, it must implement this method
382
 
in a reentrant fashion!</para>
383
 
<para>
384
 
 
385
 
</para><variablelist role="params">
386
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
387
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
388
 
</simpara></listitem></varlistentry>
389
 
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
390
 
<listitem><simpara> a <link linkend="GtkWindow"><type>GtkWindow</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
391
 
</simpara></listitem></varlistentry>
392
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
393
 
<listitem><simpara> return location for errors or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
394
 
</simpara></listitem></varlistentry>
395
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the medium for <parameter>volume</parameter> was successfully
396
 
              ejected (or atleast the <parameter>volume</parameter> was unmounted
397
 
              successfully), else <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
398
 
</simpara></listitem></varlistentry>
399
 
</variablelist></refsect2>
400
 
<refsect2 id="thunar-vfs-volume-mount" role="function">
401
 
<title>thunar_vfs_volume_mount ()</title>
402
 
<indexterm zone="thunar-vfs-volume-mount"><primary>thunar_vfs_volume_mount</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            thunar_vfs_volume_mount             (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
403
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *window,
404
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
405
 
<para>
406
 
Tries to mount <parameter>volume</parameter>. Will return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if either <parameter>volume</parameter>
407
 
was already mounted previously to this method invokation or
408
 
<parameter>volume</parameter> was successfully mounted now.
409
 
</para>
410
 
<para>
411
 
If mounting <parameter>volume</parameter> requires some complex user interaction
412
 
(basicly everything else than displaying an error dialog), it
413
 
should popup a modal dialog on <parameter>window</parameter> (or on the default
414
 
<link linkend="GdkScreen"><type>GdkScreen</type></link> if <parameter>window</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>). But be aware, that if an
415
 
implementation of <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> performs user interaction
416
 
during a call to this method, it must implement this method
417
 
in a reentrant fashion!</para>
418
 
<para>
419
 
 
420
 
</para><variablelist role="params">
421
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
422
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
423
 
</simpara></listitem></varlistentry>
424
 
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
425
 
<listitem><simpara> a <link linkend="GtkWindow"><type>GtkWindow</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
426
 
</simpara></listitem></varlistentry>
427
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
428
 
<listitem><simpara> return location for errors or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
429
 
</simpara></listitem></varlistentry>
430
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the medium for <parameter>volume</parameter> was successfully
431
 
              mounted or was already mounted previously, else
432
 
              <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
433
 
</simpara></listitem></varlistentry>
434
 
</variablelist></refsect2>
435
 
<refsect2 id="thunar-vfs-volume-unmount" role="function">
436
 
<title>thunar_vfs_volume_unmount ()</title>
437
 
<indexterm zone="thunar-vfs-volume-unmount"><primary>thunar_vfs_volume_unmount</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            thunar_vfs_volume_unmount           (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
438
 
                                                         <link linkend="GtkWidget">GtkWidget</link> *window,
439
 
                                                         <link linkend="GError">GError</link> **error);</programlisting>
440
 
<para>
441
 
Tries to unmount <parameter>volume</parameter>. Will return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if either <parameter>volume</parameter>
442
 
was already unmounted previously to this method invokation or
443
 
<parameter>volume</parameter> was successfully unmounted now.
444
 
</para>
445
 
<para>
446
 
If unmounting <parameter>volume</parameter> requires some complex user interaction
447
 
(basicly everything else than displaying an error dialog), it
448
 
should popup a modal dialog on <parameter>window</parameter> (or on the default
449
 
<link linkend="GdkScreen"><type>GdkScreen</type></link> if <parameter>window</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>). But be aware, that if an
450
 
implementation of <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> performs user interaction
451
 
during a call to this method, it must implement this method
452
 
in a reentrant fashion!</para>
453
 
<para>
454
 
 
455
 
</para><variablelist role="params">
456
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
457
 
<listitem><simpara> a <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
458
 
</simpara></listitem></varlistentry>
459
 
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
460
 
<listitem><simpara> a <link linkend="GtkWindow"><type>GtkWindow</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
461
 
</simpara></listitem></varlistentry>
462
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
463
 
<listitem><simpara> return location for errors or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
464
 
</simpara></listitem></varlistentry>
465
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the medium for <parameter>volume</parameter> was successfully
466
 
              unmounted or wasn't mounted previously, else
467
 
              <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
468
 
</simpara></listitem></varlistentry>
469
 
</variablelist></refsect2>
470
 
 
471
 
</refsect1>
472
 
 
473
 
<refsect1 id="ThunarVfsVolume.signal-details" role="signals">
474
 
<title role="signals.title">Signal Details</title>
475
 
<refsect2 id="ThunarVfsVolume-changed"><title>The <literal>&quot;changed&quot;</literal> signal</title>
476
 
<indexterm zone="ThunarVfsVolume-changed"><primary>ThunarVfsVolume::changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
477
 
                                                        <link linkend="gpointer">gpointer</link>         user_data)      : Run Last</programlisting>
478
 
<para>
479
 
Emitted whenever the state of <parameter>volume</parameter> changed.</para>
480
 
<para>
481
 
 
482
 
</para><variablelist role="params">
483
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
484
 
<listitem><simpara> the <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
485
 
</simpara></listitem></varlistentry>
486
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
487
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
488
 
</variablelist></refsect2><refsect2 id="ThunarVfsVolume-mounted"><title>The <literal>&quot;mounted&quot;</literal> signal</title>
489
 
<indexterm zone="ThunarVfsVolume-mounted"><primary>ThunarVfsVolume::mounted</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
490
 
                                                        <link linkend="gpointer">gpointer</link>         user_data)      : Run Last</programlisting>
491
 
<para>
492
 
Emitted by <parameter>volume</parameter> after a successfull mount
493
 
operation.</para>
494
 
<para>
495
 
 
496
 
</para><variablelist role="params">
497
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
498
 
<listitem><simpara> the <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
499
 
</simpara></listitem></varlistentry>
500
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
501
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
502
 
</variablelist></refsect2><refsect2 id="ThunarVfsVolume-pre-unmount"><title>The <literal>&quot;pre-unmount&quot;</literal> signal</title>
503
 
<indexterm zone="ThunarVfsVolume-pre-unmount"><primary>ThunarVfsVolume::pre-unmount</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
504
 
                                                        <link linkend="gpointer">gpointer</link>         user_data)      : Run Last</programlisting>
505
 
<para>
506
 
Emitted by <parameter>volume</parameter> right before an attempt
507
 
is made to unmount the <parameter>volume</parameter>.</para>
508
 
<para>
509
 
 
510
 
</para><variablelist role="params">
511
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
512
 
<listitem><simpara> the <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
513
 
</simpara></listitem></varlistentry>
514
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
515
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
516
 
</variablelist></refsect2><refsect2 id="ThunarVfsVolume-unmounted"><title>The <literal>&quot;unmounted&quot;</literal> signal</title>
517
 
<indexterm zone="ThunarVfsVolume-unmounted"><primary>ThunarVfsVolume::unmounted</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ThunarVfsVolume">ThunarVfsVolume</link> *volume,
518
 
                                                        <link linkend="gpointer">gpointer</link>         user_data)      : Run Last</programlisting>
519
 
<para>
520
 
Emitted by <parameter>volume</parameter> right after the <parameter>volume</parameter>
521
 
was successfully unmounted.</para>
522
 
<para>
523
 
 
524
 
</para><variablelist role="params">
525
 
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
526
 
<listitem><simpara> the <link linkend="ThunarVfsVolume"><type>ThunarVfsVolume</type></link> instance.
527
 
</simpara></listitem></varlistentry>
528
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
529
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
530
 
</variablelist></refsect2>
531
 
</refsect1>
532
 
 
533
 
 
534
 
 
535
 
</refentry>