summaryrefslogtreecommitdiff
path: root/gio/gvolume.h
diff options
context:
space:
mode:
authorAndrew Walton <awalton@src.gnome.org>2007-11-27 14:00:13 +0000
committerAndrew Walton <awalton@src.gnome.org>2007-11-27 14:00:13 +0000
commit5247f12f3649726471080440de0d37b78c1cec33 (patch)
tree69bd070ba8cb8b12234319e354f5cb856d0c551f /gio/gvolume.h
parent6d071b4ab6d60aecf9532d1aac2128dd0c08f917 (diff)
downloadglib-5247f12f3649726471080440de0d37b78c1cec33.tar.gz
Bumps documentation to 93% symbol coverage, touching most
of the public files. Fixes broken function documentation prototypes. Fixes GCancellable inaccuracies. Removes unnecessary incomplete gtk-doc headers in private files. svn path=/trunk/; revision=5953
Diffstat (limited to 'gio/gvolume.h')
-rw-r--r--gio/gvolume.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/gio/gvolume.h b/gio/gvolume.h
index 38addbe19..d45c901fb 100644
--- a/gio/gvolume.h
+++ b/gio/gvolume.h
@@ -34,9 +34,31 @@ G_BEGIN_DECLS
#define G_VOLUME_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface))
/* GVolume typedef is in gfile.h due to include order issues */
+/**
+ * GDrive:
+ *
+ * Opaque drive object.
+ **/
typedef struct _GDrive GDrive; /* Dummy typedef */
typedef struct _GVolumeIface GVolumeIface;
+/**
+ * GVolumeIface:
+ * @g_iface: The parent interface.
+ * @changed: Changed signal that is emitted when the volume's state has changed.
+ * @get_root: Gets a #GFile to the root directory of the #GVolume.
+ * @get_name: Gets a string containing the name of the #GVolume.
+ * @get_icon: Gets a #GIcon for the #GVolume.
+ * @get_drive: Gets a #GDrive the volume is located on.
+ * @can_unmount: Checks if a #GVolume can be unmounted.
+ * @can_eject: Checks if a #GVolume can be ejected.
+ * @unmount: Starts unmounting a #GVolume.
+ * @unmount_finish: Finishes an unmounting operation.
+ * @eject: Starts ejecting a #GVolume.
+ * @eject_finish: Finishes an eject operation.
+ *
+ * Interface for implementing operations for mounted volumes.
+ **/
struct _GVolumeIface
{
GTypeInterface g_iface;