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.1 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, see <http://www.gnu.org/licenses/>.
17 *
18 * Author: Alexander Larsson <alexl@redhat.com>
19 * David Zeuthen <davidz@redhat.com>
20 */
21
22#ifndef __G_VOLUME_H__
23#define __G_VOLUME_H__
24
25#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
26#error "Only <gio/gio.h> can be included directly."
27#endif
28
29#include <gio/giotypes.h>
30
31G_BEGIN_DECLS
32
33/**
34 * G_VOLUME_IDENTIFIER_KIND_HAL_UDI:
35 *
36 * The string used to obtain a Hal UDI with g_volume_get_identifier().
37 *
38 * Deprecated: 2.58: Do not use, HAL is deprecated.
39 */
40#define G_VOLUME_IDENTIFIER_KIND_HAL_UDI "hal-udi" GLIB_DEPRECATED_MACRO_IN_2_58
41
42/**
43 * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE:
44 *
45 * The string used to obtain a Unix device path with g_volume_get_identifier().
46 */
47#define G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE "unix-device"
48
49/**
50 * G_VOLUME_IDENTIFIER_KIND_LABEL:
51 *
52 * The string used to obtain a filesystem label with g_volume_get_identifier().
53 */
54#define G_VOLUME_IDENTIFIER_KIND_LABEL "label"
55
56/**
57 * G_VOLUME_IDENTIFIER_KIND_UUID:
58 *
59 * The string used to obtain a UUID with g_volume_get_identifier().
60 */
61#define G_VOLUME_IDENTIFIER_KIND_UUID "uuid"
62
63/**
64 * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT:
65 *
66 * The string used to obtain a NFS mount with g_volume_get_identifier().
67 */
68#define G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT "nfs-mount"
69
70/**
71 * G_VOLUME_IDENTIFIER_KIND_CLASS:
72 *
73 * The string used to obtain the volume class with g_volume_get_identifier().
74 *
75 * Known volume classes include `device`, `network`, and `loop`. Other
76 * classes may be added in the future.
77 *
78 * This is intended to be used by applications to classify #GVolume
79 * instances into different sections - for example a file manager or
80 * file chooser can use this information to show `network` volumes under
81 * a "Network" heading and `device` volumes under a "Devices" heading.
82 */
83#define G_VOLUME_IDENTIFIER_KIND_CLASS "class"
84
85
86#define G_TYPE_VOLUME (g_volume_get_type ())
87#define G_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_VOLUME, GVolume))
88#define G_IS_VOLUME(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_VOLUME))
89#define G_VOLUME_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface))
90
91/**
92 * GVolumeIface:
93 * @g_iface: The parent interface.
94 * @changed: Changed signal that is emitted when the volume's state has changed.
95 * @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.
96 * @get_name: Gets a string containing the name of the #GVolume.
97 * @get_icon: Gets a #GIcon for the #GVolume.
98 * @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.
99 * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
100 * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
101 * @can_mount: Returns %TRUE if the #GVolume can be mounted.
102 * @can_eject: Checks if a #GVolume can be ejected.
103 * @mount_fn: Mounts a given #GVolume.
104 * #GVolume implementations must emit the #GMountOperation::aborted
105 * signal before completing a mount operation that is aborted while
106 * awaiting input from the user through a #GMountOperation instance.
107 * @mount_finish: Finishes a mount operation.
108 * @eject: Ejects a given #GVolume.
109 * @eject_finish: Finishes an eject operation.
110 * @get_identifier: Returns the [identifier][volume-identifier] of the given kind, or %NULL if
111 * the #GVolume doesn't have one.
112 * @enumerate_identifiers: Returns an array strings listing the kinds
113 * of [identifiers][volume-identifier] which the #GVolume has.
114 * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted.
115 * @get_activation_root: Returns the activation root for the #GVolume if it is known in advance or %NULL if
116 * it is not known.
117 * @eject_with_operation: Starts ejecting a #GVolume using a #GMountOperation. Since 2.22.
118 * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
119 * @get_sort_key: Gets a key used for sorting #GVolume instance or %NULL if no such key exists. Since 2.32.
120 * @get_symbolic_icon: Gets a symbolic #GIcon for the #GVolume. Since 2.34.
121 *
122 * Interface for implementing operations for mountable volumes.
123 **/
124typedef struct _GVolumeIface GVolumeIface;
125
126struct _GVolumeIface
127{
128 GTypeInterface g_iface;
129
130 /* signals */
131
132 void (* changed) (GVolume *volume);
133 void (* removed) (GVolume *volume);
134
135 /* Virtual Table */
136
137 char * (* get_name) (GVolume *volume);
138 GIcon * (* get_icon) (GVolume *volume);
139 char * (* get_uuid) (GVolume *volume);
140 GDrive * (* get_drive) (GVolume *volume);
141 GMount * (* get_mount) (GVolume *volume);
142 gboolean (* can_mount) (GVolume *volume);
143 gboolean (* can_eject) (GVolume *volume);
144 void (* mount_fn) (GVolume *volume,
145 GMountMountFlags flags,
146 GMountOperation *mount_operation,
147 GCancellable *cancellable,
148 GAsyncReadyCallback callback,
149 gpointer user_data);
150 gboolean (* mount_finish) (GVolume *volume,
151 GAsyncResult *result,
152 GError **error);
153 void (* eject) (GVolume *volume,
154 GMountUnmountFlags flags,
155 GCancellable *cancellable,
156 GAsyncReadyCallback callback,
157 gpointer user_data);
158 gboolean (* eject_finish) (GVolume *volume,
159 GAsyncResult *result,
160 GError **error);
161
162 char * (* get_identifier) (GVolume *volume,
163 const char *kind);
164 char ** (* enumerate_identifiers) (GVolume *volume);
165
166 gboolean (* should_automount) (GVolume *volume);
167
168 GFile * (* get_activation_root) (GVolume *volume);
169
170 void (* eject_with_operation) (GVolume *volume,
171 GMountUnmountFlags flags,
172 GMountOperation *mount_operation,
173 GCancellable *cancellable,
174 GAsyncReadyCallback callback,
175 gpointer user_data);
176 gboolean (* eject_with_operation_finish) (GVolume *volume,
177 GAsyncResult *result,
178 GError **error);
179
180 const gchar * (* get_sort_key) (GVolume *volume);
181 GIcon * (* get_symbolic_icon) (GVolume *volume);
182};
183
184GLIB_AVAILABLE_IN_ALL
185GType g_volume_get_type (void) G_GNUC_CONST;
186
187GLIB_AVAILABLE_IN_ALL
188char * g_volume_get_name (GVolume *volume);
189GLIB_AVAILABLE_IN_ALL
190GIcon * g_volume_get_icon (GVolume *volume);
191GLIB_AVAILABLE_IN_ALL
192GIcon * g_volume_get_symbolic_icon (GVolume *volume);
193GLIB_AVAILABLE_IN_ALL
194char * g_volume_get_uuid (GVolume *volume);
195GLIB_AVAILABLE_IN_ALL
196GDrive * g_volume_get_drive (GVolume *volume);
197GLIB_AVAILABLE_IN_ALL
198GMount * g_volume_get_mount (GVolume *volume);
199GLIB_AVAILABLE_IN_ALL
200gboolean g_volume_can_mount (GVolume *volume);
201GLIB_AVAILABLE_IN_ALL
202gboolean g_volume_can_eject (GVolume *volume);
203GLIB_AVAILABLE_IN_ALL
204gboolean g_volume_should_automount (GVolume *volume);
205GLIB_AVAILABLE_IN_ALL
206void g_volume_mount (GVolume *volume,
207 GMountMountFlags flags,
208 GMountOperation *mount_operation,
209 GCancellable *cancellable,
210 GAsyncReadyCallback callback,
211 gpointer user_data);
212GLIB_AVAILABLE_IN_ALL
213gboolean g_volume_mount_finish (GVolume *volume,
214 GAsyncResult *result,
215 GError **error);
216GLIB_DEPRECATED_FOR(g_volume_eject_with_operation)
217void g_volume_eject (GVolume *volume,
218 GMountUnmountFlags flags,
219 GCancellable *cancellable,
220 GAsyncReadyCallback callback,
221 gpointer user_data);
222
223GLIB_DEPRECATED_FOR(g_volume_eject_with_operation_finish)
224gboolean g_volume_eject_finish (GVolume *volume,
225 GAsyncResult *result,
226 GError **error);
227GLIB_AVAILABLE_IN_ALL
228char * g_volume_get_identifier (GVolume *volume,
229 const char *kind);
230GLIB_AVAILABLE_IN_ALL
231char ** g_volume_enumerate_identifiers (GVolume *volume);
232
233GLIB_AVAILABLE_IN_ALL
234GFile * g_volume_get_activation_root (GVolume *volume);
235
236GLIB_AVAILABLE_IN_ALL
237void g_volume_eject_with_operation (GVolume *volume,
238 GMountUnmountFlags flags,
239 GMountOperation *mount_operation,
240 GCancellable *cancellable,
241 GAsyncReadyCallback callback,
242 gpointer user_data);
243GLIB_AVAILABLE_IN_ALL
244gboolean g_volume_eject_with_operation_finish (GVolume *volume,
245 GAsyncResult *result,
246 GError **error);
247
248GLIB_AVAILABLE_IN_2_32
249const gchar *g_volume_get_sort_key (GVolume *volume);
250
251G_END_DECLS
252
253#endif /* __G_VOLUME_H__ */
254