← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gvolumemonitor.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-09 11:28:22 UTC
  • mfrom: (3.4.8 experimental)
  • Revision ID: james.westby@ubuntu.com-20100309112822-j4n0v3xbtsup8s97
Tags: 2.23.5-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler
* debian/rules:
  - don't break build on test suite errors, debian recently activated this but
    the build breaks even when there is no error in the testsuite

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gvolumemonitor.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 
5
<!ENTITY version SYSTEM "version.xml">
 
6
]>
 
7
<refentry id="GVolumeMonitor">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="GVolumeMonitor.top_of_page">GVolumeMonitor</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>GIO Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>GVolumeMonitor</refname>
 
16
<refpurpose>Volume Monitor</refpurpose>
 
17
</refnamediv>
 
18
 
 
19
<refsynopsisdiv id="GVolumeMonitor.synopsis" role="synopsis">
 
20
<title role="synopsis.title">Synopsis</title>
 
21
 
 
22
<synopsis>
 
23
 
 
24
#include &lt;gio/gio.h&gt;
 
25
 
 
26
                    <link linkend="GVolumeMonitor-struct">GVolumeMonitor</link>;
 
27
#define             <link linkend="G-VOLUME-MONITOR-EXTENSION-POINT-NAME--CAPS">G_VOLUME_MONITOR_EXTENSION_POINT_NAME</link>
 
28
<link linkend="GVolumeMonitor">GVolumeMonitor</link> *    <link linkend="g-volume-monitor-get">g_volume_monitor_get</link>                (void);
 
29
<link linkend="GList">GList</link> *             <link linkend="g-volume-monitor-get-connected-drives">g_volume_monitor_get_connected_drives</link>
 
30
                                                        (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor);
 
31
<link linkend="GList">GList</link> *             <link linkend="g-volume-monitor-get-volumes">g_volume_monitor_get_volumes</link>        (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor);
 
32
<link linkend="GList">GList</link> *             <link linkend="g-volume-monitor-get-mounts">g_volume_monitor_get_mounts</link>         (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor);
 
33
<link linkend="GVolume">GVolume</link> *           <link linkend="g-volume-monitor-adopt-orphan-mount">g_volume_monitor_adopt_orphan_mount</link> (<link linkend="GMount">GMount</link> *mount);
 
34
<link linkend="GMount">GMount</link> *            <link linkend="g-volume-monitor-get-mount-for-uuid">g_volume_monitor_get_mount_for_uuid</link> (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
35
                                                         const <link linkend="char">char</link> *uuid);
 
36
<link linkend="GVolume">GVolume</link> *           <link linkend="g-volume-monitor-get-volume-for-uuid">g_volume_monitor_get_volume_for_uuid</link>
 
37
                                                        (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
38
                                                         const <link linkend="char">char</link> *uuid);
 
39
</synopsis>
 
40
</refsynopsisdiv>
 
41
 
 
42
<refsect1 id="GVolumeMonitor.object-hierarchy" role="object_hierarchy">
 
43
<title role="object_hierarchy.title">Object Hierarchy</title>
 
44
<synopsis>
 
45
  <link linkend="GObject">GObject</link>
 
46
   +----GVolumeMonitor
 
47
</synopsis>
 
48
</refsect1>
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
<refsect1 id="GVolumeMonitor.signals" role="signal_proto">
 
56
<title role="signal_proto.title">Signals</title>
 
57
<synopsis>
 
58
  &quot;<link linkend="GVolumeMonitor-drive-changed">drive-changed</link>&quot;                                  : Run Last
 
59
  &quot;<link linkend="GVolumeMonitor-drive-connected">drive-connected</link>&quot;                                : Run Last
 
60
  &quot;<link linkend="GVolumeMonitor-drive-disconnected">drive-disconnected</link>&quot;                             : Run Last
 
61
  &quot;<link linkend="GVolumeMonitor-drive-eject-button">drive-eject-button</link>&quot;                             : Run Last
 
62
  &quot;<link linkend="GVolumeMonitor-drive-stop-button">drive-stop-button</link>&quot;                              : Run Last
 
63
  &quot;<link linkend="GVolumeMonitor-mount-added">mount-added</link>&quot;                                    : Run Last
 
64
  &quot;<link linkend="GVolumeMonitor-mount-changed">mount-changed</link>&quot;                                  : Run Last
 
