1 /* GIO - GLib Input, Output and Streaming Library 2 * 3 * Copyright (C) 2006-2007 Red Hat, Inc. 4 * 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. 9 * 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. 14 * 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. 19 * 20 * Author: Alexander Larsson <alexl (at) redhat.com> 21 * David Zeuthen <davidz (at) redhat.com> 22 */ 23 24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) 25 #error "Only <gio/gio.h> can be included directly." 26 #endif 27 28 #ifndef __G_VOLUME_H__ 29 #define __G_VOLUME_H__ 30 31 #include <gio/giotypes.h> 32 33 G_BEGIN_DECLS 34 35 /** 36 * G_VOLUME_IDENTIFIER_KIND_HAL_UDI: 37 * 38 * The string used to obtain a Hal UDI with g_volume_get_identifier(). 39 */ 40 #define G_VOLUME_IDENTIFIER_KIND_HAL_UDI "hal-udi" 41 42 /** 43 * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE: 44 * 45 * The string used to obtain a Unix device path with g_volume_get_identifier(). 46 */ 47 #define G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE "unix-device" 48 49 /** 50 * G_VOLUME_IDENTIFIER_KIND_LABEL: 51 * 52 * The string used to obtain a filesystem label with g_volume_get_identifier(). 53 */ 54 #define G_VOLUME_IDENTIFIER_KIND_LABEL "label" 55 56 /** 57 * G_VOLUME_IDENTIFIER_KIND_UUID: 58 * 59 * The string used to obtain a UUID with g_volume_get_identifier(). 60 */ 61 #define G_VOLUME_IDENTIFIER_KIND_UUID "uuid" 62 63 /** 64 * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT: 65 * 66 * The string used to obtain a NFS mount with g_volume_get_identifier(). 67 */ 68 #define G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT "nfs-mount" 69 70 71 #define G_TYPE_VOLUME (g_volume_get_type ()) 72 #define G_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_VOLUME, GVolume)) 73 #define G_IS_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_VOLUME)) 74 #define G_VOLUME_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface)) 75 76 /** 77 * GVolumeIface: 78 * @g_iface: The parent interface. 79 * @changed: Changed signal that is emitted when the volume's state has changed. 80 * @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. 81 * @get_name: Gets a string containing the name of the #GVolume. 82 * @get_icon: Gets a #GIcon for the #GVolume. 83 * @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. 84 * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive. 85 * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted. 86 * @can_mount: Returns %TRUE if the #GVolume can be mounted. 87 * @can_eject: Checks if a #GVolume can be ejected. 88 * @mount_fn: Mounts a given #GVolume. 89 * #GVolume implementations must emit the #GMountOperation::aborted 90 * signal before completing a mount operation that is aborted while 91 * awaiting input from the user through a #GMountOperation instance. 92 * @mount_finish: Finishes a mount operation. 93 * @eject: Ejects a given #GVolume. 94 * @eject_finish: Finishes an eject operation. 95 * @get_identifier: Returns the <link linkend="volume-identifier">identifier</link> of the given kind, or %NULL if 96 * the #GVolume doesn't have one. 97 * @enumerate_identifiers: Returns an array strings listing the kinds 98 * of <link linkend="volume-identifier">identifiers</link> which the #GVolume has. 99 * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted. 100 * @get_activation_root: Returns the activation root for the #GVolume if it is known in advance or %NULL if 101 * it is not known. 102 * 103 * Interface for implementing operations for mountable volumes. 104 **/ 105 typedef struct _GVolumeIface GVolumeIface; 106 107 struct _GVolumeIface 108 { 109 GTypeInterface g_iface; 110 111 /* signals */ 112 113 void (* changed) (GVolume *volume); 114 void (* removed) (GVolume *volume); 115 116 /* Virtual Table */ 117 118 char * (* get_name) (GVolume *volume); 119 GIcon * (* get_icon) (GVolume *volume); 120 char * (* get_uuid) (GVolume *volume); 121 GDrive * (* get_drive) (GVolume *volume); 122 GMount * (* get_mount) (GVolume *volume); 123 gboolean (* can_mount) (GVolume *volume); 124 gboolean (* can_eject) (GVolume *volume); 125 void (* mount_fn) (GVolume *volume, 126 GMountMountFlags flags, 127 GMountOperation *mount_operation, 128 GCancellable *cancellable, 129 GAsyncReadyCallback callback, 130 gpointer user_data); 131 gboolean (* mount_finish) (GVolume *volume, 132 GAsyncResult *result, 133 GError **error); 134 void (* eject) (GVolume *volume, 135 GMountUnmountFlags flags, 136 GCancellable *cancellable, 137 GAsyncReadyCallback callback, 138 gpointer user_data); 139 gboolean (* eject_finish) (GVolume *volume, 140 GAsyncResult *result, 141 GError **error); 142 143 char * (* get_identifier) (GVolume *volume, 144 const char *kind); 145 char ** (* enumerate_identifiers) (GVolume *volume); 146 147 gboolean (* should_automount) (GVolume *volume); 148 149 GFile * (* get_activation_root) (GVolume *volume); 150 151 }; 152 153 GType g_volume_get_type (void) G_GNUC_CONST; 154 155 char * g_volume_get_name (GVolume *volume); 156 GIcon * g_volume_get_icon (GVolume *volume); 157 char * g_volume_get_uuid (GVolume *volume); 158 GDrive * g_volume_get_drive (GVolume *volume); 159 GMount * g_volume_get_mount (GVolume *volume); 160 gboolean g_volume_can_mount (GVolume *volume); 161 gboolean g_volume_can_eject (GVolume *volume); 162 gboolean g_volume_should_automount (GVolume *volume); 163 void g_volume_mount (GVolume *volume, 164 GMountMountFlags flags, 165 GMountOperation *mount_operation, 166 GCancellable *cancellable, 167 GAsyncReadyCallback callback, 168 gpointer user_data); 169 gboolean g_volume_mount_finish (GVolume *volume, 170 GAsyncResult *result, 171 GError **error); 172 void g_volume_eject (GVolume *volume, 173 GMountUnmountFlags flags, 174 GCancellable *cancellable, 175 GAsyncReadyCallback callback, 176 gpointer user_data); 177 gboolean g_volume_eject_finish (GVolume *volume, 178 GAsyncResult *result, 179 GError **error); 180 char * g_volume_get_identifier (GVolume *volume, 181 const char *kind); 182 char ** g_volume_enumerate_identifiers (GVolume *volume); 183 184 GFile * g_volume_get_activation_root (GVolume *volume); 185 186 G_END_DECLS 187 188 #endif /* __G_VOLUME_H__ */ 189
