1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2008 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_MOUNT (g_mount_get_type ())
36 #define G_MOUNT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_MOUNT, GMount))
37 #define G_IS_MOUNT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_MOUNT))
38 #define G_MOUNT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_MOUNT, GMountIface))
40 typedef struct _GMountIface GMountIface;
44 * @g_iface: The parent interface.
45 * @changed: Changed signal that is emitted when the mount's state has changed.
46 * @unmounted: The unmounted signal that is emitted when the #GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized.
47 * @pre_unmount: The pre_unmout signal that is emitted when the #GMount will soon be emitted. If the recipient is somehow holding the mount open by keeping an open file on it it should close the file.
48 * @get_root: Gets a #GFile to the root directory of the #GMount.
49 * @get_name: Gets a string containing the name of the #GMount.
50 * @get_icon: Gets a #GIcon for the #GMount.
51 * @get_uuid: Gets the UUID for the #GMount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available.
52 * @get_volume: Gets a #GVolume the mount is located on. Returns %NULL if the #GMount is not associated with a #GVolume.
53 * @get_drive: Gets a #GDrive the volume of the mount is located on. Returns %NULL if the #GMount is not associated with a #GDrive or a #GVolume. This is convenience method for getting the #GVolume and using that to get the #GDrive.
54 * @can_unmount: Checks if a #GMount can be unmounted.
55 * @can_eject: Checks if a #GMount can be ejected.
56 * @unmount: Starts unmounting a #GMount.
57 * @unmount_finish: Finishes an unmounting operation.
58 * @eject: Starts ejecting a #GMount.
59 * @eject_finish: Finishes an eject operation.
60 * @remount: Starts remounting a #GMount.
61 * @remount_finish: Finishes a remounting operation.
62 * @guess_content_type: Starts guessing the type of the content of a #GMount.
63 * See g_mount_guess_content_type() for more information on content
64 * type guessing. This operation was added in 2.18.
65 * @guess_content_type_finish: Finishes a contenet type guessing operation. Added in 2.18.
66 * @guess_content_type_sync: Synchronous variant of @guess_content_type. Added in 2.18
68 * Interface for implementing operations for mounts.
72 GTypeInterface g_iface;
76 void (* changed) (GMount *mount);
77 void (* unmounted) (GMount *mount);
81 GFile * (* get_root) (GMount *mount);
82 char * (* get_name) (GMount *mount);
83 GIcon * (* get_icon) (GMount *mount);
84 char * (* get_uuid) (GMount *mount);
85 GVolume * (* get_volume) (GMount *mount);
86 GDrive * (* get_drive) (GMount *mount);
87 gboolean (* can_unmount) (GMount *mount);
88 gboolean (* can_eject) (GMount *mount);
90 void (* unmount) (GMount *mount,
91 GMountUnmountFlags flags,
92 GCancellable *cancellable,
93 GAsyncReadyCallback callback,
95 gboolean (* unmount_finish) (GMount *mount,
99 void (* eject) (GMount *mount,
100 GMountUnmountFlags flags,
101 GCancellable *cancellable,
102 GAsyncReadyCallback callback,
104 gboolean (* eject_finish) (GMount *mount,
105 GAsyncResult *result,
108 void (* remount) (GMount *mount,
109 GMountMountFlags flags,
110 GMountOperation *mount_operation,
111 GCancellable *cancellable,
112 GAsyncReadyCallback callback,
114 gboolean (* remount_finish) (GMount *mount,
115 GAsyncResult *result,
118 void (* guess_content_type) (GMount *mount,
119 gboolean force_rescan,
120 GCancellable *cancellable,
121 GAsyncReadyCallback callback,
123 gchar ** (* guess_content_type_finish) (GMount *mount,
124 GAsyncResult *result,
126 gchar ** (* guess_content_type_sync) (GMount *mount,
127 gboolean force_rescan,
128 GCancellable *cancellable,
131 /* yet more signals */
132 void (* pre_unmount) (GMount *mount);
135 GType g_mount_get_type (void) G_GNUC_CONST;
137 GFile * g_mount_get_root (GMount *mount);
138 char * g_mount_get_name (GMount *mount);
139 GIcon * g_mount_get_icon (GMount *mount);
140 char * g_mount_get_uuid (GMount *mount);
141 GVolume * g_mount_get_volume (GMount *mount);
142 GDrive * g_mount_get_drive (GMount *mount);
143 gboolean g_mount_can_unmount (GMount *mount);
144 gboolean g_mount_can_eject (GMount *mount);
146 void g_mount_unmount (GMount *mount,
147 GMountUnmountFlags flags,
148 GCancellable *cancellable,
149 GAsyncReadyCallback callback,
151 gboolean g_mount_unmount_finish (GMount *mount,
152 GAsyncResult *result,
155 void g_mount_eject (GMount *mount,
156 GMountUnmountFlags flags,
157 GCancellable *cancellable,
158 GAsyncReadyCallback callback,
160 gboolean g_mount_eject_finish (GMount *mount,
161 GAsyncResult *result,
164 void g_mount_remount (GMount *mount,
165 GMountMountFlags flags,
166 GMountOperation *mount_operation,
167 GCancellable *cancellable,
168 GAsyncReadyCallback callback,
170 gboolean g_mount_remount_finish (GMount *mount,
171 GAsyncResult *result,
174 void g_mount_guess_content_type (GMount *mount,
175 gboolean force_rescan,
176 GCancellable *cancellable,
177 GAsyncReadyCallback callback,
179 gchar ** g_mount_guess_content_type_finish (GMount *mount,
180 GAsyncResult *result,
182 gchar ** g_mount_guess_content_type_sync (GMount *mount,
183 gboolean force_rescan,
184 GCancellable *cancellable,
187 gboolean g_mount_is_shadowed (GMount *mount);
188 void g_mount_shadow (GMount *mount);
189 void g_mount_unshadow (GMount *mount);
193 #endif /* __G_MOUNT_H__ */