65
  &quot;<link linkend="GVolumeMonitor-mount-pre-unmount">mount-pre-unmount</link>&quot;                              : Run Last
 
66
  &quot;<link linkend="GVolumeMonitor-mount-removed">mount-removed</link>&quot;                                  : Run Last
 
67
  &quot;<link linkend="GVolumeMonitor-volume-added">volume-added</link>&quot;                                   : Run Last
 
68
  &quot;<link linkend="GVolumeMonitor-volume-changed">volume-changed</link>&quot;                                 : Run Last
 
69
  &quot;<link linkend="GVolumeMonitor-volume-removed">volume-removed</link>&quot;                                 : Run Last
 
70
</synopsis>
 
71
</refsect1>
 
72
 
 
73
 
 
74
<refsect1 id="GVolumeMonitor.description" role="desc">
 
75
<title role="desc.title">Description</title>
 
76
<para>
 
77
<link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link> is for listing the user interesting devices and volumes
 
78
on the computer. In other words, what a file selector or file manager
 
79
would show in a sidebar. 
 
80
</para>
 
81
<para>
 
82
<link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link> is not <link
 
83
linkend="g-main-context-push-thread-default">thread-default-context
 
84
aware</link>, and so should not be used other than from the main
 
85
thread, with no thread-default-context active.</para>
 
86
<para>
 
87
</para>
 
88
</refsect1>
 
89
 
 
90
<refsect1 id="GVolumeMonitor.details" role="details">
 
91
<title role="details.title">Details</title>
 
92
<refsect2 id="GVolumeMonitor-struct" role="struct">
 
93
<title>GVolumeMonitor</title>
 
94
<indexterm zone="GVolumeMonitor-struct"><primary sortas="VolumeMonitor">GVolumeMonitor</primary></indexterm><programlisting>typedef struct _GVolumeMonitor GVolumeMonitor;</programlisting>
 
95
<para>
 
96
A Volume Monitor that watches for volume events.</para>
 
97
<para>
 
98
</para><variablelist role="struct">
 
99
</variablelist></refsect2>
 
100
<refsect2 id="G-VOLUME-MONITOR-EXTENSION-POINT-NAME--CAPS" role="macro">
 
101
<title>G_VOLUME_MONITOR_EXTENSION_POINT_NAME</title>
 
102
<indexterm zone="G-VOLUME-MONITOR-EXTENSION-POINT-NAME--CAPS"><primary sortas="VOLUME_MONITOR_EXTENSION_POINT_NAME">G_VOLUME_MONITOR_EXTENSION_POINT_NAME</primary></indexterm><programlisting>#define G_VOLUME_MONITOR_EXTENSION_POINT_NAME "gio-volume-monitor"
 
103
</programlisting>
 
104
<para>
 
105
Extension point for volume monitor functionality.
 
106
See <link linkend="extending-gio">Extending GIO</link>.</para>
 
107
<para>
 
108
</para></refsect2>
 
109
<refsect2 id="g-volume-monitor-get" role="function">
 
110
<title>g_volume_monitor_get ()</title>
 
111
<indexterm zone="g-volume-monitor-get"><primary sortas="volume_monitor_get">g_volume_monitor_get</primary></indexterm><programlisting><link linkend="GVolumeMonitor">GVolumeMonitor</link> *    g_volume_monitor_get                (void);</programlisting>
 
112
<para>
 
113
Gets the volume monitor used by gio.</para>
 
114
<para>
 
115
</para><variablelist role="params">
 
116
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a reference to the <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link> used by gio. Call
 
117
   <link linkend="g-object-unref"><function>g_object_unref()</function></link> when done with it.
 
118
</simpara></listitem></varlistentry>
 
119
</variablelist></refsect2>
 
120
<refsect2 id="g-volume-monitor-get-connected-drives" role="function">
 
121
<title>g_volume_monitor_get_connected_drives ()</title>
 
122
<indexterm zone="g-volume-monitor-get-connected-drives"><primary sortas="volume_monitor_get_connected_drives">g_volume_monitor_get_connected_drives</primary></indexterm><programlisting><link linkend="GList">GList</link> *             g_volume_monitor_get_connected_drives
 
123
                                                        (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor);</programlisting>
 
124
<para>
 
