• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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  *
64  * Interface for creating #GDrive implementations.
65  */
66 typedef struct _GDriveIface    GDriveIface;
67 
68 struct _GDriveIface
69 {
70   GTypeInterface g_iface;
71 
72   /* signals */
73   void     (* changed)                  (GDrive              *drive);
74   void     (* disconnected)             (GDrive              *drive);
75   void     (* eject_button)             (GDrive              *drive);
76 
77   /* Virtual Table */
78   char *   (* get_name)                 (GDrive              *drive);
79   GIcon *  (* get_icon)                 (GDrive              *drive);
80   gboolean (* has_volumes)              (GDrive              *drive);
81   GList *  (* get_volumes)              (GDrive              *drive);
82   gboolean (* is_media_removable)       (GDrive              *drive);
83   gboolean (* has_media)                (GDrive              *drive);
84   gboolean (* is_media_check_automatic) (GDrive              *drive);
85   gboolean (* can_eject)                (GDrive              *drive);
86   gboolean (* can_poll_for_media)       (GDrive              *drive);
87   void     (* eject)                    (GDrive              *drive,
88                                          GMountUnmountFlags   flags,
89                                          GCancellable        *cancellable,
90                                          GAsyncReadyCallback  callback,
91                                          gpointer             user_data);
92   gboolean (* eject_finish)             (GDrive              *drive,
93                                          GAsyncResult        *result,
94                                          GError             **error);
95   void     (* poll_for_media)           (GDrive              *drive,
96                                          GCancellable        *cancellable,
97                                          GAsyncReadyCallback  callback,
98                                          gpointer             user_data);
99   gboolean (* poll_for_media_finish)    (GDrive              *drive,
100                                          GAsyncResult        *result,
101                                          GError             **error);
102 
103   char *   (* get_identifier)           (GDrive              *drive,
104                                          const char          *kind);
105   char **  (* enumerate_identifiers)    (GDrive              *drive);
106 };
107 
108 GType    g_drive_get_type                 (void) G_GNUC_CONST;
109 
110 char *   g_drive_get_name                 (GDrive               *drive);
111 GIcon *  g_drive_get_icon                 (GDrive               *drive);
112 gboolean g_drive_has_volumes              (GDrive               *drive);
113 GList *  g_drive_get_volumes              (GDrive               *drive);
114 gboolean g_drive_is_media_removable       (GDrive               *drive);
115 gboolean g_drive_has_media                (GDrive               *drive);
116 gboolean g_drive_is_media_check_automatic (GDrive               *drive);
117 gboolean g_drive_can_poll_for_media       (GDrive               *drive);
118 gboolean g_drive_can_eject                (GDrive               *drive);
119 void     g_drive_eject                    (GDrive               *drive,
120 					   GMountUnmountFlags    flags,
121                                            GCancellable         *cancellable,
122                                            GAsyncReadyCallback   callback,
123                                            gpointer              user_data);
124 gboolean g_drive_eject_finish             (GDrive               *drive,
125                                            GAsyncResult         *result,
126                                            GError              **error);
127 void     g_drive_poll_for_media           (GDrive               *drive,
128                                            GCancellable         *cancellable,
129                                            GAsyncReadyCallback   callback,
130                                            gpointer              user_data);
131 gboolean g_drive_poll_for_media_finish    (GDrive               *drive,
132                                            GAsyncResult         *result,
133                                            GError              **error);
134 char *   g_drive_get_identifier           (GDrive              *drive,
135 					   const char          *kind);
136 char **  g_drive_enumerate_identifiers    (GDrive              *drive);
137 
138 G_END_DECLS
139 
140 #endif /* __G_DRIVE_H__ */
141