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="gio-extension-points">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   GObject parent_instance;
  62
  63   /*< private >*/
  64   gpointer priv;
  65 };
  66
  67 struct _GVolumeMonitorClass {
  68   GObjectClass parent_class;
  69
  70   /*< public >*/
  71   /* signals */
  72   void (* volume_added)     (GVolumeMonitor   *volume_monitor,
  73                              GVolume          *volume);
  74   void (* volume_removed)   (GVolumeMonitor   *volume_monitor,
  75                              GVolume          *volume);
  76   void (* volume_changed)   (GVolumeMonitor   *volume_monitor,
  77                              GVolume          *volume);
  78
  79   void (* mount_added)       (GVolumeMonitor *volume_monitor,
  80                               GMount         *mount);
  81   void (* mount_removed)     (GVolumeMonitor *volume_monitor,
  82                               GMount         *mount);
  83   void (* mount_pre_unmount) (GVolumeMonitor *volume_monitor,
  84                               GMount         *mount);
  85   void (* mount_changed)     (GVolumeMonitor *volume_monitor,
  86                               GMount         *mount);
  87
  88   void (* drive_connected)      (GVolumeMonitor *volume_monitor,
  89                                  GDrive         *drive);
  90   void (* drive_disconnected)   (GVolumeMonitor *volume_monitor,
  91                                  GDrive         *drive);
  92   void (* drive_changed)        (GVolumeMonitor *volume_monitor,
  93                                  GDrive         *drive);
  94
  95   /* Vtable */
  96
  97   gboolean (*is_supported)          (void);
  98
  99   GList * (*get_connected_drives)   (GVolumeMonitor *volume_monitor);
 100   GList * (*get_volumes)            (GVolumeMonitor *volume_monitor);
 101   GList * (*get_mounts)             (GVolumeMonitor *volume_monitor);
 102
 103   GVolume * (*get_volume_for_uuid)  (GVolumeMonitor  *volume_monitor,
 104                                      const char      *uuid);
 105
 106   GMount *  (*get_mount_for_uuid)   (GVolumeMonitor  *volume_monitor,
 107                                      const char      *uuid);
 108
 109
 110   /* These arguments are unfortunately backwards by mistake (bug #520169) */
 111   GVolume * (*adopt_orphan_mount)   (GMount          *mount,
 112                                      GVolumeMonitor  *volume_monitor);
 113
 114   /* signal added in 2.17 */
 115   void (* drive_eject_button)   (GVolumeMonitor *volume_monitor,
 116                                  GDrive         *drive);
 117
 118   /*< private >*/
 119   /* Padding for future expansion */
 120   void (*_g_reserved1) (void);
 121   void (*_g_reserved2) (void);
 122   void (*_g_reserved3) (void);
 123   void (*_g_reserved4) (void);
 124   void (*_g_reserved5) (void);
 125   void (*_g_reserved6) (void);
 126   void (*_g_reserved7) (void);
 127 };
 128
 129 GType g_volume_monitor_get_type (void) G_GNUC_CONST;
 130
 131 GVolumeMonitor *g_volume_monitor_get                     (void);
 132 GList *         g_volume_monitor_get_connected_drives    (GVolumeMonitor  *volume_monitor);
 133 GList *         g_volume_monitor_get_volumes             (GVolumeMonitor  *volume_monitor);
 134 GList *         g_volume_monitor_get_mounts              (GVolumeMonitor  *volume_monitor);
 135 GVolume *       g_volume_monitor_get_volume_for_uuid     (GVolumeMonitor  *volume_monitor,
 136                                                           const char      *uuid);
 137 GMount *        g_volume_monitor_get_mount_for_uuid      (GVolumeMonitor  *volume_monitor,
 138                                                           const char      *uuid);
 139
 140 GVolume *       g_volume_monitor_adopt_orphan_mount      (GMount *mount);
 141
 142 G_END_DECLS
 143
 144 #endif /* __G_VOLUME_MONITOR_H__ */