125
Gets a list of drives connected to the system.
 
126
</para>
 
127
<para>
 
128
The returned list should be freed with <link linkend="g-list-free"><function>g_list_free()</function></link>, after
 
129
its elements have been unreffed with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.</para>
 
130
<para>
 
131
</para><variablelist role="params">
 
132
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
133
<listitem><simpara> a <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link>.
 
134
</simpara></listitem></varlistentry>
 
135
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of connected <link linkend="GDrive"><type>GDrive</type></link> objects.
 
136
</simpara></listitem></varlistentry>
 
137
</variablelist></refsect2>
 
138
<refsect2 id="g-volume-monitor-get-volumes" role="function">
 
139
<title>g_volume_monitor_get_volumes ()</title>
 
140
<indexterm zone="g-volume-monitor-get-volumes"><primary sortas="volume_monitor_get_volumes">g_volume_monitor_get_volumes</primary></indexterm><programlisting><link linkend="GList">GList</link> *             g_volume_monitor_get_volumes        (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor);</programlisting>
 
141
<para>
 
142
Gets a list of the volumes on the system.
 
143
</para>
 
144
<para>
 
145
The returned list should be freed with <link linkend="g-list-free"><function>g_list_free()</function></link>, after
 
146
its elements have been unreffed with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.</para>
 
147
<para>
 
148
</para><variablelist role="params">
 
149
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
150
<listitem><simpara> a <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link>.
 
151
</simpara></listitem></varlistentry>
 
152
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of <link linkend="GVolume"><type>GVolume</type></link> objects.
 
153
</simpara></listitem></varlistentry>
 
154
</variablelist></refsect2>
 
155
<refsect2 id="g-volume-monitor-get-mounts" role="function">
 
156
<title>g_volume_monitor_get_mounts ()</title>
 
157
<indexterm zone="g-volume-monitor-get-mounts"><primary sortas="volume_monitor_get_mounts">g_volume_monitor_get_mounts</primary></indexterm><programlisting><link linkend="GList">GList</link> *             g_volume_monitor_get_mounts         (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor);</programlisting>
 
158
<para>
 
159
Gets a list of the mounts on the system.
 
160
</para>
 
161
<para>
 
162
The returned list should be freed with <link linkend="g-list-free"><function>g_list_free()</function></link>, after
 
163
its elements have been unreffed with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.</para>
 
164
<para>
 
165
</para><variablelist role="params">
 
166
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
167
<listitem><simpara> a <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link>.
 
168
</simpara></listitem></varlistentry>
 
169
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of <link linkend="GMount"><type>GMount</type></link> objects.
 
170
</simpara></listitem></varlistentry>
 
171
</variablelist></refsect2>
 
172
<refsect2 id="g-volume-monitor-adopt-orphan-mount" role="function" condition="deprecated">
 
173
<title>g_volume_monitor_adopt_orphan_mount ()</title>
 
174
<indexterm zone="g-volume-monitor-adopt-orphan-mount" role="deprecated"><primary sortas="volume_monitor_adopt_orphan_mount">g_volume_monitor_adopt_orphan_mount</primary></indexterm><programlisting><link linkend="GVolume">GVolume</link> *           g_volume_monitor_adopt_orphan_mount (<link linkend="GMount">GMount</link> *mount);</programlisting>
 
175
<warning><para><literal>g_volume_monitor_adopt_orphan_mount</literal> has been deprecated since version 2.20 and should not be used in newly-written code. Instead of using this function, <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link>
 
176
implementations should instead create shadow mounts with the URI of
 
177
the mount they intend to adopt. See the proxy volume monitor in
 
178
gvfs for an example of this. Also see <link linkend="g-mount-is-shadowed"><function>g_mount_is_shadowed()</function></link>,
 
179
<link linkend="g-mount-shadow"><function>g_mount_shadow()</function></link> and <link linkend="g-mount-unshadow"><function>g_mount_unshadow()</function></link> functions.</para></warning>
 
180
<para>
 
181
This function should be called by any <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link>
 
182
implementation when a new <link linkend="GMount"><type>GMount</type></link> object is created that is not
 
183
associated with a <link linkend="GVolume"><type>GVolume</type></link> object. It must be called just before
 
184
emitting the <parameter>mount_added</parameter> signal.
 
185
</para>
 
186
<para>
 
