gio/gvolumemonitor.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2
   3 /* GIO - GLib Input, Output and Streaming Library
   4  *
   5  * Copyright (C) 2006-2007 Red Hat, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  *
  22  * Author: Alexander Larsson <alexl@redhat.com>
  23  *         David Zeuthen <davidz@redhat.com>
  24  */
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #ifndef __G_VOLUME_MONITOR_H__
  31 #define __G_VOLUME_MONITOR_H__
  32
  33 #include <gio/giotypes.h>
  34
  35 G_BEGIN_DECLS
  36
  37 #define G_TYPE_VOLUME_MONITOR         (g_volume_monitor_get_type ())
  38 #define G_VOLUME_MONITOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_VOLUME_MONITOR, GVolumeMonitor))
  39 #define G_VOLUME_MONITOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_VOLUME_MONITOR, GVolumeMonitorClass))
  40 #define G_VOLUME_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_VOLUME_MONITOR, GVolumeMonitorClass))
  41 #define G_IS_VOLUME_MONITOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_VOLUME_MONITOR))
  42 #define G_IS_VOLUME_MONITOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_VOLUME_MONITOR))
  43
  44 /**
  45  * G_VOLUME_MONITOR_EXTENSION_POINT_NAME:
  46  *
  47  * Extension point for volume monitor functionality.
  48  * See <link linkend="extending-gio">Extending GIO</link>.
  49  */
  50 #define G_VOLUME_MONITOR_EXTENSION_POINT_NAME "gio-volume-monitor"
  51
  52 /**
  53  * GVolumeMonitor:
  54  * @parent_instance: The parent instance.
  55  *
  56  * A Volume Monitor that watches for volume events.
  57  **/
  58 typedef struct _GVolumeMonitorClass GVolumeMonitorClass;
  59
  60 struct _GVolumeMonitor
  61 {
  62   GObject parent_instance;
  63
  64   /*< private >*/
  65   gpointer priv;
  66 };
  67
  68 struct _GVolumeMonitorClass
  69 {
  70   GObjectClass parent_class;
  71
  72   /*< public >*/
  73   /* signals */
  74   void      (* volume_added)         (GVolumeMonitor *volume_monitor,
  75                                       GVolume        *volume);
  76   void      (* volume_removed)       (GVolumeMonitor *volume_monitor,
  77                                       GVolume        *volume);
  78   void      (* volume_changed)       (GVolumeMonitor *volume_monitor,
  79                                       GVolume        *volume);
  80
  81   void      (* mount_added)          (GVolumeMonitor *volume_monitor,
  82                                       GMount         *mount);
  83   void      (* mount_removed)        (GVolumeMonitor *volume_monitor,
  84                                       GMount         *mount);
  85   void      (* mount_pre_unmount)    (GVolumeMonitor *volume_monitor,
  86                                       GMount         *mount);
  87   void      (* mount_changed)        (GVolumeMonitor *volume_monitor,
  88                                       GMount         *mount);
  89
  90   void      (* drive_connected)      (GVolumeMonitor *volume_monitor,
  91                                       GDrive         *drive);
  92   void      (* drive_disconnected)   (GVolumeMonitor *volume_monitor,
  93                                       GDrive         *drive);
  94   void      (* drive_changed)        (GVolumeMonitor *volume_monitor,
  95                                       GDrive         *drive);
  96
  97   /* Vtable */
  98
  99   gboolean  (* is_supported)         (void);
 100
 101   GList   * (* get_connected_drives) (GVolumeMonitor *volume_monitor);
 102   GList   * (* get_volumes)          (GVolumeMonitor *volume_monitor);
 103   GList   * (* get_mounts)           (GVolumeMonitor *volume_monitor);
 104
 105   GVolume * (* get_volume_for_uuid)  (GVolumeMonitor *volume_monitor,
 106                                       const char     *uuid);
 107
 108   GMount  * (* get_mount_for_uuid)   (GVolumeMonitor *volume_monitor,
 109                                       const char     *uuid);
 110
 111
 112   /* These arguments are unfortunately backwards by mistake (bug #520169). Deprecated in 2.20. */
 113   GVolume * (* adopt_orphan_mount)   (GMount         *mount,
 114                                       GVolumeMonitor *volume_monitor);
 115
 116   /* signal added in 2.17 */
 117   void      (* drive_eject_button)   (GVolumeMonitor *volume_monitor,
 118                                       GDrive         *drive);
 119
 120   /* signal added in 2.21 */
 121   void      (* drive_stop_button)   (GVolumeMonitor *volume_monitor,
 122                                      GDrive         *drive);
 123
 124   /*< private >*/
 125   /* Padding for future expansion */
 126   void (*_g_reserved1) (void);
 127   void (*_g_reserved2) (void);
 128   void (*_g_reserved3) (void);
 129   void (*_g_reserved4) (void);
 130   void (*_g_reserved5) (void);
 131   void (*_g_reserved6) (void);
 132 };
 133
 134 GType           g_volume_monitor_get_type             (void) G_GNUC_CONST;
 135
 136 GVolumeMonitor *g_volume_monitor_get                  (void);
 137 GList *         g_volume_monitor_get_connected_drives (GVolumeMonitor *volume_monitor);
 138 GList *         g_volume_monitor_get_volumes          (GVolumeMonitor *volume_monitor);
 139 GList *         g_volume_monitor_get_mounts           (GVolumeMonitor *volume_monitor);
 140 GVolume *       g_volume_monitor_get_volume_for_uuid  (GVolumeMonitor *volume_monitor,
 141                                                        const char     *uuid);
 142 GMount *        g_volume_monitor_get_mount_for_uuid   (GVolumeMonitor *volume_monitor,
 143                                                        const char     *uuid);
 144
 145 #ifndef G_DISABLE_DEPRECATED
 146 GVolume *       g_volume_monitor_adopt_orphan_mount   (GMount         *mount);
 147 #endif
 148
 149 G_END_DECLS
 150
 151 #endif /* __G_VOLUME_MONITOR_H__ */