1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Alexander Larsson <alexl@redhat.com>
21 * David Zeuthen <davidz@redhat.com>
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
31 #include <gio/giotypes.h>
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))
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.
75 * Interface for creating #GDrive implementations.
77 typedef struct _GDriveIface GDriveIface
;
81 GTypeInterface g_iface
;
84 void (* changed
) (GDrive
*drive
);
85 void (* disconnected
) (GDrive
*drive
);
86 void (* eject_button
) (GDrive
*drive
);
89 char * (* get_name
) (GDrive
*drive
);
90 GIcon
* (* get_icon
) (GDrive
*drive
);
91 gboolean (* has_volumes
) (GDrive
*drive
);
92 GList
* (* get_volumes
) (GDrive
*drive
);
93 gboolean (* is_media_removable
) (GDrive
*drive
);
94 gboolean (* has_media
) (GDrive
*drive
);
95 gboolean (* is_media_check_automatic
) (GDrive
*drive
);
96 gboolean (* can_eject
) (GDrive
*drive
);
97 gboolean (* can_poll_for_media
) (GDrive
*drive
);
98 void (* eject
) (GDrive
*drive
,
99 GMountUnmountFlags flags
,
100 GCancellable
*cancellable
,
101 GAsyncReadyCallback callback
,
103 gboolean (* eject_finish
) (GDrive
*drive
,
104 GAsyncResult
*result
,
106 void (* poll_for_media
) (GDrive
*drive
,
107 GCancellable
*cancellable
,
108 GAsyncReadyCallback callback
,
110 gboolean (* poll_for_media_finish
) (GDrive
*drive
,
111 GAsyncResult
*result
,
114 char * (* get_identifier
) (GDrive
*drive
,
116 char ** (* enumerate_identifiers
) (GDrive
*drive
);
118 GDriveStartStopType (* get_start_stop_type
) (GDrive
*drive
);
120 gboolean (* can_start
) (GDrive
*drive
);
121 gboolean (* can_start_degraded
) (GDrive
*drive
);
122 void (* start
) (GDrive
*drive
,
123 GDriveStartFlags flags
,
124 GMountOperation
*mount_operation
,
125 GCancellable
*cancellable
,
126 GAsyncReadyCallback callback
,
128 gboolean (* start_finish
) (GDrive
*drive
,
129 GAsyncResult
*result
,
132 gboolean (* can_stop
) (GDrive
*drive
);
133 void (* stop
) (GDrive
*drive
,
134 GMountUnmountFlags flags
,
135 GMountOperation
*mount_operation
,
136 GCancellable
*cancellable
,
137 GAsyncReadyCallback callback
,
139 gboolean (* stop_finish
) (GDrive
*drive
,
140 GAsyncResult
*result
,
142 /* signal, not VFunc */
143 void (* stop_button
) (GDrive
*drive
);
145 void (* eject_with_operation
) (GDrive
*drive
,
146 GMountUnmountFlags flags
,
147 GMountOperation
*mount_operation
,
148 GCancellable
*cancellable
,
149 GAsyncReadyCallback callback
,
151 gboolean (* eject_with_operation_finish
) (GDrive
*drive
,
152 GAsyncResult
*result
,
156 GType
g_drive_get_type (void) G_GNUC_CONST
;
158 char * g_drive_get_name (GDrive
*drive
);
159 GIcon
* g_drive_get_icon (GDrive
*drive
);
160 gboolean
g_drive_has_volumes (GDrive
*drive
);
161 GList
* g_drive_get_volumes (GDrive
*drive
);
162 gboolean
g_drive_is_media_removable (GDrive
*drive
);
163 gboolean
g_drive_has_media (GDrive
*drive
);
164 gboolean
g_drive_is_media_check_automatic (GDrive
*drive
);
165 gboolean
g_drive_can_poll_for_media (GDrive
*drive
);
166 gboolean
g_drive_can_eject (GDrive
*drive
);
167 #ifndef G_DISABLE_DEPRECATED
168 void g_drive_eject (GDrive
*drive
,
169 GMountUnmountFlags flags
,
170 GCancellable
*cancellable
,
171 GAsyncReadyCallback callback
,
173 gboolean
g_drive_eject_finish (GDrive
*drive
,
174 GAsyncResult
*result
,
177 void g_drive_poll_for_media (GDrive
*drive
,
178 GCancellable
*cancellable
,
179 GAsyncReadyCallback callback
,
181 gboolean
g_drive_poll_for_media_finish (GDrive
*drive
,
182 GAsyncResult
*result
,
184 char * g_drive_get_identifier (GDrive
*drive
,
186 char ** g_drive_enumerate_identifiers (GDrive
*drive
);
188 GDriveStartStopType
g_drive_get_start_stop_type (GDrive
*drive
);
190 gboolean
g_drive_can_start (GDrive
*drive
);
191 gboolean
g_drive_can_start_degraded (GDrive
*drive
);
192 void g_drive_start (GDrive
*drive
,
193 GDriveStartFlags flags
,
194 GMountOperation
*mount_operation
,
195 GCancellable
*cancellable
,
196 GAsyncReadyCallback callback
,
198 gboolean
g_drive_start_finish (GDrive
*drive
,
199 GAsyncResult
*result
,
202 gboolean
g_drive_can_stop (GDrive
*drive
);
203 void g_drive_stop (GDrive
*drive
,
204 GMountUnmountFlags flags
,
205 GMountOperation
*mount_operation
,
206 GCancellable
*cancellable
,
207 GAsyncReadyCallback callback
,
209 gboolean
g_drive_stop_finish (GDrive
*drive
,
210 GAsyncResult
*result
,
213 void g_drive_eject_with_operation (GDrive
*drive
,
214 GMountUnmountFlags flags
,
215 GMountOperation
*mount_operation
,
216 GCancellable
*cancellable
,
217 GAsyncReadyCallback callback
,
219 gboolean
g_drive_eject_with_operation_finish (GDrive
*drive
,
220 GAsyncResult
*result
,
225 #endif /* __G_DRIVE_H__ */