glib/gio/gdrive.h

/* GIO - GLib Input, Output and Streaming Library
 * 
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

#ifndef __G_DRIVE_H__
#define __G_DRIVE_H__

#include <glib-object.h>
#include <gio/gvolume.h>
#include <gio/gmountoperation.h>

G_BEGIN_DECLS

#define G_TYPE_DRIVE           (g_drive_get_type ())
#define G_DRIVE(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_DRIVE, GDrive))
#define G_IS_DRIVE(obj)	       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_DRIVE))
#define G_DRIVE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_DRIVE, GDriveIface))

/**
 * GDriveIface:
 * @g_iface: The parent interface.
 * @changed: Signal emitted when the drive is changed.
 * @get_name: Returns the name for the given #GDrive.
 * @get_icon: Returns a #GIcon for the given #GDrive.
 * @has_volumes: Returns %TRUE if the #GDrive has mountable volumes.
 * @get_volumes: Returns a #GList of volumes for the #GDrive.
 * @is_automounted: returns %TRUE if the #GDrive was automounted.
 * @can_mount: Returns %TRUE if the #GDrive can be mounted.
 * @can_eject: Returns %TRUE if the #GDrive can be ejected.
 * @mount: Mounts a given #GDrive.
 * @mount_finish: Finishes a mount operation.
 * @eject: Ejects a #GDrive.
 * @eject_finish: Finishes an eject operation.
 * 
 * Interface for creating #GDrive implementations.
 */ 
typedef struct _GDriveIface    GDriveIface;

struct _GDriveIface
{
  GTypeInterface g_iface;

  /* signals */
  void (*changed)            (GVolume *volume);
  
  /* Virtual Table */
  
  char *   (*get_name)    (GDrive         *drive);
  GIcon *  (*get_icon)    (GDrive         *drive);
  gboolean (*has_volumes) (GDrive         *drive);
  GList *  (*get_volumes) (GDrive         *drive);
  gboolean (*is_automounted)(GDrive       *drive);
  gboolean (*can_mount)   (GDrive         *drive);
  gboolean (*can_eject)   (GDrive         *drive);
  void     (*mount_fn)    (GDrive         *drive,
			   GMountOperation *mount_operation,
			   GCancellable   *cancellable,
			   GAsyncReadyCallback callback,
			   gpointer        user_data);
  gboolean (*mount_finish)(GDrive         *drive,
			   GAsyncResult   *result,
			   GError        **error);
  void     (*eject)       (GDrive         *drive,
			   GCancellable   *cancellable,
			   GAsyncReadyCallback callback,
			   gpointer        user_data);
  gboolean (*eject_finish)(GDrive         *drive,
			   GAsyncResult   *result,
			   GError        **error);
};

GType g_drive_get_type (void) G_GNUC_CONST;

char *   g_drive_get_name       (GDrive               *drive);
GIcon *  g_drive_get_icon       (GDrive               *drive);
gboolean g_drive_has_volumes    (GDrive               *drive);
GList  * g_drive_get_volumes    (GDrive               *drive);
gboolean g_drive_is_automounted (GDrive               *drive);
gboolean g_drive_can_mount      (GDrive               *drive);
gboolean g_drive_can_eject      (GDrive               *drive);
void     g_drive_mount          (GDrive               *drive,
				 GMountOperation      *mount_operation,
				 GCancellable         *cancellable,
				 GAsyncReadyCallback   callback,
				 gpointer              user_data);
gboolean g_drive_mount_finish   (GDrive               *drive,
				 GAsyncResult         *result,
				 GError              **error);
void     g_drive_eject          (GDrive               *drive,
				 GCancellable         *cancellable,
				 GAsyncReadyCallback   callback,
				 gpointer              user_data);
gboolean g_drive_eject_finish   (GDrive               *drive,
				 GAsyncResult         *result,
				 GError              **error);

G_END_DECLS

#endif /* __G_DRIVE_H__ */