187
If the return value is not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, the caller must associate the
 
188
returned <link linkend="GVolume"><type>GVolume</type></link> object with the <link linkend="GMount"><type>GMount</type></link>. This involves returning
 
189
it in its <link linkend="g-mount-get-volume"><function>g_mount_get_volume()</function></link> implementation. The caller must
 
190
also listen for the "removed" signal on the returned object
 
191
and give up its reference when handling that signal
 
192
</para>
 
193
<para>
 
194
Similary, if implementing <link linkend="g-volume-monitor-adopt-orphan-mount"><function>g_volume_monitor_adopt_orphan_mount()</function></link>,
 
195
the implementor must take a reference to <parameter>mount</parameter> and return it in
 
196
its <link linkend="g-volume-get-mount"><function>g_volume_get_mount()</function></link> implemented. Also, the implementor must
 
197
listen for the "unmounted" signal on <parameter>mount</parameter> and give up its
 
198
reference upon handling that signal.
 
199
</para>
 
200
<para>
 
201
There are two main use cases for this function.
 
202
</para>
 
203
<para>
 
204
One is when implementing a user space file system driver that reads
 
205
blocks of a block device that is already represented by the native
 
206
volume monitor (for example a CD Audio file system driver). Such
 
207
a driver will generate its own <link linkend="GMount"><type>GMount</type></link> object that needs to be
 
208
assoicated with the <link linkend="GVolume"><type>GVolume</type></link> object that represents the volume.
 
209
</para>
 
210
<para>
 
211
The other is for implementing a <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link> whose sole purpose
 
212
is to return <link linkend="GVolume"><type>GVolume</type></link> objects representing entries in the users
 
213
"favorite servers" list or similar.</para>
 
214
<para>
 
215
</para><variablelist role="params">
 
216
<varlistentry><term><parameter>mount</parameter>&#160;:</term>
 
217
<listitem><simpara> a <link linkend="GMount"><type>GMount</type></link> object to find a parent for
 
218
</simpara></listitem></varlistentry>
 
219
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="GVolume"><type>GVolume</type></link> object that is the parent for <parameter>mount</parameter> or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
 
220
if no wants to adopt the <link linkend="GMount"><type>GMount</type></link>.
 
221
 
 
222
</simpara></listitem></varlistentry>
 
223
</variablelist></refsect2>
 
224
<refsect2 id="g-volume-monitor-get-mount-for-uuid" role="function">
 
225
<title>g_volume_monitor_get_mount_for_uuid ()</title>
 
226
<indexterm zone="g-volume-monitor-get-mount-for-uuid"><primary sortas="volume_monitor_get_mount_for_uuid">g_volume_monitor_get_mount_for_uuid</primary></indexterm><programlisting><link linkend="GMount">GMount</link> *            g_volume_monitor_get_mount_for_uuid (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
227
                                                         const <link linkend="char">char</link> *uuid);</programlisting>
 
228
<para>
 
229
Finds a <link linkend="GMount"><type>GMount</type></link> object by its UUID (see <link linkend="g-mount-get-uuid"><function>g_mount_get_uuid()</function></link>)</para>
 
230
<para>
 
231
</para><variablelist role="params">
 
232
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
233
<listitem><simpara> a <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link>.
 
234
</simpara></listitem></varlistentry>
 
235
<varlistentry><term><parameter>uuid</parameter>&#160;:</term>
 
236
<listitem><simpara> the UUID to look for
 
237
</simpara></listitem></varlistentry>
 
238
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GMount"><type>GMount</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no such mount is available.
 
239
    Free the returned object with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
 
240
</simpara></listitem></varlistentry>
 
241
</variablelist></refsect2>
 
242
<refsect2 id="g-volume-monitor-get-volume-for-uuid" role="function">
 
243
<title>g_volume_monitor_get_volume_for_uuid ()</title>
 
244
<indexterm zone="g-volume-monitor-get-volume-for-uuid"><primary sortas="volume_monitor_get_volume_for_uuid">g_volume_monitor_get_volume_for_uuid</primary></indexterm><programlisting><link linkend="GVolume">GVolume</link> *           g_volume_monitor_get_volume_for_uuid
 
245
                                                        (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
246
                                                         const <link linkend="char">char</link> *uuid);</programlisting>
 
247
<para>
 
