File: gnome-vfs-volume.h

package info (click to toggle)
gnome-vfs 1%3A2.24.4-6
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 17,120 kB
  • ctags: 10,397
  • sloc: ansic: 78,516; sh: 10,341; makefile: 902; perl: 99
file content (194 lines) | stat: -rw-r--r-- 8,542 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* gnome-vfs-volume.h - Handling of volumes for the GNOME Virtual File System.

   Copyright (C) 2003 Red Hat, Inc

   The Gnome Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The Gnome 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the Gnome Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.

   Author: Alexander Larsson <alexl@redhat.com>
*/

#ifndef GNOME_VFS_VOLUME_H
#define GNOME_VFS_VOLUME_H

#include <sys/types.h>
#include <sys/stat.h>
#ifndef _WIN32
#include <unistd.h>
#endif
#include <glib-object.h>

G_BEGIN_DECLS

#define GNOME_VFS_TYPE_VOLUME        (gnome_vfs_volume_get_type ())
#define GNOME_VFS_VOLUME(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), GNOME_VFS_TYPE_VOLUME, GnomeVFSVolume))
#define GNOME_VFS_VOLUME_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), GNOME_VFS_TYPE_VOLUME, GnomeVFSVolumeClass))
#define GNOME_IS_VFS_VOLUME(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNOME_VFS_TYPE_VOLUME))
#define GNOME_IS_VFS_VOLUME_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GNOME_VFS_TYPE_VOLUME))

typedef struct _GnomeVFSVolumePrivate GnomeVFSVolumePrivate;

typedef struct _GnomeVFSVolume GnomeVFSVolume;

struct _GnomeVFSVolume {
	GObject parent;

	/*< private >*/
        GnomeVFSVolumePrivate *priv;
};

typedef struct _GnomeVFSVolumeClass GnomeVFSVolumeClass;

struct _GnomeVFSVolumeClass {
	GObjectClass parent_class;
};

/**
 * GnomeVFSDeviceType:
 * @GNOME_VFS_DEVICE_TYPE_UNKNOWN: the type of this #GnomeVFSVolume or #GnomeVFSDrive is not known.
 * @GNOME_VFS_DEVICE_TYPE_AUDIO_CD: only used for #GnomeVFSVolume objects. Denotes that this
 * volume is an audio CD.
 * @GNOME_VFS_DEVICE_TYPE_VIDEO_DVD: only used for #GnomeVFSVolume objects. Denotes that this
 * volume is a video DVD.
 * @GNOME_VFS_DEVICE_TYPE_HARDDRIVE: this is a mount point refering to a harddisk partition that
 * neither has a Microsoft file system (FAT, VFAT, NTFS) nor an Apple file system (HFS, HFS+).
 * @GNOME_VFS_DEVICE_TYPE_CDROM: this may either be a mount point or a HAL drive/volume. Either way,
 * it refers to a CD-ROM device respectively volume.
 * @GNOME_VFS_DEVICE_TYPE_FLOPPY: the volume or drive referenced by this #GnomeVFSVolume or
 * #GnomeVFSDrive is a floppy disc respectively a floppy drive.
 * @GNOME_VFS_DEVICE_TYPE_ZIP: the volume or drive referenced by this #GnomeVFSVolume or
 * #GnomeVFSDrive is a ZIP disc respectively a ZIP drive.
 * @GNOME_VFS_DEVICE_TYPE_JAZ: the volume or drive referenced by this #GnomeVFSVolume or
 * #GnomeVFSDrive is a JAZ disc respectively a JAZ drive.
 * @GNOME_VFS_DEVICE_TYPE_NFS: this is a mount point having an NFS file system.
 * @GNOME_VFS_DEVICE_TYPE_AUTOFS: this is a mount point having an AutoFS file system.
 * @GNOME_VFS_DEVICE_TYPE_CAMERA: only used for #GnomeVFSVolume objects. Denotes that this volume is a camera.
 * @GNOME_VFS_DEVICE_TYPE_MEMORY_STICK: only used for #GnomeVFSVolume objects. Denotes that this volume is a memory stick.
 * @GNOME_VFS_DEVICE_TYPE_SMB: this is a mount point having a Samba file system.
 * @GNOME_VFS_DEVICE_TYPE_APPLE: this is a mount point refering to a harddisk partition, that has an
 * Apple file system (HFS, HFS+).
 * @GNOME_VFS_DEVICE_TYPE_MUSIC_PLAYER: only used for #GnomeVFSVolume objects. Denotes that this
 * volume is a music player.
 * @GNOME_VFS_DEVICE_TYPE_WINDOWS: this is a mount point refering to a harddisk partition, that has a
 * Microsoft file system (FAT, VFAT, NTFS).
 * @GNOME_VFS_DEVICE_TYPE_LOOPBACK: this is a mount point refering to a loopback device.
 * @GNOME_VFS_DEVICE_TYPE_NETWORK: only used for #GnomeVFSVolume objects, denoting that this volume
 * refers to a network mount that is not managed by the kernel VFS but exclusively known to GnomeVFS.
 *
 * Identifies the device type of a #GnomeVFSVolume or a #GnomeVFSDrive.
 **/
