gio/gdrive.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_DRIVE_H__
  29 #define __G_DRIVE_H__
  30
  31 #include <gio/giotypes.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define G_TYPE_DRIVE           (g_drive_get_type ())
  36 #define G_DRIVE(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_DRIVE, GDrive))
  37 #define G_IS_DRIVE(obj)        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_DRIVE))
  38 #define G_DRIVE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_DRIVE, GDriveIface))
  39
  40 /**
  41  * GDriveIface:
  42  * @g_iface: The parent interface.
  43  * @changed: Signal emitted when the drive is changed.
  44  * @disconnected: The removed signal that is emitted when the #GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized.
  45  * @eject_button: Signal emitted when the physical eject button (if any) of a drive have been pressed.
  46  * @get_name: Returns the name for the given #GDrive.
  47  * @get_icon: Returns a #GIcon for the given #GDrive.
  48  * @has_volumes: Returns %TRUE if the #GDrive has mountable volumes.
  49  * @get_volumes: Returns a list #GList of #GVolume for the #GDrive.
  50  * @is_media_removable: Returns %TRUE if the #GDrive supports removal and insertion of media.
  51  * @has_media: Returns %TRUE if the #GDrive has media inserted.
  52  * @is_media_check_automatic: Returns %TRUE if the #GDrive is capabable of automatically detecting media changes.
  53  * @can_poll_for_media: Returns %TRUE if the #GDrive is capable of manually polling for media change.
  54  * @can_eject: Returns %TRUE if the #GDrive can eject media.
  55  * @eject: Ejects a #GDrive.
  56  * @eject_finish: Finishes an eject operation.
  57  * @poll_for_media: Poll for media insertion/removal on a #GDrive.
  58  * @poll_for_media_finish: Finishes a media poll operation.
  59  * @get_identifier: Returns the identifier of the given kind, or %NULL if
  60  *    the #GDrive doesn't have one.
  61  * @enumerate_identifiers: Returns an array strings listing the kinds
  62  *    of identifiers which the #GDrive has.
  63  * @get_start_stop_type: Gets a #GDriveStartStopType with details about starting/stopping the drive. Since 2.22.
  64  * @can_stop: Returns %TRUE if a #GDrive can be stopped. Since 2.22.
  65  * @stop: Stops a #GDrive. Since 2.22.
  66  * @stop_finish: Finishes a stop operation. Since 2.22.
  67  * @can_start: Returns %TRUE if a #GDrive can be started. Since 2.22.
  68  * @can_start_degraded: Returns %TRUE if a #GDrive can be started degraded. Since 2.22.
  69  * @start: Starts a #GDrive. Since 2.22.
  70  * @start_finish: Finishes a start operation. Since 2.22.
  71  * @stop_button: Signal emitted when the physical stop button (if any) of a drive have been pressed. Since 2.22.
  72  * @eject_with_operation: Starts ejecting a #GDrive using a #GMountOperation. Since 2.22.
  73  * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
  74  * @get_sort_key: Gets a key used for sorting #GDrive instances or %NULL if no such key exists. Since 2.32.
  75  *
  76  * Interface for creating #GDrive implementations.
  77  */
  78 typedef struct _GDriveIface    GDriveIface;
  79
  80 struct _GDriveIface
  81 {
  82   GTypeInterface g_iface;
  83
  84   /* signals */
  85   void     (* changed)                  (GDrive              *drive);
  86   void     (* disconnected)             (GDrive              *drive);
  87   void     (* eject_button)             (GDrive              *drive);
  88
  89   /* Virtual Table */
  90   char *   (* get_name)                 (GDrive              *drive);
  91   GIcon *  (* get_icon)                 (GDrive              *drive);
  92   gboolean (* has_volumes)              (GDrive              *drive);
  93   GList *  (* get_volumes)              (GDrive              *drive);
  94   gboolean (* is_media_removable)       (GDrive              *drive);
  95   gboolean (* has_media)                (GDrive              *drive);
  96   gboolean (* is_media_check_automatic) (GDrive              *drive);
  97   gboolean (* can_eject)                (GDrive              *drive);
  98   gboolean (* can_poll_for_media)       (GDrive              *drive);
  99   void     (* eject)                    (GDrive              *drive,
 100                                          GMountUnmountFlags   flags,
 101                                          GCancellable        *cancellable,
 102                                          GAsyncReadyCallback  callback,
 103                                          gpointer             user_data);
 104   gboolean (* eject_finish)             (GDrive              *drive,
 105                                          GAsyncResult        *result,
 106                                          GError             **error);
 107   void     (* poll_for_media)           (GDrive              *drive,
 108                                          GCancellable        *cancellable,
 109                                          GAsyncReadyCallback  callback,
 110                                          gpointer             user_data);
 111   gboolean (* poll_for_media_finish)    (GDrive              *drive,
 112                                          GAsyncResult        *result,
 113                                          GError             **error);
 114
 115   char *   (* get_identifier)           (GDrive              *drive,
 116                                          const char          *kind);
 117   char **  (* enumerate_identifiers)    (GDrive              *drive);
 118
 119   GDriveStartStopType (* get_start_stop_type) (GDrive        *drive);
 120
 121   gboolean (* can_start)                (GDrive              *drive);
 122   gboolean (* can_start_degraded)       (GDrive              *drive);
 123   void     (* start)                    (GDrive              *drive,
 124                                          GDriveStartFlags     flags,
 125                                          GMountOperation     *mount_operation,
 126                                          GCancellable        *cancellable,
 127                                          GAsyncReadyCallback  callback,
 128                                          gpointer             user_data);
 129   gboolean (* start_finish)             (GDrive              *drive,
 130                                          GAsyncResult        *result,
 131                                          GError             **error);
 132
 133   gboolean (* can_stop)                 (GDrive              *drive);
 134   void     (* stop)                     (GDrive              *drive,
 135                                          GMountUnmountFlags   flags,
 136                                          GMountOperation     *mount_operation,
 137                                          GCancellable        *cancellable,
 138                                          GAsyncReadyCallback  callback,
 139                                          gpointer             user_data);
 140   gboolean (* stop_finish)              (GDrive              *drive,
 141                                          GAsyncResult        *result,
 142                                          GError             **error);
 143   /* signal, not VFunc */
 144   void     (* stop_button)              (GDrive              *drive);
 145
 146   void        (* eject_with_operation)      (GDrive              *drive,
 147                                              GMountUnmountFlags   flags,
 148                                              GMountOperation     *mount_operation,
 149                                              GCancellable        *cancellable,
 150                                              GAsyncReadyCallback  callback,
 151                                              gpointer             user_data);
 152   gboolean    (* eject_with_operation_finish) (GDrive            *drive,
 153                                              GAsyncResult        *result,
 154                                              GError             **error);
 155
 156   const gchar * (* get_sort_key)        (GDrive              *drive);
 157 };
 158
 159 GType    g_drive_get_type                 (void) G_GNUC_CONST;
 160
 161 char *   g_drive_get_name                 (GDrive               *drive);
 162 GIcon *  g_drive_get_icon                 (GDrive               *drive);
 163 gboolean g_drive_has_volumes              (GDrive               *drive);
 164 GList *  g_drive_get_volumes              (GDrive               *drive);
 165 gboolean g_drive_is_media_removable       (GDrive               *drive);
 166 gboolean g_drive_has_media                (GDrive               *drive);
 167 gboolean g_drive_is_media_check_automatic (GDrive               *drive);
 168 gboolean g_drive_can_poll_for_media       (GDrive               *drive);
 169 gboolean g_drive_can_eject                (GDrive               *drive);
 170 GLIB_DEPRECATED_FOR(g_drive_eject_with_operation)
 171 void     g_drive_eject                    (GDrive               *drive,
 172                                            GMountUnmountFlags    flags,
 173                                            GCancellable         *cancellable,
 174                                            GAsyncReadyCallback   callback,
 175                                            gpointer              user_data);
 176
 177 GLIB_DEPRECATED_FOR(g_drive_eject_with_operation_finish)
 178 gboolean g_drive_eject_finish             (GDrive               *drive,
 179                                            GAsyncResult         *result,
 180                                            GError              **error);
 181 void     g_drive_poll_for_media           (GDrive               *drive,
 182                                            GCancellable         *cancellable,
 183                                            GAsyncReadyCallback   callback,
 184                                            gpointer              user_data);
 185 gboolean g_drive_poll_for_media_finish    (GDrive               *drive,
 186                                            GAsyncResult         *result,
 187                                            GError              **error);
 188 char *   g_drive_get_identifier           (GDrive              *drive,
 189                                            const char          *kind);
 190 char **  g_drive_enumerate_identifiers    (GDrive              *drive);
 191
 192 GDriveStartStopType g_drive_get_start_stop_type (GDrive        *drive);
 193
 194 gboolean g_drive_can_start                (GDrive              *drive);
 195 gboolean g_drive_can_start_degraded       (GDrive              *drive);
 196 void     g_drive_start                    (GDrive              *drive,
 197                                            GDriveStartFlags     flags,
 198                                            GMountOperation     *mount_operation,
 199                                            GCancellable        *cancellable,
 200                                            GAsyncReadyCallback  callback,
 201                                            gpointer             user_data);
 202 gboolean g_drive_start_finish             (GDrive               *drive,
 203                                            GAsyncResult         *result,
 204                                            GError              **error);
 205
 206 gboolean g_drive_can_stop                 (GDrive               *drive);
 207 void     g_drive_stop                     (GDrive               *drive,
 208                                            GMountUnmountFlags    flags,
 209                                            GMountOperation      *mount_operation,
 210                                            GCancellable         *cancellable,
 211                                            GAsyncReadyCallback   callback,
 212                                            gpointer              user_data);
 213 gboolean g_drive_stop_finish              (GDrive               *drive,
 214                                            GAsyncResult         *result,
 215                                            GError              **error);
 216
 217 void        g_drive_eject_with_operation      (GDrive              *drive,
 218                                                GMountUnmountFlags   flags,
 219                                                GMountOperation     *mount_operation,
 220                                                GCancellable        *cancellable,
 221                                                GAsyncReadyCallback  callback,
 222                                                gpointer             user_data);
 223 gboolean    g_drive_eject_with_operation_finish (GDrive            *drive,
 224                                                GAsyncResult        *result,
 225                                                GError             **error);
 226
 227 const gchar *g_drive_get_sort_key         (GDrive               *drive);
 228
 229 G_END_DECLS
 230
 231 #endif /* __G_DRIVE_H__ */