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 #ifndef __G_VOLUME_H__
25 #define __G_VOLUME_H__
27 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
28 #error "Only <gio/gio.h> can be included directly."
31 #include <gio/giotypes.h>
36 * G_VOLUME_IDENTIFIER_KIND_HAL_UDI:
38 * The string used to obtain a Hal UDI with g_volume_get_identifier().
40 #define G_VOLUME_IDENTIFIER_KIND_HAL_UDI "hal-udi"
43 * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE:
45 * The string used to obtain a Unix device path with g_volume_get_identifier().
47 #define G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE "unix-device"
50 * G_VOLUME_IDENTIFIER_KIND_LABEL:
52 * The string used to obtain a filesystem label with g_volume_get_identifier().
54 #define G_VOLUME_IDENTIFIER_KIND_LABEL "label"
57 * G_VOLUME_IDENTIFIER_KIND_UUID:
59 * The string used to obtain a UUID with g_volume_get_identifier().
61 #define G_VOLUME_IDENTIFIER_KIND_UUID "uuid"
64 * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT:
66 * The string used to obtain a NFS mount with g_volume_get_identifier().
68 #define G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT "nfs-mount"
71 * G_VOLUME_IDENTIFIER_KIND_CLASS:
73 * The string used to obtain the volume <emphasis>class</emphasis>
74 * with g_volume_get_identifier().
76 * Known volume classes include <literal>device</literal> and
77 * <literal>network</literal>. Other classes may be added in the
80 * This is intended to be used by applications to classify #GVolume
81 * instances into different sections - for example a file manager or
82 * file chooser can use this information to show
83 * <literal>network</literal> volumes under a "Network" heading and
84 * <literal>device</literal> volumes under a "Devices" heading.
86 #define G_VOLUME_IDENTIFIER_KIND_CLASS "class"
89 #define G_TYPE_VOLUME (g_volume_get_type ())
90 #define G_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_VOLUME, GVolume))
91 #define G_IS_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_VOLUME))
92 #define G_VOLUME_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface))
96 * @g_iface: The parent interface.
97 * @changed: Changed signal that is emitted when the volume's state has changed.
98 * @removed: The removed signal that is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized.
99 * @get_name: Gets a string containing the name of the #GVolume.
100 * @get_icon: Gets a #GIcon for the #GVolume.
101 * @get_uuid: Gets the UUID for the #GVolume. 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.
102 * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
103 * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
104 * @can_mount: Returns %TRUE if the #GVolume can be mounted.
105 * @can_eject: Checks if a #GVolume can be ejected.
106 * @mount_fn: Mounts a given #GVolume.
107 * #GVolume implementations must emit the #GMountOperation::aborted
108 * signal before completing a mount operation that is aborted while
109 * awaiting input from the user through a #GMountOperation instance.
110 * @mount_finish: Finishes a mount operation.
111 * @eject: Ejects a given #GVolume.
112 * @eject_finish: Finishes an eject operation.
113 * @get_identifier: Returns the <link linkend="volume-identifier">identifier</link> of the given kind, or %NULL if
114 * the #GVolume doesn't have one.
115 * @enumerate_identifiers: Returns an array strings listing the kinds
116 * of <link linkend="volume-identifier">identifiers</link> which the #GVolume has.
117 * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted.
118 * @get_activation_root: Returns the activation root for the #GVolume if it is known in advance or %NULL if
120 * @eject_with_operation: Starts ejecting a #GVolume using a #GMountOperation. Since 2.22.
121 * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
122 * @get_sort_key: Gets a key used for sorting #GVolume instance or %NULL if no such key exists. Since 2.32.
123 * @get_symbolic_icon: Gets a symbolic #GIcon for the #GVolume. Since 2.34.
125 * Interface for implementing operations for mountable volumes.
127 typedef struct _GVolumeIface GVolumeIface
;
131 GTypeInterface g_iface
;
135 void (* changed
) (GVolume
*volume
);
136 void (* removed
) (GVolume
*volume
);
140 char * (* get_name
) (GVolume
*volume
);
141 GIcon
* (* get_icon
) (GVolume
*volume
);
142 char * (* get_uuid
) (GVolume
*volume
);
143 GDrive
* (* get_drive
) (GVolume
*volume
);
144 GMount
* (* get_mount
) (GVolume
*volume
);
145 gboolean (* can_mount
) (GVolume
*volume
);
146 gboolean (* can_eject
) (GVolume
*volume
);
147 void (* mount_fn
) (GVolume
*volume
,
148 GMountMountFlags flags
,
149 GMountOperation
*mount_operation
,
150 GCancellable
*cancellable
,
151 GAsyncReadyCallback callback
,
153 gboolean (* mount_finish
) (GVolume
*volume
,
154 GAsyncResult
*result
,
156 void (* eject
) (GVolume
*volume
,
157 GMountUnmountFlags flags
,
158 GCancellable
*cancellable
,
159 GAsyncReadyCallback callback
,
161 gboolean (* eject_finish
) (GVolume
*volume
,
162 GAsyncResult
*result
,
165 char * (* get_identifier
) (GVolume
*volume
,
167 char ** (* enumerate_identifiers
) (GVolume
*volume
);
169 gboolean (* should_automount
) (GVolume
*volume
);
171 GFile
* (* get_activation_root
) (GVolume
*volume
);
173 void (* eject_with_operation
) (GVolume
*volume
,
174 GMountUnmountFlags flags
,
175 GMountOperation
*mount_operation
,
176 GCancellable
*cancellable
,
177 GAsyncReadyCallback callback
,
179 gboolean (* eject_with_operation_finish
) (GVolume
*volume
,
180 GAsyncResult
*result
,
183 const gchar
* (* get_sort_key
) (GVolume
*volume
);
184 GIcon
* (* get_symbolic_icon
) (GVolume
*volume
);
187 GLIB_AVAILABLE_IN_ALL
188 GType
g_volume_get_type (void) G_GNUC_CONST
;
190 GLIB_AVAILABLE_IN_ALL
191 char * g_volume_get_name (GVolume
*volume
);
192 GLIB_AVAILABLE_IN_ALL
193 GIcon
* g_volume_get_icon (GVolume
*volume
);
194 GLIB_AVAILABLE_IN_ALL
195 GIcon
* g_volume_get_symbolic_icon (GVolume
*volume
);
196 GLIB_AVAILABLE_IN_ALL
197 char * g_volume_get_uuid (GVolume
*volume
);
198 GLIB_AVAILABLE_IN_ALL
199 GDrive
* g_volume_get_drive (GVolume
*volume
);
200 GLIB_AVAILABLE_IN_ALL
201 GMount
* g_volume_get_mount (GVolume
*volume
);
202 GLIB_AVAILABLE_IN_ALL
203 gboolean
g_volume_can_mount (GVolume
*volume
);
204 GLIB_AVAILABLE_IN_ALL
205 gboolean
g_volume_can_eject (GVolume
*volume
);
206 GLIB_AVAILABLE_IN_ALL
207 gboolean
g_volume_should_automount (GVolume
*volume
);
208 GLIB_AVAILABLE_IN_ALL
209 void g_volume_mount (GVolume
*volume
,
210 GMountMountFlags flags
,
211 GMountOperation
*mount_operation
,
212 GCancellable
*cancellable
,
213 GAsyncReadyCallback callback
,
215 GLIB_AVAILABLE_IN_ALL
216 gboolean
g_volume_mount_finish (GVolume
*volume
,
217 GAsyncResult
*result
,
219 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation
)
220 void g_volume_eject (GVolume
*volume
,
221 GMountUnmountFlags flags
,
222 GCancellable
*cancellable
,
223 GAsyncReadyCallback callback
,
226 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation_finish
)
227 gboolean
g_volume_eject_finish (GVolume
*volume
,
228 GAsyncResult
*result
,
230 GLIB_AVAILABLE_IN_ALL
231 char * g_volume_get_identifier (GVolume
*volume
,
233 GLIB_AVAILABLE_IN_ALL
234 char ** g_volume_enumerate_identifiers (GVolume
*volume
);
236 GLIB_AVAILABLE_IN_ALL
237 GFile
* g_volume_get_activation_root (GVolume
*volume
);
239 GLIB_AVAILABLE_IN_ALL
240 void g_volume_eject_with_operation (GVolume
*volume
,
241 GMountUnmountFlags flags
,
242 GMountOperation
*mount_operation
,
243 GCancellable
*cancellable
,
244 GAsyncReadyCallback callback
,
246 GLIB_AVAILABLE_IN_ALL
247 gboolean
g_volume_eject_with_operation_finish (GVolume
*volume
,
248 GAsyncResult
*result
,
251 GLIB_AVAILABLE_IN_2_32
252 const gchar
*g_volume_get_sort_key (GVolume
*volume
);
256 #endif /* __G_VOLUME_H__ */