1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
21 * David Zeuthen <davidz@redhat.com>
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
28 #ifndef __G_VOLUME_H__
29 #define __G_VOLUME_H__
31 #include <glib-object.h>
32 #include <gio/gfile.h>
33 #include <gio/gdrive.h>
38 * G_VOLUME_IDENTIFIER_KIND_HAL_UDI:
40 * The string used to obtain a Hal UDI with g_volume_get_identifier().
42 #define G_VOLUME_IDENTIFIER_KIND_HAL_UDI "hal-udi"
45 * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE:
47 * The string used to obtain a Unix device path with g_volume_get_identifier().
49 #define G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE "unix-device"
52 * G_VOLUME_IDENTIFIER_KIND_LABEL:
54 * The string used to obtain a filesystem label with g_volume_get_identifier().
56 #define G_VOLUME_IDENTIFIER_KIND_LABEL "label"
59 * G_VOLUME_IDENTIFIER_KIND_UUID:
61 * The string used to obtain a UUID with g_volume_get_identifier().
63 #define G_VOLUME_IDENTIFIER_KIND_UUID "uuid"
66 * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT:
68 * The string used to obtain a NFS mount with g_volume_get_identifier().
70 #define G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT "nfs-mount"
73 #define G_TYPE_VOLUME (g_volume_get_type ())
74 #define G_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_VOLUME, GVolume))
75 #define G_IS_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_VOLUME))
76 #define G_VOLUME_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface))
80 * @g_iface: The parent interface.
81 * @changed: Changed signal that is emitted when the volume's state has changed.
82 * @removed: The removed signal that is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized.
83 * @get_name: Gets a string containing the name of the #GVolume.
84 * @get_icon: Gets a #GIcon for the #GVolume.
85 * @get_uuid: Gets the UUID for the #GVolume. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available.
86 * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
87 * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
88 * @can_mount: Returns %TRUE if the #GVolume can be mounted.
89 * @can_eject: Checks if a #GVolume can be ejected.
90 * @mount_fn: Mounts a given #GVolume.
91 * @mount_finish: Finishes a mount operation.
92 * @eject: Ejects a given #GVolume.
93 * @eject_finish: Finishes an eject operation.
94 * @get_identifier: Returns the <link linkend="volume-identifier">identifier</link> of the given kind, or %NULL if
95 * the #GVolume doesn't have one.
96 * @enumerate_identifiers: Returns an array strings listing the kinds
97 * of <link linkend="volume-identifier">identifiers</link> which the #GVolume has.
98 * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted.
100 * Interface for implementing operations for mountable volumes.
102 typedef struct _GVolumeIface GVolumeIface;
106 GTypeInterface g_iface;
110 void (*changed) (GVolume *volume);
111 void (*removed) (GVolume *volume);
115 char * (*get_name) (GVolume *volume);
116 GIcon * (*get_icon) (GVolume *volume);
117 char * (*get_uuid) (GVolume *volume);
118 GDrive * (*get_drive) (GVolume *volume);
119 GMount * (*get_mount) (GVolume *volume);
120 gboolean (*can_mount) (GVolume *volume);
121 gboolean (*can_eject) (GVolume *volume);
122 void (*mount_fn) (GVolume *volume,
123 GMountMountFlags flags,
124 GMountOperation *mount_operation,
125 GCancellable *cancellable,
126 GAsyncReadyCallback callback,
128 gboolean (*mount_finish) (GVolume *volume,
129 GAsyncResult *result,
131 void (*eject) (GVolume *volume,
132 GMountUnmountFlags flags,
133 GCancellable *cancellable,
134 GAsyncReadyCallback callback,
136 gboolean (*eject_finish) (GVolume *volume,
137 GAsyncResult *result,
140 char * (*get_identifier) (GVolume *volume,
142 char ** (*enumerate_identifiers) (GVolume *volume);
144 gboolean (*should_automount) (GVolume *volume);
148 GType g_volume_get_type (void) G_GNUC_CONST;
150 char * g_volume_get_name (GVolume *volume);
151 GIcon * g_volume_get_icon (GVolume *volume);
152 char * g_volume_get_uuid (GVolume *volume);
153 GDrive * g_volume_get_drive (GVolume *volume);
154 GMount * g_volume_get_mount (GVolume *volume);
155 gboolean g_volume_can_mount (GVolume *volume);
156 gboolean g_volume_can_eject (GVolume *volume);
157 gboolean g_volume_should_automount (GVolume *volume);
158 void g_volume_mount (GVolume *volume,
159 GMountMountFlags flags,
160 GMountOperation *mount_operation,
161 GCancellable *cancellable,
162 GAsyncReadyCallback callback,
164 gboolean g_volume_mount_finish (GVolume *volume,
165 GAsyncResult *result,
167 void g_volume_eject (GVolume *volume,
168 GMountUnmountFlags flags,
169 GCancellable *cancellable,
170 GAsyncReadyCallback callback,
172 gboolean g_volume_eject_finish (GVolume *volume,
173 GAsyncResult *result,
175 char * g_volume_get_identifier (GVolume *volume,
177 char ** g_volume_enumerate_identifiers (GVolume *volume);
182 #endif /* __G_VOLUME_H__ */