gvolume.h 11.4 KB
Newer Older
1
/* GIO - GLib Input, Output and Streaming Library
2
 *
3 4 5 6 7
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * 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 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 23 24
#ifndef __G_VOLUME_H__
#define __G_VOLUME_H__

25 26 27 28
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif

29
#include <gio/giotypes.h>
30 31 32

G_BEGIN_DECLS

33 34 35 36 37
/**
 * G_VOLUME_IDENTIFIER_KIND_HAL_UDI:
 *
 * The string used to obtain a Hal UDI with g_volume_get_identifier().
 */
38
#define G_VOLUME_IDENTIFIER_KIND_HAL_UDI "hal-udi"
39 40 41 42 43 44

/**
 * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE:
 *
 * The string used to obtain a Unix device path with g_volume_get_identifier().
 */
45
#define G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE "unix-device"
46 47 48 49 50 51

/**
 * G_VOLUME_IDENTIFIER_KIND_LABEL:
 *
 * The string used to obtain a filesystem label with g_volume_get_identifier().
 */
52
#define G_VOLUME_IDENTIFIER_KIND_LABEL "label"
53 54 55 56 57 58

/**
 * G_VOLUME_IDENTIFIER_KIND_UUID:
 *
 * The string used to obtain a UUID with g_volume_get_identifier().
 */
59
#define G_VOLUME_IDENTIFIER_KIND_UUID "uuid"
60 61 62 63 64 65

/**
 * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT:
 *
 * The string used to obtain a NFS mount with g_volume_get_identifier().
 */
66 67
#define G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT "nfs-mount"

68 69 70
/**
 * G_VOLUME_IDENTIFIER_KIND_CLASS:
 *
71
 * The string used to obtain the volume class with g_volume_get_identifier().
72
 *
73 74
 * Known volume classes include `device` and `network`. Other classes may
 * be added in the future.
75 76 77
 *
 * This is intended to be used by applications to classify #GVolume
 * instances into different sections - for example a file manager or
78 79
 * file chooser can use this information to show `network` volumes under
 * a "Network" heading and `device` volumes under a "Devices" heading.
80 81 82
 */
#define G_VOLUME_IDENTIFIER_KIND_CLASS "class"

83

84 85 86 87 88
#define G_TYPE_VOLUME            (g_volume_get_type ())
#define G_VOLUME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_VOLUME, GVolume))
#define G_IS_VOLUME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_VOLUME))
#define G_VOLUME_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface))

89 90 91 92
/**
 * GVolumeIface:
 * @g_iface: The parent interface.
 * @changed: Changed signal that is emitted when the volume's state has changed.
93
 * @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.
94 95
 * @get_name: Gets a string containing the name of the #GVolume.
 * @get_icon: Gets a #GIcon for the #GVolume.
96
 * @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.
97 98 99
 * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
 * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
 * @can_mount: Returns %TRUE if the #GVolume can be mounted.
100
 * @can_eject: Checks if a #GVolume can be ejected.
101 102 103 104
 * @mount_fn: Mounts a given #GVolume. 
 *     #GVolume implementations must emit the #GMountOperation::aborted 
 *     signal before completing a mount operation that is aborted while 
 *     awaiting input from the user through a #GMountOperation instance.
105
 * @mount_finish: Finishes a mount operation.
106 107
 * @eject: Ejects a given #GVolume.
 * @eject_finish: Finishes an eject operation.
108
 * @get_identifier: Returns the [identifier][volume-identifier] of the given kind, or %NULL if
Matthias Clasen's avatar
Matthias Clasen committed
109 110
 *    the #GVolume doesn't have one.
 * @enumerate_identifiers: Returns an array strings listing the kinds
111
 *    of [identifiers][volume-identifier] which the #GVolume has.
112
 * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted.
113 114
 * @get_activation_root: Returns the activation root for the #GVolume if it is known in advance or %NULL if
 *   it is not known.
115 116
 * @eject_with_operation: Starts ejecting a #GVolume using a #GMountOperation. Since 2.22.
 * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
117
 * @get_sort_key: Gets a key used for sorting #GVolume instance or %NULL if no such key exists. Since 2.32.
118
 * @get_symbolic_icon: Gets a symbolic #GIcon for the #GVolume. Since 2.34.
119
 *
120
 * Interface for implementing operations for mountable volumes.
121
 **/
122 123
typedef struct _GVolumeIface    GVolumeIface;

124 125 126 127 128 129
struct _GVolumeIface
{
  GTypeInterface g_iface;