248
Finds a <link linkend="GVolume"><type>GVolume</type></link> object by its UUID (see <link linkend="g-volume-get-uuid"><function>g_volume_get_uuid()</function></link>)</para>
 
249
<para>
 
250
</para><variablelist role="params">
 
251
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
252
<listitem><simpara> a <link linkend="GVolumeMonitor"><type>GVolumeMonitor</type></link>.
 
253
</simpara></listitem></varlistentry>
 
254
<varlistentry><term><parameter>uuid</parameter>&#160;:</term>
 
255
<listitem><simpara> the UUID to look for
 
256
</simpara></listitem></varlistentry>
 
257
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GVolume"><type>GVolume</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if no such volume is available.
 
258
    Free the returned object with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
 
259
</simpara></listitem></varlistentry>
 
260
</variablelist></refsect2>
 
261
 
 
262
</refsect1>
 
263
 
 
264
<refsect1 id="GVolumeMonitor.signal-details" role="signals">
 
265
<title role="signals.title">Signal Details</title>
 
266
<refsect2 id="GVolumeMonitor-drive-changed" role="signal"><title>The <literal>&quot;drive-changed&quot;</literal> signal</title>
 
267
<indexterm zone="GVolumeMonitor-drive-changed"><primary sortas="VolumeMonitor::drive-changed">GVolumeMonitor::drive-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
268
                                                        <link linkend="GDrive">GDrive</link>         *drive,
 
269
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
270
<para>
 
271
Emitted when a drive changes.</para>
 
272
<para>
 
273
</para><variablelist role="params">
 
274
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
275
<listitem><simpara> The volume monitor emitting the signal.
 
276
</simpara></listitem></varlistentry>
 
277
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
278
<listitem><simpara> the drive that changed
 
279
</simpara></listitem></varlistentry>
 
280
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
281
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
282
</variablelist></refsect2><refsect2 id="GVolumeMonitor-drive-connected" role="signal"><title>The <literal>&quot;drive-connected&quot;</literal> signal</title>
 
283
<indexterm zone="GVolumeMonitor-drive-connected"><primary sortas="VolumeMonitor::drive-connected">GVolumeMonitor::drive-connected</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
284
                                                        <link linkend="GDrive">GDrive</link>         *drive,
 
285
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
286
<para>
 
287
Emitted when a drive is connected to the system.</para>
 
288
<para>
 
289
</para><variablelist role="params">
 
290
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
291
<listitem><simpara> The volume monitor emitting the signal.
 
292
</simpara></listitem></varlistentry>
 
293
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
294
<listitem><simpara> a <link linkend="GDrive"><type>GDrive</type></link> that was connected.
 
295
</simpara></listitem></varlistentry>
 
296
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
297
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
298
</variablelist></refsect2><refsect2 id="GVolumeMonitor-drive-disconnected" role="signal"><title>The <literal>&quot;drive-disconnected&quot;</literal> signal</title>
 
299
<indexterm zone="GVolumeMonitor-drive-disconnected"><primary sortas="VolumeMonitor::drive-disconnected">GVolumeMonitor::drive-disconnected</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
300
                                                        <link linkend="GDrive">GDrive</link>         *drive,
 
301
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
302
<para>
 
303
Emitted when a drive is disconnected from the system.</para>
 
304
<para>
 
305
</para><variablelist role="params">
 
306
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
307
<listitem><simpara> The volume monitor emitting the signal.
 
308
</simpara></listitem></varlistentry>
 
309
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
310
<listitem><simpara> a <link linkend="GDrive"><type>GDrive</type></link> that was disconnected.
 
311
</simpara></listitem></varlistentry>
 
312
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
313
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
314
</variablelist></refsect2><refsect2 id="GVolumeMonitor-drive-eject-button" role="signal"><title>The <literal>&quot;drive-eject-button&quot;</literal> signal</title>
 
315
<indexterm zone="GVolumeMonitor-drive-eject-button" role="2.18"><primary sortas="VolumeMonitor::drive-eject-button">GVolumeMonitor::drive-eject-button</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
316
                                                        <link linkend="GDrive">GDrive</link>         *drive,
 
317
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
318
<para>
 
319
Emitted when the eject button is pressed on <parameter>drive</parameter>.</para>
 
320
<para>
 
321
</para><variablelist role="params">
 
