docs/reference/pygio-volumemonitor.xml

   1 <?xml version="1.0" standalone="no"?>
   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
   5 <refentry id="class-giovolumemonitor">
   6     <refnamediv>
   7         <refname>gio.VolumeMonitor</refname>
   8         <refpurpose>Volume Monitor.</refpurpose>
   9     </refnamediv>
  10
  11     <refsect1>
  12         <title>Synopsis</title>
  13
  14     <classsynopsis language="python">
  15         <ooclass><classname>gio.VolumeMonitor</classname></ooclass>
  16         <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
  17
  18     <methodsynopsis language="python">
  19         <methodname><link linkend="method-giovolumemonitor--get-connected-drives">get_connected_drives</link></methodname>
  20         <methodparam></methodparam>
  21     </methodsynopsis>
  22     <methodsynopsis language="python">
  23         <methodname><link linkend="method-giovolumemonitor--get-mount-for-uuid">get_mount_for_uuid</link></methodname>
  24         <methodparam><parameter role="keyword">uuid</parameter></methodparam>
  25     </methodsynopsis>
  26     <methodsynopsis language="python">
  27         <methodname><link linkend="method-giovolumemonitor--get-mounts">get_mounts</link></methodname>
  28         <methodparam></methodparam>
  29     </methodsynopsis>
  30     <methodsynopsis language="python">
  31         <methodname><link linkend="method-giovolumemonitor--get-volume-for-uuid">get_volume_for_uuid</link></methodname>
  32         <methodparam><parameter role="keyword">uuid</parameter></methodparam>
  33     </methodsynopsis>
  34     <methodsynopsis language="python">
  35         <methodname><link linkend="method-giovolumemonitor--get-volumes">get_volumes</link></methodname>
  36         <methodparam></methodparam>
  37     </methodsynopsis>
  38
  39     </classsynopsis>
  40
  41 <programlisting>
  42 <emphasis role="bold">Functions</emphasis>
  43 <methodsynopsis language="python">
  44     <methodname><link linkend="function-gio--volume-monitor-adopt-orphan-mount">gio.volume_monitor_adopt_orphan_mount</link></methodname>
  45     <methodparam></methodparam>
  46 </methodsynopsis><methodsynopsis language="python">
  47     <methodname><link linkend="function-gio--volume-monitor-get">gio.volume_monitor_get</link></methodname>
  48     <methodparam></methodparam>
  49 </methodsynopsis></programlisting>
  50
  51     </refsect1>
  52
  53     <refsect1>
  54         <title>Ancestry</title>
  55
  56 <synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  57   +-- <link linkend="class-giovolumemonitor">gio.VolumeMonitor</link>
  58 </synopsis>
  59
  60     </refsect1>
  61
  62     <refsect1 id="signal-prototypes-giovolumemonitor">
  63         <title>gio.VolumeMonitor Signal Prototypes</title>
  64
  65         <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
  66
  67         <variablelist>
  68             <varlistentry>
  69                 <term><link linkend="signal-giovolumemonitor--drive-changed">"drive-changed"</link></term>
  70                 <listitem>
  71                     <methodsynopsis language="python"><methodname>callback</methodname>
  72                         <methodparam><parameter>volume_monitor</parameter></methodparam>
  73                         <methodparam><parameter>drive</parameter></methodparam>
  74                         <methodparam><parameter>user_param1</parameter></methodparam>
  75                         <methodparam><parameter>...</parameter></methodparam>
  76                     </methodsynopsis>
  77                 </listitem>
  78             </varlistentry>
  79             <varlistentry>
  80                 <term><link linkend="signal-giovolumemonitor--drive-connected">"drive-connected"</link></term>
  81                 <listitem>
  82                     <methodsynopsis language="python"><methodname>callback</methodname>
  83                         <methodparam><parameter>volume_monitor</parameter></methodparam>
  84                         <methodparam><parameter>drive</parameter></methodparam>
  85                         <methodparam><parameter>user_param1</parameter></methodparam>
  86                         <methodparam><parameter>...</parameter></methodparam>
  87                     </methodsynopsis>
  88                 </listitem>
  89             </varlistentry>
  90             <varlistentry>
  91                 <term><link linkend="signal-giovolumemonitor--drive-disconnected">"drive-disconnected"</link></term>
  92                 <listitem>
  93                     <methodsynopsis language="python"><methodname>callback</methodname>
  94                         <methodparam><parameter>volume_monitor</parameter></methodparam>
  95                         <methodparam><parameter>drive</parameter></methodparam>
  96                         <methodparam><parameter>user_param1</parameter></methodparam>
  97                         <methodparam><parameter>...</parameter></methodparam>
  98                     </methodsynopsis>
  99                 </listitem>
 100             </varlistentry>
 101             <varlistentry>
 102                 <term><link linkend="signal-giovolumemonitor--drive-eject-button">"drive-eject-button"</link></term>
 103                 <listitem>
 104                     <methodsynopsis language="python"><methodname>callback</methodname>
 105                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 106                         <methodparam><parameter>drive</parameter></methodparam>
 107                         <methodparam><parameter>user_param1</parameter></methodparam>
 108                         <methodparam><parameter>...</parameter></methodparam>
 109                     </methodsynopsis>
 110                 </listitem>
 111             </varlistentry>
 112             <varlistentry>
 113                 <term><link linkend="signal-giovolumemonitor--mount-added">"mount-added"</link></term>
 114                 <listitem>
 115                     <methodsynopsis language="python"><methodname>callback</methodname>
 116                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 117                         <methodparam><parameter>mount</parameter></methodparam>
 118                         <methodparam><parameter>user_param1</parameter></methodparam>
 119                         <methodparam><parameter>...</parameter></methodparam>
 120                     </methodsynopsis>
 121                 </listitem>
 122             </varlistentry>
 123             <varlistentry>
 124                 <term><link linkend="signal-giovolumemonitor--mount-changed">"mount-changed"</link></term>
 125                 <listitem>
 126                     <methodsynopsis language="python"><methodname>callback</methodname>
 127                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 128                         <methodparam><parameter>mount</parameter></methodparam>
 129                         <methodparam><parameter>user_param1</parameter></methodparam>
 130                         <methodparam><parameter>...</parameter></methodparam>
 131                     </methodsynopsis>
 132                 </listitem>
 133             </varlistentry>
 134             <varlistentry>
 135                 <term><link linkend="signal-giovolumemonitor--mount-pre-unmount">"mount-pre-unmount"</link></term>
 136                 <listitem>
 137                     <methodsynopsis language="python"><methodname>callback</methodname>
 138                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 139                         <methodparam><parameter>mount</parameter></methodparam>
 140                         <methodparam><parameter>user_param1</parameter></methodparam>
 141                         <methodparam><parameter>...</parameter></methodparam>
 142                     </methodsynopsis>
 143                 </listitem>
 144             </varlistentry>
 145             <varlistentry>
 146                 <term><link linkend="signal-giovolumemonitor--mount-removed">"mount-removed"</link></term>
 147                 <listitem>
 148                     <methodsynopsis language="python"><methodname>callback</methodname>
 149                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 150                         <methodparam><parameter>mount</parameter></methodparam>
 151                         <methodparam><parameter>user_param1</parameter></methodparam>
 152                         <methodparam><parameter>...</parameter></methodparam>
 153                     </methodsynopsis>
 154                 </listitem>
 155             </varlistentry>
 156             <varlistentry>
 157                 <term><link linkend="signal-giovolumemonitor--volume-added">"volume-added"</link></term>
 158                 <listitem>
 159                     <methodsynopsis language="python"><methodname>callback</methodname>
 160                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 161                         <methodparam><parameter>volume</parameter></methodparam>
 162                         <methodparam><parameter>user_param1</parameter></methodparam>
 163                         <methodparam><parameter>...</parameter></methodparam>
 164                     </methodsynopsis>
 165                 </listitem>
 166             </varlistentry>
 167             <varlistentry>
 168                 <term><link linkend="signal-giovolumemonitor--volume-changed">"volume-changed"</link></term>
 169                 <listitem>
 170                     <methodsynopsis language="python"><methodname>callback</methodname>
 171                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 172                         <methodparam><parameter>volume</parameter></methodparam>
 173                         <methodparam><parameter>user_param1</parameter></methodparam>
 174                         <methodparam><parameter>...</parameter></methodparam>
 175                     </methodsynopsis>
 176                 </listitem>
 177             </varlistentry>
 178             <varlistentry>
 179                 <term><link linkend="signal-giovolumemonitor--volume-removed">"volume-removed"</link></term>
 180                 <listitem>
 181                     <methodsynopsis language="python"><methodname>callback</methodname>
 182                         <methodparam><parameter>volume_monitor</parameter></methodparam>
 183                         <methodparam><parameter>volume</parameter></methodparam>
 184                         <methodparam><parameter>user_param1</parameter></methodparam>
 185                         <methodparam><parameter>...</parameter></methodparam>
 186                     </methodsynopsis>
 187                 </listitem>
 188             </varlistentry>
 189         </variablelist>
 190     </refsect1>
 191
 192     <refsect1>
 193         <title>Description</title>
 194
 195         <para>
 196             The <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
 197             is for listing the user interesting devices and volumes on the computer. In other words,
 198             what a file selector or file manager would show in a sidebar.
 199         </para>
 200     </refsect1>
 201
 202     <refsect1>
 203         <title>Methods</title>
 204
 205         <refsect2 id="method-giovolumemonitor--get-connected-drives">
 206             <title>gio.VolumeMonitor.get_connected_drives</title>
 207
 208             <programlisting><methodsynopsis language="python">
 209                 <methodname>get_connected_drives</methodname>
 210                 <methodparam></methodparam>
 211             </methodsynopsis></programlisting>
 212
 213             <variablelist>
 214                 <varlistentry>
 215                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 216                     <listitem><simpara>a list of connected
 217                     <link linkend="class-giodrive"><classname>gio.Drive</classname></link> objects.
 218                     </simpara></listitem>
 219                 </varlistentry>
 220             </variablelist>
 221
 222             <para>
 223                 The <methodname>get_connected_drives</methodname>() method gets a list
 224                 of drives connected to the system.
 225             </para>
 226         </refsect2>
 227
 228         <refsect2 id="method-giovolumemonitor--get-mount-for-uuid">
 229             <title>gio.VolumeMonitor.get_mount_for_uuid</title>
 230
 231             <programlisting><methodsynopsis language="python">
 232                 <methodname>get_mount_for_uuid</methodname>
 233                 <methodparam><parameter role="keyword">uuid</parameter></methodparam>
 234             </methodsynopsis></programlisting>
 235
 236             <variablelist>
 237                 <varlistentry>
 238                   <term><parameter role="keyword">uuid</parameter>&nbsp;:</term>
 239                   <listitem><simpara>The UUID to look for.
 240                   </simpara></listitem>
 241                 </varlistentry>
 242                 <varlistentry>
 243                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 244                     <listitem><simpara>A
 245                     <link linkend="class-giomount"><classname>gio.Mount</classname></link>
 246                     or <literal>None</literal> if no such mount is available.
 247                     </simpara></listitem>
 248                 </varlistentry>
 249             </variablelist>
 250
 251             <para>
 252                 The <methodname>get_mount_for_uuid</methodname>() method finds a
 253                 <link linkend="class-giomount"><classname>gio.Mount</classname></link>
 254                 object by it's UUID (see
 255                 <methodname><link linkend="method-giomount--get-uuid">gio.Mount.get_uuid</link></methodname>())
 256             </para>
 257         </refsect2>
 258
 259         <refsect2 id="method-giovolumemonitor--get-mounts">
 260             <title>gio.VolumeMonitor.get_mounts</title>
 261
 262             <programlisting><methodsynopsis language="python">
 263                 <methodname>get_mounts</methodname>
 264                 <methodparam></methodparam>
 265             </methodsynopsis></programlisting>
 266
 267             <variablelist>
 268                 <varlistentry>
 269                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 270                     <listitem><simpara>A list of
 271                     <link linkend="class-giomount"><classname>gio.Mount</classname></link>
 272                     objects.
 273                     </simpara></listitem>
 274                 </varlistentry>
 275             </variablelist>
 276
 277             <para>
 278                 The <methodname>get_mounts</methodname>() method gets a list of the mounts on the system.
 279             </para>
 280         </refsect2>
 281
 282         <refsect2 id="method-giovolumemonitor--get-volume-for-uuid">
 283             <title>gio.VolumeMonitor.get_volume_for_uuid</title>
 284
 285             <programlisting><methodsynopsis language="python">
 286                 <methodname>get_volume_for_uuid</methodname>
 287                 <methodparam><parameter role="keyword">uuid</parameter></methodparam>
 288             </methodsynopsis></programlisting>
 289
 290             <variablelist>
 291                 <varlistentry>
 292                   <term><parameter role="keyword">uuid</parameter>&nbsp;:</term>
 293                   <listitem><simpara>The UUID to look for.
 294                   </simpara></listitem>
 295                 </varlistentry>
 296                 <varlistentry>
 297                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 298                     <listitem><simpara>A
 299                     <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
 300                     or <literal>None</literal> if no such volume is available.
 301                     </simpara></listitem>
 302                 </varlistentry>
 303             </variablelist>
 304
 305             <para>
 306                 The <methodname>get_mount_for_uuid</methodname>() method finds a
 307                 <link linkend="class-giomount"><classname>gio.Mount</classname></link>
 308                 object by it's UUID (see
 309                 <methodname><link linkend="method-giomount--get-uuid">gio.Mount.get_uuid</link></methodname>())
 310             </para>
 311         </refsect2>
 312
 313         <refsect2 id="method-giovolumemonitor--get-volumes">
 314             <title>gio.VolumeMonitor.get_volumes</title>
 315
 316             <programlisting><methodsynopsis language="python">
 317                 <methodname>get_volumes</methodname>
 318                 <methodparam></methodparam>
 319             </methodsynopsis></programlisting>
 320
 321             <variablelist>
 322                 <varlistentry>
 323                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 324                     <listitem><simpara>A list of
 325                     <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
 326                     objects.
 327                     </simpara></listitem>
 328                 </varlistentry>
 329             </variablelist>
 330
 331             <para>
 332                 The <methodname>get_volumes</methodname>() method gets a list of the volumes on the system.
 333             </para>
 334         </refsect2>
 335     </refsect1>
 336
 337     <refsect1>
 338         <title>Functions</title>
 339
 340         <refsect2 id="function-gio--volume-monitor-adopt-orphan-mount">
 341             <title>gio.volume_monitor_adopt_orphan_mount</title>
 342
 343             <programlisting><methodsynopsis language="python">
 344                 <methodname>volume_monitor_adopt_orphan_mount</methodname>
 345                 <methodparam></methodparam>
 346             </methodsynopsis></programlisting>
 347
 348             <variablelist>
 349                 <varlistentry>
 350                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 351                     <listitem><simpara>The <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
 352                     object that is the parent for mount or <literal>None</literal> if no wants to adopt the
 353                     <link linkend="class-giomount"><classname>gio.Mount</classname></link>.
 354                     </simpara></listitem>
 355                 </varlistentry>
 356             </variablelist>
 357
 358             <warning>
 359                 <para>This method will be deprecated starting from GIO 2.20</para>
 360             </warning>
 361
 362             <para>
 363                 The <methodname>volume_monitor_adopt_orphan_mount</methodname>() function should
 364                 be called by any <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
 365                 implementation when a new <link linkend="class-giomount"><classname>gio.Mount</classname></link>
 366                 object is created that is not associated with a
 367                 <link linkend="class-giovolume"><classname>gio.Volume</classname></link> object.
 368                 It must be called just before emitting the mount_added signal.
 369             </para>
 370             <para>
 371                 If the return value is not <literal>None</literal>, the caller must associate the returned
 372                 <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
 373                 object with the
 374                 <link linkend="class-giomount"><classname>gio.Mount</classname></link>.
 375                 This involves returning it in it's
 376                 <methodname><link linkend="method-giomount--get-volumes">gio.Mount.get_volumes</link></methodname>()
 377                 implementation. The caller must also listen for the "removed" signal on the
 378                 returned object and give up it's reference when handling that signal
 379             </para>
 380             <para>
 381                 Similary, if implementing
 382                 <methodname><link linkend="function-gio--volume-monitor-adopt-orphan-mount">gio.volume_monitor_adopt_orphan_mount</link></methodname>(),
 383                 the implementor must take a reference to mount and return it in it's
 384                 <methodname><link linkend="method-giovolume--get-mount">gio.Volume.get_mount</link></methodname>()
 385                 implemented. Also, the implementor must listen for the "unmounted" signal
 386                 on mount and give up it's reference upon handling that signal.
 387             </para>
 388             <para>
 389                 There are two main use cases for this function.
 390             </para>
 391             <para>
 392                 One is when implementing a user space file system driver that reads blocks of
 393                 a block device that is already represented by the native volume monitor
 394                 (for example a CD Audio file system driver). Such a driver will generate it's own
 395                 <link linkend="class-giomount"><classname>gio.Mount</classname></link>
 396                 object that needs to be assoicated with the
 397                 <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
 398                 object that represents the volume.
 399             </para>
 400             <para>
 401                 The other is for implementing a
 402                 <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
 403                 whose sole purpose is to return
 404                 <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
 405                 objects representing entries in the users "favorite servers" list or similar.
 406             </para>
 407         </refsect2>
 408
 409         <refsect2 id="function-gio--volume-monitor-get">
 410             <title>gio.volume_monitor_get</title>
 411
 412             <programlisting><methodsynopsis language="python">
 413                 <methodname>volume_monitor_get</methodname>
 414                 <methodparam></methodparam>
 415             </methodsynopsis></programlisting>
 416
 417             <variablelist>
 418                 <varlistentry>
 419                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 420                     <listitem><simpara>A reference to the
 421                     <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
 422                     used by gio.
 423                     </simpara></listitem>
 424                 </varlistentry>
 425             </variablelist>
 426
 427             <para>
 428                 The <methodname>volume_monitor_get</methodname>() function gets the
 429                 volume monitor used by gio.
 430             </para>
 431         </refsect2>
 432     </refsect1>
 433
 434     <refsect1>
 435         <title>Signals</title>
 436
 437         <refsect2 id="signal-giovolumemonitor--drive-changed">
 438             <title>The "drive-changed" gio.Volume Signal</title>
 439
 440             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 441                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 442                 <methodparam><parameter>drive</parameter></methodparam>
 443                 <methodparam><parameter>user_param1</parameter></methodparam>
 444                 <methodparam><parameter>...</parameter></methodparam>
 445             </methodsynopsis></programlisting>
 446
 447             <variablelist>
 448                 <varlistentry>
 449                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 450                     <listitem><simpara>the volume monitor</simpara></listitem>
 451                 </varlistentry>
 452                 <varlistentry>
 453                     <term><parameter>drive</parameter>&nbsp;:</term>
 454                     <listitem><simpara>the drive that changed</simpara></listitem>
 455                 </varlistentry>
 456                 <varlistentry>
 457                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 458                     <listitem><simpara>the first user parameter (if any) specified
 459                     with the <link
 460                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 461                     method</simpara></listitem>
 462                 </varlistentry>
 463                 <varlistentry>
 464                     <term><parameter>...</parameter>&nbsp;:</term>
 465                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 466                 </varlistentry>
 467             </variablelist>
 468
 469             <para>
 470                 Emitted when a drive changes.
 471             </para>
 472         </refsect2>
 473
 474         <refsect2 id="signal-giovolumemonitor--drive-connected">
 475             <title>The "drive-connected" gio.Volume Signal</title>
 476
 477             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 478                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 479                 <methodparam><parameter>drive</parameter></methodparam>
 480                 <methodparam><parameter>user_param1</parameter></methodparam>
 481                 <methodparam><parameter>...</parameter></methodparam>
 482             </methodsynopsis></programlisting>
 483
 484             <variablelist>
 485                 <varlistentry>
 486                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 487                     <listitem><simpara>the volume monitor</simpara></listitem>
 488                 </varlistentry>
 489                 <varlistentry>
 490                     <term><parameter>drive</parameter>&nbsp;:</term>
 491                     <listitem><simpara>the drive that was connected</simpara></listitem>
 492                 </varlistentry>
 493                 <varlistentry>
 494                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 495                     <listitem><simpara>the first user parameter (if any) specified
 496                     with the <link
 497                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 498                     method</simpara></listitem>
 499                 </varlistentry>
 500                 <varlistentry>
 501                     <term><parameter>...</parameter>&nbsp;:</term>
 502                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 503                 </varlistentry>
 504             </variablelist>
 505
 506             <para>
 507                 Emitted when a drive is connected to the system.
 508             </para>
 509         </refsect2>
 510
 511         <refsect2 id="signal-giovolumemonitor--drive-disconnected">
 512             <title>The "drive-disconnected" gio.Volume Signal</title>
 513
 514             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 515                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 516                 <methodparam><parameter>drive</parameter></methodparam>
 517                 <methodparam><parameter>user_param1</parameter></methodparam>
 518                 <methodparam><parameter>...</parameter></methodparam>
 519             </methodsynopsis></programlisting>
 520
 521             <variablelist>
 522                 <varlistentry>
 523                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 524                     <listitem><simpara>the volume monitor</simpara></listitem>
 525                 </varlistentry>
 526                 <varlistentry>
 527                     <term><parameter>drive</parameter>&nbsp;:</term>
 528                     <listitem><simpara>the drive that was disconnected</simpara></listitem>
 529                 </varlistentry>
 530                 <varlistentry>
 531                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 532                     <listitem><simpara>the first user parameter (if any) specified
 533                     with the <link
 534                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 535                     method</simpara></listitem>
 536                 </varlistentry>
 537                 <varlistentry>
 538                     <term><parameter>...</parameter>&nbsp;:</term>
 539                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 540                 </varlistentry>
 541             </variablelist>
 542
 543             <para>
 544                 Emitted when a drive is disconnected from the system.
 545             </para>
 546         </refsect2>
 547
 548         <refsect2 id="signal-giovolumemonitor--drive-eject-button">
 549             <title>The "drive-eject-button" gio.Volume Signal</title>
 550
 551             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 552                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 553                 <methodparam><parameter>drive</parameter></methodparam>
 554                 <methodparam><parameter>user_param1</parameter></methodparam>
 555                 <methodparam><parameter>...</parameter></methodparam>
 556             </methodsynopsis></programlisting>
 557
 558             <variablelist>
 559                 <varlistentry>
 560                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 561                     <listitem><simpara>the volume monitor</simpara></listitem>
 562                 </varlistentry>
 563                 <varlistentry>
 564                     <term><parameter>drive</parameter>&nbsp;:</term>
 565                     <listitem><simpara>the drive where the eject button was pressed</simpara></listitem>
 566                 </varlistentry>
 567                 <varlistentry>
 568                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 569                     <listitem><simpara>the first user parameter (if any) specified
 570                     with the <link
 571                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 572                     method</simpara></listitem>
 573                 </varlistentry>
 574                 <varlistentry>
 575                     <term><parameter>...</parameter>&nbsp;:</term>
 576                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 577                 </varlistentry>
 578             </variablelist>
 579
 580             <para>
 581                 Emitted when the eject button is pressed on drive.
 582             </para>
 583         </refsect2>
 584
 585         <refsect2 id="signal-giovolumemonitor--mount-added">
 586             <title>The "mount-added" gio.Volume Signal</title>
 587
 588             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 589                 <methodparam><parameter>volume</parameter></methodparam>
 590                 <methodparam><parameter>mount</parameter></methodparam>
 591                 <methodparam><parameter>user_param1</parameter></methodparam>
 592                 <methodparam><parameter>...</parameter></methodparam>
 593             </methodsynopsis></programlisting>
 594
 595             <variablelist>
 596                 <varlistentry>
 597                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 598                     <listitem><simpara>the volume monitor</simpara></listitem>
 599                 </varlistentry>
 600                 <varlistentry>
 601                     <term><parameter>mount</parameter>&nbsp;:</term>
 602                     <listitem><simpara>a Mount that was added.</simpara></listitem>
 603                 </varlistentry>
 604                 <varlistentry>
 605                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 606                     <listitem><simpara>the first user parameter (if any) specified
 607                     with the <link
 608                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 609                     method</simpara></listitem>
 610                 </varlistentry>
 611                 <varlistentry>
 612                     <term><parameter>...</parameter>&nbsp;:</term>
 613                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 614                 </varlistentry>
 615             </variablelist>
 616
 617             <para>
 618                 Emitted when a mount is added.
 619             </para>
 620         </refsect2>
 621
 622         <refsect2 id="signal-giovolumemonitor--mount-changed">
 623             <title>The "mount-changed" gio.Volume Signal</title>
 624
 625             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 626                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 627                 <methodparam><parameter>mount</parameter></methodparam>
 628                 <methodparam><parameter>user_param1</parameter></methodparam>
 629                 <methodparam><parameter>...</parameter></methodparam>
 630             </methodsynopsis></programlisting>
 631
 632             <variablelist>
 633                 <varlistentry>
 634                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 635                     <listitem><simpara>the volume monitor</simpara></listitem>
 636                 </varlistentry>
 637                 <varlistentry>
 638                     <term><parameter>mount</parameter>&nbsp;:</term>
 639                     <listitem><simpara>the Mount that changed.</simpara></listitem>
 640                 </varlistentry>
 641                 <varlistentry>
 642                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 643                     <listitem><simpara>the first user parameter (if any) specified
 644                     with the <link
 645                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 646                     method</simpara></listitem>
 647                 </varlistentry>
 648                 <varlistentry>
 649                     <term><parameter>...</parameter>&nbsp;:</term>
 650                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 651                 </varlistentry>
 652             </variablelist>
 653
 654             <para>
 655                 Emitted when a mount changes.
 656             </para>
 657         </refsect2>
 658
 659         <refsect2 id="signal-giovolumemonitor--mount-pre-unmount">
 660             <title>The "mount-pre-unmount" gio.Volume Signal</title>
 661
 662             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 663                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 664                 <methodparam><parameter>mount</parameter></methodparam>
 665                 <methodparam><parameter>user_param1</parameter></methodparam>
 666                 <methodparam><parameter>...</parameter></methodparam>
 667             </methodsynopsis></programlisting>
 668
 669             <variablelist>
 670                 <varlistentry>
 671                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 672                     <listitem><simpara>the volume monitor</simpara></listitem>
 673                 </varlistentry>
 674                 <varlistentry>
 675                     <term><parameter>mount</parameter>&nbsp;:</term>
 676                     <listitem><simpara>the Mount that is being unmounted.</simpara></listitem>
 677                 </varlistentry>
 678                 <varlistentry>
 679                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 680                     <listitem><simpara>the first user parameter (if any) specified
 681                     with the <link
 682                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 683                     method</simpara></listitem>
 684                 </varlistentry>
 685                 <varlistentry>
 686                     <term><parameter>...</parameter>&nbsp;:</term>
 687                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 688                 </varlistentry>
 689             </variablelist>
 690
 691             <para>
 692                 Emitted when a mount is about to be removed.
 693             </para>
 694         </refsect2>
 695
 696         <refsect2 id="signal-giovolumemonitor--mount-removed">
 697             <title>The "mount-removed" gio.Volume Signal</title>
 698
 699             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 700                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 701                 <methodparam><parameter>mount</parameter></methodparam>
 702                 <methodparam><parameter>user_param1</parameter></methodparam>
 703                 <methodparam><parameter>...</parameter></methodparam>
 704             </methodsynopsis></programlisting>
 705
 706             <variablelist>
 707                 <varlistentry>
 708                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 709                     <listitem><simpara>the volume monitor</simpara></listitem>
 710                 </varlistentry>
 711                 <varlistentry>
 712                     <term><parameter>mount</parameter>&nbsp;:</term>
 713                     <listitem><simpara>the Mount that was removed.</simpara></listitem>
 714                 </varlistentry>
 715                 <varlistentry>
 716                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 717                     <listitem><simpara>the first user parameter (if any) specified
 718                     with the <link
 719                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 720                     method</simpara></listitem>
 721                 </varlistentry>
 722                 <varlistentry>
 723                     <term><parameter>...</parameter>&nbsp;:</term>
 724                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 725                 </varlistentry>
 726             </variablelist>
 727
 728             <para>
 729                 Emitted when a mount is removed.
 730             </para>
 731         </refsect2>
 732
 733         <refsect2 id="signal-giovolumemonitor--volume-added">
 734             <title>The "volume-added" gio.Volume Signal</title>
 735
 736             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 737                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 738                 <methodparam><parameter>volume</parameter></methodparam>
 739                 <methodparam><parameter>user_param1</parameter></methodparam>
 740                 <methodparam><parameter>...</parameter></methodparam>
 741             </methodsynopsis></programlisting>
 742
 743             <variablelist>
 744                 <varlistentry>
 745                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 746                     <listitem><simpara>the volume monitor</simpara></listitem>
 747                 </varlistentry>
 748                 <varlistentry>
 749                     <term><parameter>volume</parameter>&nbsp;:</term>
 750                     <listitem><simpara>a Volume that was added.</simpara></listitem>
 751                 </varlistentry>
 752                 <varlistentry>
 753                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 754                     <listitem><simpara>the first user parameter (if any) specified
 755                     with the <link
 756                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 757                     method</simpara></listitem>
 758                 </varlistentry>
 759                 <varlistentry>
 760                     <term><parameter>...</parameter>&nbsp;:</term>
 761                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 762                 </varlistentry>
 763             </variablelist>
 764
 765             <para>
 766                 Emitted when a mountable volume is added to the system.
 767             </para>
 768         </refsect2>
 769
 770         <refsect2 id="signal-giovolumemonitor--volume-changed">
 771             <title>The "volume-changed" gio.Volume Signal</title>
 772
 773             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 774                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 775                 <methodparam><parameter>volume</parameter></methodparam>
 776                 <methodparam><parameter>user_param1</parameter></methodparam>
 777                 <methodparam><parameter>...</parameter></methodparam>
 778             </methodsynopsis></programlisting>
 779
 780             <variablelist>
 781                 <varlistentry>
 782                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 783                     <listitem><simpara>the volume monitor</simpara></listitem>
 784                 </varlistentry>
 785                 <varlistentry>
 786                     <term><parameter>volume</parameter>&nbsp;:</term>
 787                     <listitem><simpara>a Volume that changed.</simpara></listitem>
 788                 </varlistentry>
 789                 <varlistentry>
 790                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 791                     <listitem><simpara>the first user parameter (if any) specified
 792                     with the <link
 793                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 794                     method</simpara></listitem>
 795                 </varlistentry>
 796                 <varlistentry>
 797                     <term><parameter>...</parameter>&nbsp;:</term>
 798                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 799                 </varlistentry>
 800             </variablelist>
 801
 802             <para>
 803                 Emitted when mountable volume is changed.
 804             </para>
 805         </refsect2>
 806
 807         <refsect2 id="signal-giovolumemonitor--volume-removed">
 808             <title>The "volume-removed" gio.Volume Signal</title>
 809
 810             <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
 811                 <methodparam><parameter>volume_monitor</parameter></methodparam>
 812                 <methodparam><parameter>volume</parameter></methodparam>
 813                 <methodparam><parameter>user_param1</parameter></methodparam>
 814                 <methodparam><parameter>...</parameter></methodparam>
 815             </methodsynopsis></programlisting>
 816
 817             <variablelist>
 818                 <varlistentry>
 819                     <term><parameter>volume_monitor</parameter>&nbsp;:</term>
 820                     <listitem><simpara>the volume monitor</simpara></listitem>
 821                 </varlistentry>
 822                 <varlistentry>
 823                     <term><parameter>volume</parameter>&nbsp;:</term>
 824                     <listitem><simpara>a Volume that was removed.</simpara></listitem>
 825                 </varlistentry>
 826                 <varlistentry>
 827                     <term><parameter>user_param1</parameter>&nbsp;:</term>
 828                     <listitem><simpara>the first user parameter (if any) specified
 829                     with the <link
 830                     linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
 831                     method</simpara></listitem>
 832                 </varlistentry>
 833                 <varlistentry>
 834                     <term><parameter>...</parameter>&nbsp;:</term>
 835                     <listitem><simpara>additional user parameters (if any)</simpara></listitem>
 836                 </varlistentry>
 837             </variablelist>
 838
 839             <para>
 840                 Emitted when a mountable volume is removed from the system.
 841             </para>
 842         </refsect2>
 843   </refsect1>
 844 </refentry>