  /* signals */

130 131 132
  void        (* changed)               (GVolume             *volume);
  void        (* removed)               (GVolume             *volume);

133 134
  /* Virtual Table */

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
  char      * (* get_name)              (GVolume             *volume);
  GIcon     * (* get_icon)              (GVolume             *volume);
  char      * (* get_uuid)              (GVolume             *volume);
  GDrive    * (* get_drive)             (GVolume             *volume);
  GMount    * (* get_mount)             (GVolume             *volume);
  gboolean    (* can_mount)             (GVolume             *volume);
  gboolean    (* can_eject)             (GVolume             *volume);
  void        (* mount_fn)              (GVolume             *volume,
                                         GMountMountFlags     flags,
                                         GMountOperation     *mount_operation,
                                         GCancellable        *cancellable,
                                         GAsyncReadyCallback  callback,
                                         gpointer             user_data);
  gboolean    (* mount_finish)          (GVolume             *volume,
                                         GAsyncResult        *result,
                                         GError             **error);
  void        (* eject)                 (GVolume             *volume,
                                         GMountUnmountFlags   flags,
                                         GCancellable        *cancellable,
                                         GAsyncReadyCallback  callback,
                                         gpointer             user_data);
  gboolean    (* eject_finish)          (GVolume             *volume,
                                         GAsyncResult        *result,
                                         GError             **error);

  char      * (* get_identifier)        (GVolume             *volume,
                                         const char          *kind);
  char     ** (* enumerate_identifiers) (GVolume             *volume);

  gboolean    (* should_automount)      (GVolume             *volume);

  GFile     * (* get_activation_root)   (GVolume             *volume);

168 169 170 171 172 173 174 175 176
  void        (* eject_with_operation)      (GVolume             *volume,
                                             GMountUnmountFlags   flags,
                                             GMountOperation     *mount_operation,
                                             GCancellable        *cancellable,
                                             GAsyncReadyCallback  callback,
                                             gpointer             user_data);
  gboolean    (* eject_with_operation_finish) (GVolume           *volume,
                                             GAsyncResult        *result,
                                             GError             **error);
177 178

  const gchar * (* get_sort_key)        (GVolume             *volume);
179
  GIcon       * (* get_symbolic_icon)   (GVolume             *volume);
180 181
};

182
GLIB_AVAILABLE_IN_ALL
183
GType    g_volume_get_type              (void) G_GNUC_CONST;
184

185
GLIB_AVAILABLE_IN_ALL
186
char *   g_volume_get_name              (GVolume              *volume);
187
GLIB_AVAILABLE_IN_ALL
188
GIcon *  g_volume_get_icon              (GVolume              *volume);
189
GLIB_AVAILABLE_IN_ALL
190
GIcon *  g_volume_get_symbolic_icon     (GVolume              *volume);
191
GLIB_AVAILABLE_IN_ALL
192
char *   g_volume_get_uuid              (GVolume              *volume);
193
GLIB_AVAILABLE_IN_ALL
194
GDrive * g_volume_get_drive             (GVolume              *volume);
195
GLIB_AVAILABLE_IN_ALL
196
GMount * g_volume_get_mount             (GVolume              *volume);
197
GLIB_AVAILABLE_IN_ALL
198
gboolean g_volume_can_mount             (GVolume              *volume);
199
GLIB_AVAILABLE_IN_ALL
200
gboolean g_volume_can_eject             (GVolume              *volume);
201
GLIB_AVAILABLE_IN_ALL
202
gboolean g_volume_should_automount      (GVolume              *volume);
203
GLIB_AVAILABLE_IN_ALL
204
void     g_volume_mount                 (GVolume              *volume,
205
					 GMountMountFlags      flags,
206 207 208 209
					 GMountOperation      *mount_operation,
					 GCancellable         *cancellable,
					 GAsyncReadyCallback   callback,
					 gpointer              user_data);
210
GLIB_AVAILABLE_IN_ALL
211 212 213
gboolean g_volume_mount_finish          (GVolume              *volume,
					 GAsyncResult         *result,
					 GError              **error);
214
GLIB_DEPRECATED_FOR(g_volume_eject_with_operation)
215
void     g_volume_eject                 (GVolume              *volume,
216 217 218
                                         GMountUnmountFlags    flags,
                                         GCancellable         *cancellable,
                                         GAsyncReadyCallback   callback,
219 220 221
                                         gpointer              user_data);

GLIB_DEPRECATED_FOR(g_volume_eject_with_operation_finish)
222
gboolean g_volume_eject_finish          (GVolume              *volume,
223
                                         GAsyncResult         *result,
224
                                         GError              **error);
225
GLIB_AVAILABLE_IN_ALL
226 227
char *   g_volume_get_identifier        (GVolume              *volume,
					 const char           *kind);
228
GLIB_AVAILABLE_IN_ALL
229 230
char **  g_volume_enumerate_identifiers (GVolume              *volume);

231
GLIB_AVAILABLE_IN_ALL
232 233
GFile *  g_volume_get_activation_root   (GVolume              *volume);

234
GLIB_AVAILABLE_IN_ALL
235 236 237 238 239 240
void        g_volume_eject_with_operation     (GVolume             *volume,
                                               GMountUnmountFlags   flags,
                                               GMountOperation     *mount_operation,
                                               GCancellable        *cancellable,
                                               GAsyncReadyCallback  callback,
                                               gpointer             user_data);
241
GLIB_AVAILABLE_IN_ALL
242 243 244 245
gboolean    g_volume_eject_with_operation_finish (GVolume          *volume,
                                               GAsyncResult        *result,
                                               GError             **error);

246
GLIB_AVAILABLE_IN_2_32
247 248
const gchar *g_volume_get_sort_key            (GVolume              *volume);

249 250 251
G_END_DECLS

#endif /* __G_VOLUME_H__ */