322
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
323
<listitem><simpara> The volume monitor emitting the signal.
 
324
</simpara></listitem></varlistentry>
 
325
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
326
<listitem><simpara> the drive where the eject button was pressed
 
327
</simpara></listitem></varlistentry>
 
328
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
329
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
330
</variablelist><para>Since 2.18</para></refsect2><refsect2 id="GVolumeMonitor-drive-stop-button" role="signal"><title>The <literal>&quot;drive-stop-button&quot;</literal> signal</title>
 
331
<indexterm zone="GVolumeMonitor-drive-stop-button" role="2.22"><primary sortas="VolumeMonitor::drive-stop-button">GVolumeMonitor::drive-stop-button</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
332
                                                        <link linkend="GDrive">GDrive</link>         *drive,
 
333
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
334
<para>
 
335
Emitted when the stop button is pressed on <parameter>drive</parameter>.</para>
 
336
<para>
 
337
</para><variablelist role="params">
 
338
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
339
<listitem><simpara> The volume monitor emitting the signal.
 
340
</simpara></listitem></varlistentry>
 
341
<varlistentry><term><parameter>drive</parameter>&#160;:</term>
 
342
<listitem><simpara> the drive where the stop button was pressed
 
343
</simpara></listitem></varlistentry>
 
344
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
345
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
346
</variablelist><para>Since 2.22</para></refsect2><refsect2 id="GVolumeMonitor-mount-added" role="signal"><title>The <literal>&quot;mount-added&quot;</literal> signal</title>
 
347
<indexterm zone="GVolumeMonitor-mount-added"><primary sortas="VolumeMonitor::mount-added">GVolumeMonitor::mount-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
348
                                                        <link linkend="GMount">GMount</link>         *mount,
 
349
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
350
<para>
 
351
Emitted when a mount is added.</para>
 
352
<para>
 
353
</para><variablelist role="params">
 
354
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
355
<listitem><simpara> The volume monitor emitting the signal.
 
356
</simpara></listitem></varlistentry>
 
357
<varlistentry><term><parameter>mount</parameter>&#160;:</term>
 
358
<listitem><simpara> a <link linkend="GMount"><type>GMount</type></link> that was added.
 
359
</simpara></listitem></varlistentry>
 
360
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
361
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
362
</variablelist></refsect2><refsect2 id="GVolumeMonitor-mount-changed" role="signal"><title>The <literal>&quot;mount-changed&quot;</literal> signal</title>
 
363
<indexterm zone="GVolumeMonitor-mount-changed"><primary sortas="VolumeMonitor::mount-changed">GVolumeMonitor::mount-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
364
                                                        <link linkend="GMount">GMount</link>         *mount,
 
365
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
366
<para>
 
367
Emitted when a mount changes.</para>
 
368
<para>
 
369
</para><variablelist role="params">
 
370
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
371
<listitem><simpara> The volume monitor emitting the signal.
 
372
</simpara></listitem></varlistentry>
 
373
<varlistentry><term><parameter>mount</parameter>&#160;:</term>
 
374
<listitem><simpara> a <link linkend="GMount"><type>GMount</type></link> that changed.
 
375
</simpara></listitem></varlistentry>
 
376
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
377
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
378
</variablelist></refsect2><refsect2 id="GVolumeMonitor-mount-pre-unmount" role="signal"><title>The <literal>&quot;mount-pre-unmount&quot;</literal> signal</title>
 
379
<indexterm zone="GVolumeMonitor-mount-pre-unmount"><primary sortas="VolumeMonitor::mount-pre-unmount">GVolumeMonitor::mount-pre-unmount</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
380
                                                        <link linkend="GMount">GMount</link>         *mount,
 
381
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
382
<para>
 
383
Emitted when a mount is about to be removed.</para>
 
384
<para>
 
385
</para><variablelist role="params">
 
386
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
387
<listitem><simpara> The volume monitor emitting the signal.
 
388
</simpara></listitem></varlistentry>
 
389
<varlistentry><term><parameter>mount</parameter>&#160;:</term>
 
390
<listitem><simpara> a <link linkend="GMount"><type>GMount</type></link> that is being unmounted.
 
391
</simpara></listitem></varlistentry>
 
392
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
393
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
394
</variablelist></refsect2><refsect2 id="GVolumeMonitor-mount-removed" role="signal"><title>The <literal>&quot;mount-removed&quot;</literal> signal</title>
 
