gio/gvolume.h

   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@redhat.com>
  21  *         David Zeuthen <davidz@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  * @eject_with_operation: Starts ejecting a #GVolume using a #GMountOperation. Since 2.22.
 103  * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
 104  * @get_sort_key: Gets a key used for sorting #GVolume instance or %NULL if no such key exists. Since 2.32.
 105  *
 106  * Interface for implementing operations for mountable volumes.
 107  **/
 108 typedef struct _GVolumeIface    GVolumeIface;
 109
 110 struct _GVolumeIface
 111 {
 112   GTypeInterface g_iface;
 113
 114   /* signals */
 115
 116   void        (* changed)               (GVolume             *volume);
 117   void        (* removed)               (GVolume             *volume);
 118
 119   /* Virtual Table */
 120
 121   char      * (* get_name)              (GVolume             *volume);
 122   GIcon     * (* get_icon)              (GVolume             *volume);
 123   char      * (* get_uuid)              (GVolume             *volume);
 124   GDrive    * (* get_drive)             (GVolume             *volume);
 125   GMount    * (* get_mount)             (GVolume             *volume);
 126   gboolean    (* can_mount)             (GVolume             *volume);
 127   gboolean    (* can_eject)             (GVolume             *volume);
 128   void        (* mount_fn)              (GVolume             *volume,
 129                                          GMountMountFlags     flags,
 130                                          GMountOperation     *mount_operation,
 131                                          GCancellable        *cancellable,
 132                                          GAsyncReadyCallback  callback,
 133                                          gpointer             user_data);
 134   gboolean    (* mount_finish)          (GVolume             *volume,
 135                                          GAsyncResult        *result,
 136                                          GError             **error);
 137   void        (* eject)                 (GVolume             *volume,
 138                                          GMountUnmountFlags   flags,
 139                                          GCancellable        *cancellable,
 140                                          GAsyncReadyCallback  callback,
 141                                          gpointer             user_data);
 142   gboolean    (* eject_finish)          (GVolume             *volume,
 143                                          GAsyncResult        *result,
 144                                          GError             **error);
 145
 146   char      * (* get_identifier)        (GVolume             *volume,
 147                                          const char          *kind);
 148   char     ** (* enumerate_identifiers) (GVolume             *volume);
 149
 150   gboolean    (* should_automount)      (GVolume             *volume);
 151
 152   GFile     * (* get_activation_root)   (GVolume             *volume);
 153
 154   void        (* eject_with_operation)      (GVolume             *volume,
 155                                              GMountUnmountFlags   flags,
 156                                              GMountOperation     *mount_operation,
 157                                              GCancellable        *cancellable,
 158                                              GAsyncReadyCallback  callback,
 159                                              gpointer             user_data);
 160   gboolean    (* eject_with_operation_finish) (GVolume           *volume,
 161                                              GAsyncResult        *result,
 162                                              GError             **error);
 163
 164   const gchar * (* get_sort_key)        (GVolume             *volume);
 165 };
 166
 167 GType    g_volume_get_type              (void) G_GNUC_CONST;
 168
 169 char *   g_volume_get_name              (GVolume              *volume);
 170 GIcon *  g_volume_get_icon              (GVolume              *volume);
 171 char *   g_volume_get_uuid              (GVolume              *volume);
 172 GDrive * g_volume_get_drive             (GVolume              *volume);
 173 GMount * g_volume_get_mount             (GVolume              *volume);
 174 gboolean g_volume_can_mount             (GVolume              *volume);
 175 gboolean g_volume_can_eject             (GVolume              *volume);
 176 gboolean g_volume_should_automount      (GVolume              *volume);
 177 void     g_volume_mount                 (GVolume              *volume,
 178                                          GMountMountFlags      flags,
 179                                          GMountOperation      *mount_operation,
 180                                          GCancellable         *cancellable,
 181                                          GAsyncReadyCallback   callback,
 182                                          gpointer              user_data);
 183 gboolean g_volume_mount_finish          (GVolume              *volume,
 184                                          GAsyncResult         *result,
 185                                          GError              **error);
 186 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation)
 187 void     g_volume_eject                 (GVolume              *volume,
 188                                          GMountUnmountFlags    flags,
 189                                          GCancellable         *cancellable,
 190                                          GAsyncReadyCallback   callback,
 191                                          gpointer              user_data);
 192
 193 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation_finish)
 194 gboolean g_volume_eject_finish          (GVolume              *volume,
 195                                          GAsyncResult         *result,
 196                                          GError              **error);
 197 char *   g_volume_get_identifier        (GVolume              *volume,
 198                                          const char           *kind);
 199 char **  g_volume_enumerate_identifiers (GVolume              *volume);
 200
 201 GFile *  g_volume_get_activation_root   (GVolume              *volume);
 202
 203 void        g_volume_eject_with_operation     (GVolume             *volume,
 204                                                GMountUnmountFlags   flags,
 205                                                GMountOperation     *mount_operation,
 206                                                GCancellable        *cancellable,
 207                                                GAsyncReadyCallback  callback,
 208                                                gpointer             user_data);
 209 gboolean    g_volume_eject_with_operation_finish (GVolume          *volume,
 210                                                GAsyncResult        *result,
 211                                                GError             **error);
 212
 213 const gchar *g_volume_get_sort_key            (GVolume              *volume);
 214
 215 G_END_DECLS
 216
 217 #endif /* __G_VOLUME_H__ */