typedef enum {
	GNOME_VFS_DEVICE_TYPE_UNKNOWN,
	GNOME_VFS_DEVICE_TYPE_AUDIO_CD,
	GNOME_VFS_DEVICE_TYPE_VIDEO_DVD,
	GNOME_VFS_DEVICE_TYPE_HARDDRIVE, 
	GNOME_VFS_DEVICE_TYPE_CDROM,
	GNOME_VFS_DEVICE_TYPE_FLOPPY,
	GNOME_VFS_DEVICE_TYPE_ZIP,
	GNOME_VFS_DEVICE_TYPE_JAZ,
	GNOME_VFS_DEVICE_TYPE_NFS,
	GNOME_VFS_DEVICE_TYPE_AUTOFS,
	GNOME_VFS_DEVICE_TYPE_CAMERA,
	GNOME_VFS_DEVICE_TYPE_MEMORY_STICK,
	GNOME_VFS_DEVICE_TYPE_SMB,
	GNOME_VFS_DEVICE_TYPE_APPLE,
	GNOME_VFS_DEVICE_TYPE_MUSIC_PLAYER,
	GNOME_VFS_DEVICE_TYPE_WINDOWS, 
	GNOME_VFS_DEVICE_TYPE_LOOPBACK, 
	GNOME_VFS_DEVICE_TYPE_NETWORK 
} GnomeVFSDeviceType;

/**
 * @GNOME_VFS_VOLUME_TYPE_MOUNTPOINT: this is a mount point managed by the kernel.
 * @GNOME_VFS_VOLUME_TYPE_VFS_MOUNT: this is a special volume only known to GnomeVFS,
 * for instance a blank disk or an audio CD.
 * @GNOME_VFS_VOLUME_TYPE_CONNECTED_SERVER: this is a special volume only known
 * GnomeVFS, referring to a GnomeVFSURI network location, for instance a location
 * on an http, an ftp or an sftp server.
 *
 * Identifies the volume type of a #GnomeVFSVolume.
 **/
typedef enum {
	GNOME_VFS_VOLUME_TYPE_MOUNTPOINT,
	GNOME_VFS_VOLUME_TYPE_VFS_MOUNT,
	GNOME_VFS_VOLUME_TYPE_CONNECTED_SERVER
} GnomeVFSVolumeType;

/**
 * GnomeVFSVolumeOpCallback: 
 * @succeeded: whether the volume operation succeeded
 * @error: a string identifying the error that occurred, if
 * @succeeded is %FALSE. Otherwise %NULL.
 * @detailed_error: a string more specifically identifying
 * the error that occurred, if @succeeded is %FALSE.
 * Otherwise %NULL.
 * @user_data: the user data that was passed when registering
 * the callback.
 *
 * Note that if succeeded is FALSE and error, detailed_error are both
 * empty strings the client is not supposed to display a dialog as an
 * external mount/umount/eject helper will have done so.
 *
 * Since: 2.6
 **/
typedef void (*GnomeVFSVolumeOpCallback) (gboolean succeeded,
					  char *error,
					  char *detailed_error,
					  gpointer user_data);


/* Need to declare this here due to cross use in gnome-vfs-drive.h */
typedef struct _GnomeVFSDrive GnomeVFSDrive;

#include <libgnomevfs/gnome-vfs-drive.h>

GType gnome_vfs_volume_get_type (void) G_GNUC_CONST;

GnomeVFSVolume *gnome_vfs_volume_ref   (GnomeVFSVolume *volume);
void            gnome_vfs_volume_unref (GnomeVFSVolume *volume);

gulong             gnome_vfs_volume_get_id              (GnomeVFSVolume *volume);
GnomeVFSVolumeType gnome_vfs_volume_get_volume_type     (GnomeVFSVolume *volume);
GnomeVFSDeviceType gnome_vfs_volume_get_device_type     (GnomeVFSVolume *volume);
GnomeVFSDrive *    gnome_vfs_volume_get_drive           (GnomeVFSVolume *volume);
char *             gnome_vfs_volume_get_device_path     (GnomeVFSVolume *volume);
char *             gnome_vfs_volume_get_activation_uri  (GnomeVFSVolume *volume);
char *             gnome_vfs_volume_get_filesystem_type (GnomeVFSVolume *volume);
char *             gnome_vfs_volume_get_display_name    (GnomeVFSVolume *volume);
char *             gnome_vfs_volume_get_icon            (GnomeVFSVolume *volume);
char *             gnome_vfs_volume_get_hal_udi         (GnomeVFSVolume *volume);
gboolean           gnome_vfs_volume_is_user_visible     (GnomeVFSVolume *volume);
gboolean           gnome_vfs_volume_is_read_only        (GnomeVFSVolume *volume);
gboolean           gnome_vfs_volume_is_mounted          (GnomeVFSVolume *volume);
gboolean           gnome_vfs_volume_handles_trash       (GnomeVFSVolume *volume);

gint               gnome_vfs_volume_compare             (GnomeVFSVolume *a,
							 GnomeVFSVolume *b);


void gnome_vfs_volume_unmount    (GnomeVFSVolume           *volume,
				  GnomeVFSVolumeOpCallback  callback,
				  gpointer                  user_data);
void gnome_vfs_volume_eject      (GnomeVFSVolume           *volume,
				  GnomeVFSVolumeOpCallback  callback,
				  gpointer                  user_data);
void gnome_vfs_connect_to_server (const char               *uri,
				  const char               *display_name,
				  const char               *icon);

G_END_DECLS

#endif /* GNOME_VFS_VOLUME_H */