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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  *         David Zeuthen <davidz@redhat.com>
  20  */
  21
  22 #ifndef __G_VOLUME_H__
  23 #define __G_VOLUME_H__
  24
  25 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  26 #error "Only <gio/gio.h> can be included directly."
  27 #endif
  28
  29 #include <gio/giotypes.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /**
  34  * G_VOLUME_IDENTIFIER_KIND_HAL_UDI:
  35  *
  36  * The string used to obtain a Hal UDI with g_volume_get_identifier().
  37  */
  38 #define G_VOLUME_IDENTIFIER_KIND_HAL_UDI "hal-udi"
  39
  40 /**
  41  * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE:
  42  *
  43  * The string used to obtain a Unix device path with g_volume_get_identifier().
  44  */
  45 #define G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE "unix-device"
  46
  47 /**
  48  * G_VOLUME_IDENTIFIER_KIND_LABEL:
  49  *
  50  * The string used to obtain a filesystem label with g_volume_get_identifier().
  51  */
  52 #define G_VOLUME_IDENTIFIER_KIND_LABEL "label"
  53
  54 /**
  55  * G_VOLUME_IDENTIFIER_KIND_UUID:
  56  *
  57  * The string used to obtain a UUID with g_volume_get_identifier().
  58  */
  59 #define G_VOLUME_IDENTIFIER_KIND_UUID "uuid"
  60
  61 /**
  62  * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT:
  63  *
  64  * The string used to obtain a NFS mount with g_volume_get_identifier().
  65  */
  66 #define G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT "nfs-mount"
  67
  68 /**
  69  * G_VOLUME_IDENTIFIER_KIND_CLASS:
  70  *
  71  * The string used to obtain the volume class with g_volume_get_identifier().
  72  *
  73  * Known volume classes include `device` and `network`. Other classes may
  74  * be added in the future.
  75  *
  76  * This is intended to be used by applications to classify #GVolume
  77  * instances into different sections - for example a file manager or
  78  * file chooser can use this information to show `network` volumes under
  79  * a "Network" heading and `device` volumes under a "Devices" heading.
  80  */
  81 #define G_VOLUME_IDENTIFIER_KIND_CLASS "class"
  82
  83
  84 #define G_TYPE_VOLUME            (g_volume_get_type ())
  85 #define G_VOLUME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_VOLUME, GVolume))
  86 #define G_IS_VOLUME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_VOLUME))
  87 #define G_VOLUME_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface))
  88
  89 /**
  90  * GVolumeIface:
  91  * @g_iface: The parent interface.
  92  * @changed: Changed signal that is emitted when the volume's state has changed.
  93  * @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.
  94  * @get_name: Gets a string containing the name of the #GVolume.
  95  * @get_icon: Gets a #GIcon for the #GVolume.
  96  * @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.
  97  * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
  98  * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
  99  * @can_mount: Returns %TRUE if the #GVolume can be mounted.
 100  * @can_eject: Checks if a #GVolume can be ejected.
 101  * @mount_fn: Mounts a given #GVolume.
 102  *     #GVolume implementations must emit the #GMountOperation::aborted
 103  *     signal before completing a mount operation that is aborted while
 104  *     awaiting input from the user through a #GMountOperation instance.
 105  * @mount_finish: Finishes a mount operation.
 106  * @eject: Ejects a given #GVolume.
 107  * @eject_finish: Finishes an eject operation.
 108  * @get_identifier: Returns the [identifier][volume-identifier] of the given kind, or %NULL if
 109  *    the #GVolume doesn't have one.
 110  * @enumerate_identifiers: Returns an array strings listing the kinds
 111  *    of [identifiers][volume-identifier] which the #GVolume has.
 112  * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted.
 113  * @get_activation_root: Returns the activation root for the #GVolume if it is known in advance or %NULL if
 114  *   it is not known.
 115  * @eject_with_operation: Starts ejecting a #GVolume using a #GMountOperation. Since 2.22.
 116  * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
 117  * @get_sort_key: Gets a key used for sorting #GVolume instance or %NULL if no such key exists. Since 2.32.
 118  * @get_symbolic_icon: Gets a symbolic #GIcon for the #GVolume. Since 2.34.
 119  *
 120  * Interface for implementing operations for mountable volumes.
 121  **/
 122 typedef struct _GVolumeIface    GVolumeIface;
 123
 124 struct _GVolumeIface
 125 {
 126   GTypeInterface g_iface;
 127
 128   /* signals */
 129
 130   void        (* changed)               (GVolume             *volume);
 131   void        (* removed)               (GVolume             *volume);
 132
 133   /* Virtual Table */
 134
 135   char      * (* get_name)              (GVolume             *volume);
 136   GIcon     * (* get_icon)              (GVolume             *volume);
 137   char      * (* get_uuid)              (GVolume             *volume);
 138   GDrive    * (* get_drive)             (GVolume             *volume);
 139   GMount    * (* get_mount)             (GVolume             *volume);
 140   gboolean    (* can_mount)             (GVolume             *volume);
 141   gboolean    (* can_eject)             (GVolume             *volume);
 142   void        (* mount_fn)              (GVolume             *volume,
 143                                          GMountMountFlags     flags,
 144                                          GMountOperation     *mount_operation,
 145                                          GCancellable        *cancellable,
 146                                          GAsyncReadyCallback  callback,
 147                                          gpointer             user_data);
 148   gboolean    (* mount_finish)          (GVolume             *volume,
 149                                          GAsyncResult        *result,
 150                                          GError             **error);
 151   void        (* eject)                 (GVolume             *volume,
 152                                          GMountUnmountFlags   flags,
 153                                          GCancellable        *cancellable,
 154                                          GAsyncReadyCallback  callback,
 155                                          gpointer             user_data);
 156   gboolean    (* eject_finish)          (GVolume             *volume,
 157                                          GAsyncResult        *result,
 158                                          GError             **error);
 159
 160   char      * (* get_identifier)        (GVolume             *volume,
 161                                          const char          *kind);
 162   char     ** (* enumerate_identifiers) (GVolume             *volume);
 163
 164   gboolean    (* should_automount)      (GVolume             *volume);
 165
 166   GFile     * (* get_activation_root)   (GVolume             *volume);
 167
 168   void        (* eject_with_operation)      (GVolume             *volume,
 169                                              GMountUnmountFlags   flags,
 170                                              GMountOperation     *mount_operation,
 171                                              GCancellable        *cancellable,
 172                                              GAsyncReadyCallback  callback,
 173                                              gpointer             user_data);
 174   gboolean    (* eject_with_operation_finish) (GVolume           *volume,
 175                                              GAsyncResult        *result,
 176                                              GError             **error);
 177
 178   const gchar * (* get_sort_key)        (GVolume             *volume);
 179   GIcon       * (* get_symbolic_icon)   (GVolume             *volume);
 180 };
 181
 182 GLIB_AVAILABLE_IN_ALL
 183 GType    g_volume_get_type              (void) G_GNUC_CONST;
 184
 185 GLIB_AVAILABLE_IN_ALL
 186 char *   g_volume_get_name              (GVolume              *volume);
 187 GLIB_AVAILABLE_IN_ALL
 188 GIcon *  g_volume_get_icon              (GVolume              *volume);
 189 GLIB_AVAILABLE_IN_ALL
 190 GIcon *  g_volume_get_symbolic_icon     (GVolume              *volume);
 191 GLIB_AVAILABLE_IN_ALL
 192 char *   g_volume_get_uuid              (GVolume              *volume);
 193 GLIB_AVAILABLE_IN_ALL
 194 GDrive * g_volume_get_drive             (GVolume              *volume);
 195 GLIB_AVAILABLE_IN_ALL
 196 GMount * g_volume_get_mount             (GVolume              *volume);
 197 GLIB_AVAILABLE_IN_ALL
 198 gboolean g_volume_can_mount             (GVolume              *volume);
 199 GLIB_AVAILABLE_IN_ALL
 200 gboolean g_volume_can_eject             (GVolume              *volume);
 201 GLIB_AVAILABLE_IN_ALL
 202 gboolean g_volume_should_automount      (GVolume              *volume);
 203 GLIB_AVAILABLE_IN_ALL
 204 void     g_volume_mount                 (GVolume              *volume,
 205                                          GMountMountFlags      flags,
 206                                          GMountOperation      *mount_operation,
 207                                          GCancellable         *cancellable,
 208                                          GAsyncReadyCallback   callback,
 209                                          gpointer              user_data);
 210 GLIB_AVAILABLE_IN_ALL
 211 gboolean g_volume_mount_finish          (GVolume              *volume,
 212                                          GAsyncResult         *result,
 213                                          GError              **error);
 214 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation)
 215 void     g_volume_eject                 (GVolume              *volume,
 216                                          GMountUnmountFlags    flags,
 217                                          GCancellable         *cancellable,
 218                                          GAsyncReadyCallback   callback,
 219                                          gpointer              user_data);
 220
 221 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation_finish)
 222 gboolean g_volume_eject_finish          (GVolume              *volume,
 223                                          GAsyncResult         *result,
 224                                          GError              **error);
 225 GLIB_AVAILABLE_IN_ALL
 226 char *   g_volume_get_identifier        (GVolume              *volume,
 227                                          const char           *kind);
 228 GLIB_AVAILABLE_IN_ALL
 229 char **  g_volume_enumerate_identifiers (GVolume              *volume);
 230
 231 GLIB_AVAILABLE_IN_ALL
 232 GFile *  g_volume_get_activation_root   (GVolume              *volume);
 233
 234 GLIB_AVAILABLE_IN_ALL
 235 void        g_volume_eject_with_operation     (GVolume             *volume,
 236                                                GMountUnmountFlags   flags,
 237                                                GMountOperation     *mount_operation,
 238                                                GCancellable        *cancellable,
 239                                                GAsyncReadyCallback  callback,
 240                                                gpointer             user_data);
 241 GLIB_AVAILABLE_IN_ALL
 242 gboolean    g_volume_eject_with_operation_finish (GVolume          *volume,
 243                                                GAsyncResult        *result,
 244                                                GError             **error);
 245
 246 GLIB_AVAILABLE_IN_2_32
 247 const gchar *g_volume_get_sort_key            (GVolume              *volume);
 248
 249 G_END_DECLS
 250
 251 #endif /* __G_VOLUME_H__ */