395
<indexterm zone="GVolumeMonitor-mount-removed"><primary sortas="VolumeMonitor::mount-removed">GVolumeMonitor::mount-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
396
                                                        <link linkend="GMount">GMount</link>         *mount,
 
397
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
398
<para>
 
399
Emitted when a mount is removed.</para>
 
400
<para>
 
401
</para><variablelist role="params">
 
402
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
403
<listitem><simpara> The volume monitor emitting the signal.
 
404
</simpara></listitem></varlistentry>
 
405
<varlistentry><term><parameter>mount</parameter>&#160;:</term>
 
406
<listitem><simpara> a <link linkend="GMount"><type>GMount</type></link> that was removed.
 
407
</simpara></listitem></varlistentry>
 
408
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
409
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
410
</variablelist></refsect2><refsect2 id="GVolumeMonitor-volume-added" role="signal"><title>The <literal>&quot;volume-added&quot;</literal> signal</title>
 
411
<indexterm zone="GVolumeMonitor-volume-added"><primary sortas="VolumeMonitor::volume-added">GVolumeMonitor::volume-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
412
                                                        <link linkend="GVolume">GVolume</link>        *volume,
 
413
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
414
<para>
 
415
Emitted when a mountable volume is added to the system.</para>
 
416
<para>
 
417
</para><variablelist role="params">
 
418
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
419
<listitem><simpara> The volume monitor emitting the signal.
 
420
</simpara></listitem></varlistentry>
 
421
<varlistentry><term><parameter>volume</parameter>&#160;:</term>
 
422
<listitem><simpara> a <link linkend="GVolume"><type>GVolume</type></link> that was added.
 
423
</simpara></listitem></varlistentry>
 
424
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
425
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
426
</variablelist></refsect2><refsect2 id="GVolumeMonitor-volume-changed" role="signal"><title>The <literal>&quot;volume-changed&quot;</literal> signal</title>
 
427
<indexterm zone="GVolumeMonitor-volume-changed"><primary sortas="VolumeMonitor::volume-changed">GVolumeMonitor::volume-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
428
                                                        <link linkend="GVolume">GVolume</link>        *volume,
 
429
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
430
<para>
 
431
Emitted when mountable volume is changed.</para>
 
432
<para>
 
433
</para><variablelist role="params">
 
434
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
435
<listitem><simpara> The volume monitor emitting the signal.
 
436
</simpara></listitem></varlistentry>
 
437
<varlistentry><term><parameter>volume</parameter>&#160;:</term>
 
438
<listitem><simpara> a <link linkend="GVolume"><type>GVolume</type></link> that changed.
 
439
</simpara></listitem></varlistentry>
 
440
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
441
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
442
</variablelist></refsect2><refsect2 id="GVolumeMonitor-volume-removed" role="signal"><title>The <literal>&quot;volume-removed&quot;</literal> signal</title>
 
443
<indexterm zone="GVolumeMonitor-volume-removed"><primary sortas="VolumeMonitor::volume-removed">GVolumeMonitor::volume-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GVolumeMonitor">GVolumeMonitor</link> *volume_monitor,
 
444
                                                        <link linkend="GVolume">GVolume</link>        *volume,
 
445
                                                        <link linkend="gpointer">gpointer</link>        user_data)           : Run Last</programlisting>
 
446
<para>
 
447
Emitted when a mountable volume is removed from the system.</para>
 
448
<para>
 
449
</para><variablelist role="params">
 
450
<varlistentry><term><parameter>volume_monitor</parameter>&#160;:</term>
 
451
<listitem><simpara> The volume monitor emitting the signal.
 
452
</simpara></listitem></varlistentry>
 
453
<varlistentry><term><parameter>volume</parameter>&#160;:</term>
 
454
<listitem><simpara> a <link linkend="GVolume"><type>GVolume</type></link> that was removed.
 
455
</simpara></listitem></varlistentry>
 
456
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
457
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
458
</variablelist></refsect2>
 
459
</refsect1>
 
460
 
 
461
 
 
462
<refsect1 id="GVolumeMonitor.see-also">
 
463
<title>See Also</title>
 
464
#GFileMonitor
 
465
</refsect1>
 
466
 
 
467
</refentry>