pygobject r1042 - in trunk/docs: . reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygobject r1042 - in trunk/docs: . reference
- Date: Sun, 29 Mar 2009 20:11:19 +0000 (UTC)
Author: gianmt
Date: Sun Mar 29 20:11:19 2009
New Revision: 1042
URL: http://svn.gnome.org/viewvc/pygobject?rev=1042&view=rev
Log:
2009-03-29 Gian Mario Tagliaretti <gianmt gnome org>
* docs/Makefile.am:
* docs/reference/pygio-classes.xml:
* docs/reference/pygio-volumemonitor.xml:
Add gio.VolumeMonitor in docs.
Added:
trunk/docs/reference/pygio-volumemonitor.xml
Modified:
trunk/docs/Makefile.am
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygio-classes.xml
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Sun Mar 29 20:11:19 2009
@@ -29,6 +29,7 @@
html/class-gioicon.html \
html/class-giosimpleasyncresult.html \
html/class-giovolume.html \
+ html/class-giovolumemonitor.html \
html/gio-constants.html \
html/gio-class-reference.html \
html/gobject-constants.html \
@@ -68,7 +69,8 @@
reference/pygio-fileenumerator.xml \
reference/pygio-fileicon.xml \
reference/pygio-simpleasyncresult.xml \
- reference/pygio-volume.xml
+ reference/pygio-volume.xml \
+ reference/pygio-volumemonitor.xml
XSL_FILES = \
xsl/common.xsl \
Modified: trunk/docs/reference/pygio-classes.xml
==============================================================================
--- trunk/docs/reference/pygio-classes.xml (original)
+++ trunk/docs/reference/pygio-classes.xml Sun Mar 29 20:11:19 2009
@@ -20,6 +20,7 @@
<xi:include href="pygio-icon.xml"/>
<xi:include href="pygio-simpleasyncresult.xml"/>
<xi:include href="pygio-volume.xml"/>
+<xi:include href="pygio-volumemonitor.xml"/>
<xi:include href="pygio-constants.xml"/>
</chapter>
Added: trunk/docs/reference/pygio-volumemonitor.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygio-volumemonitor.xml Sun Mar 29 20:11:19 2009
@@ -0,0 +1,844 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+
+<refentry id="class-giovolumemonitor">
+ <refnamediv>
+ <refname>gio.VolumeMonitor</refname>
+ <refpurpose>Volume Monitor.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.VolumeMonitor</classname></ooclass>
+ <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giovolumemonitor--get-connected-drives">get_connected_drives</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giovolumemonitor--get-mount-for-uuid">get_mount_for_uuid</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giovolumemonitor--get-mounts">get_mounts</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giovolumemonitor--get-volume-for-uuid">get_volume_for_uuid</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giovolumemonitor--get-volumes">get_volumes</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gio--volume-monitor-adopt-orphan-mount">gio.volume_monitor_adopt_orphan_mount</link></methodname>
+ <methodparam></methodparam>
+</methodsynopsis><methodsynopsis language="python">
+ <methodname><link linkend="function-gio--volume-monitor-get">gio.volume_monitor_get</link></methodname>
+ <methodparam></methodparam>
+</methodsynopsis></programlisting>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-giovolumemonitor">gio.VolumeMonitor</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1 id="signal-prototypes-giovolumemonitor">
+ <title>gio.VolumeMonitor Signal Prototypes</title>
+
+ <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
+
+ <variablelist>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--drive-changed">"drive-changed"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--drive-connected">"drive-connected"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--drive-disconnected">"drive-disconnected"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--drive-eject-button">"drive-eject-button"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--mount-added">"mount-added"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--mount-changed">"mount-changed"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--mount-pre-unmount">"mount-pre-unmount"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--mount-removed">"mount-removed"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--volume-added">"volume-added"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>volume</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--volume-changed">"volume-changed"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>volume</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><link linkend="signal-giovolumemonitor--volume-removed">"volume-removed"</link></term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>volume</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ The <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
+ is for listing the user interesting devices and volumes on the computer. In other words,
+ what a file selector or file manager would show in a sidebar.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-giovolumemonitor--get-connected-drives">
+ <title>gio.VolumeMonitor.get_connected_drives</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_connected_drives</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a list of connected
+ <link linkend="class-giodrive"><classname>gio.Drive</classname></link> objects.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_connected_drives</methodname>() method gets a list
+ of drives connected to the system.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giovolumemonitor--get-mount-for-uuid">
+ <title>gio.VolumeMonitor.get_mount_for_uuid</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_mount_for_uuid</methodname>
+ <methodparam><parameter role="keyword">uuid</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">uuid</parameter> :</term>
+ <listitem><simpara>The UUID to look for.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-giomount"><classname>gio.Mount</classname></link>
+ or <literal>None</literal> if no such mount is available.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_mount_for_uuid</methodname>() method finds a
+ <link linkend="class-giomount"><classname>gio.Mount</classname></link>
+ object by it's UUID (see
+ <methodname><link linkend="method-giomount--get-uuid">gio.Mount.get_uuid</link></methodname>())
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giovolumemonitor--get-mounts">
+ <title>gio.VolumeMonitor.get_mounts</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_mounts</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A list of
+ <link linkend="class-giomount"><classname>gio.Mount</classname></link>
+ objects.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_mounts</methodname>() method gets a list of the mounts on the system.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giovolumemonitor--get-volume-for-uuid">
+ <title>gio.VolumeMonitor.get_volume_for_uuid</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_volume_for_uuid</methodname>
+ <methodparam><parameter role="keyword">uuid</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">uuid</parameter> :</term>
+ <listitem><simpara>The UUID to look for.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
+ or <literal>None</literal> if no such volume is available.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_mount_for_uuid</methodname>() method finds a
+ <link linkend="class-giomount"><classname>gio.Mount</classname></link>
+ object by it's UUID (see
+ <methodname><link linkend="method-giomount--get-uuid">gio.Mount.get_uuid</link></methodname>())
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-giovolumemonitor--get-volumes">
+ <title>gio.VolumeMonitor.get_volumes</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_volumes</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A list of
+ <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
+ objects.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_volumes</methodname>() method gets a list of the volumes on the system.
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gio--volume-monitor-adopt-orphan-mount">
+ <title>gio.volume_monitor_adopt_orphan_mount</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>volume_monitor_adopt_orphan_mount</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
+ object that is the parent for mount or <literal>None</literal> if no wants to adopt the
+ <link linkend="class-giomount"><classname>gio.Mount</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <warning>
+ <para>This method will be deprecated starting from GIO 2.20</para>
+ </warning>
+
+ <para>
+ The <methodname>volume_monitor_adopt_orphan_mount</methodname>() function should
+ be called by any <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
+ implementation when a new <link linkend="class-giomount"><classname>gio.Mount</classname></link>
+ object is created that is not associated with a
+ <link linkend="class-giovolume"><classname>gio.Volume</classname></link> object.
+ It must be called just before emitting the mount_added signal.
+ </para>
+ <para>
+ If the return value is not <literal>None</literal>, the caller must associate the returned
+ <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
+ object with the
+ <link linkend="class-giomount"><classname>gio.Mount</classname></link>.
+ This involves returning it in it's
+ <methodname><link linkend="method-giomount--get-volumes">gio.Mount.get_volumes</link></methodname>()
+ implementation. The caller must also listen for the "removed" signal on the
+ returned object and give up it's reference when handling that signal
+ </para>
+ <para>
+ Similary, if implementing
+ <methodname><link linkend="function-gio--volume-monitor-adopt-orphan-mount">gio.volume_monitor_adopt_orphan_mount</link></methodname>(),
+ the implementor must take a reference to mount and return it in it's
+ <methodname><link linkend="method-giovolume--get-mount">gio.Volume.get_mount</link></methodname>()
+ implemented. Also, the implementor must listen for the "unmounted" signal
+ on mount and give up it's reference upon handling that signal.
+ </para>
+ <para>
+ There are two main use cases for this function.
+ </para>
+ <para>
+ One is when implementing a user space file system driver that reads blocks of
+ a block device that is already represented by the native volume monitor
+ (for example a CD Audio file system driver). Such a driver will generate it's own
+ <link linkend="class-giomount"><classname>gio.Mount</classname></link>
+ object that needs to be assoicated with the
+ <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
+ object that represents the volume.
+ </para>
+ <para>
+ The other is for implementing a
+ <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
+ whose sole purpose is to return
+ <link linkend="class-giovolume"><classname>gio.Volume</classname></link>
+ objects representing entries in the users "favorite servers" list or similar.
+ </para>
+ </refsect2>
+
+ <refsect2 id="function-gio--volume-monitor-get">
+ <title>gio.volume_monitor_get</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>volume_monitor_get</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A reference to the
+ <link linkend="class-giovolumemonitor"><classname>gio.VolumeMonitor</classname></link>
+ used by gio.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>volume_monitor_get</methodname>() function gets the
+ volume monitor used by gio.
+ </para>
+ </refsect2>
+ </refsect1>
+
+ <refsect1>
+ <title>Signals</title>
+
+ <refsect2 id="signal-giovolumemonitor--drive-changed">
+ <title>The "drive-changed" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>drive</parameter> :</term>
+ <listitem><simpara>the drive that changed</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a drive changes.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--drive-connected">
+ <title>The "drive-connected" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>drive</parameter> :</term>
+ <listitem><simpara>the drive that was connected</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a drive is connected to the system.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--drive-disconnected">
+ <title>The "drive-disconnected" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>drive</parameter> :</term>
+ <listitem><simpara>the drive that was disconnected</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a drive is disconnected from the system.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--drive-eject-button">
+ <title>The "drive-eject-button" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>drive</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>drive</parameter> :</term>
+ <listitem><simpara>the drive where the eject button was pressed</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when the eject button is pressed on drive.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--mount-added">
+ <title>The "mount-added" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mount</parameter> :</term>
+ <listitem><simpara>a Mount that was added.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a mount is added.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--mount-changed">
+ <title>The "mount-changed" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mount</parameter> :</term>
+ <listitem><simpara>the Mount that changed.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a mount changes.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--mount-pre-unmount">
+ <title>The "mount-pre-unmount" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mount</parameter> :</term>
+ <listitem><simpara>the Mount that is being unmounted.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a mount is about to be removed.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--mount-removed">
+ <title>The "mount-removed" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>mount</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mount</parameter> :</term>
+ <listitem><simpara>the Mount that was removed.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a mount is removed.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--volume-added">
+ <title>The "volume-added" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>volume</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>volume</parameter> :</term>
+ <listitem><simpara>a Volume that was added.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a mountable volume is added to the system.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--volume-changed">
+ <title>The "volume-changed" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>volume</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>volume</parameter> :</term>
+ <listitem><simpara>a Volume that changed.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when mountable volume is changed.
+ </para>
+ </refsect2>
+
+ <refsect2 id="signal-giovolumemonitor--volume-removed">
+ <title>The "volume-removed" gio.Volume Signal</title>
+
+ <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>volume_monitor</parameter></methodparam>
+ <methodparam><parameter>volume</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>volume_monitor</parameter> :</term>
+ <listitem><simpara>the volume monitor</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>volume</parameter> :</term>
+ <listitem><simpara>a Volume that was removed.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link
+ linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Emitted when a mountable volume is removed from the system.
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
