Portability | portable (depends on GHC) |
---|---|
Stability | alpha |
Maintainer | gtk2hs-devel@lists.sourceforge.net |
- data Volume
- class GObjectClass o => VolumeClass o
- type VolumeID = CULong
- castToVolume :: GObjectClass obj => obj -> Volume
- volumeCompare :: (VolumeClass volume1, VolumeClass volume2) => volume1 -> volume2 -> IO Ordering
- volumeEject :: VolumeClass volume => volume -> VolumeOpSuccessCallback -> VolumeOpFailureCallback -> IO ()
- volumeGetActivationURI :: VolumeClass volume => volume -> IO TextURI
- volumeGetDevicePath :: VolumeClass volume => volume -> IO String
- volumeGetDeviceType :: VolumeClass volume => volume -> IO DeviceType
- volumeGetDisplayName :: VolumeClass volume => volume -> IO String
- volumeGetDrive :: VolumeClass volume => volume -> IO Drive
- volumeGetFilesystemType :: VolumeClass volume => volume -> IO (Maybe String)
- volumeGetHalUDI :: VolumeClass volume => volume -> IO (Maybe String)
- volumeGetIcon :: VolumeClass volume => volume -> IO FilePath
- volumeGetID :: VolumeClass volume => volume -> IO VolumeID
- volumeGetVolumeType :: VolumeClass volume => volume -> IO VolumeType
- volumeHandlesTrash :: VolumeClass volume => volume -> IO Bool
- volumeIsMounted :: VolumeClass volume => volume -> IO Bool
- volumeIsReadOnly :: VolumeClass volume => volume -> IO Bool
- volumeIsUserVisible :: VolumeClass volume => volume -> IO Bool
- volumeUnmount :: VolumeClass volume => volume -> VolumeOpSuccessCallback -> VolumeOpFailureCallback -> IO ()
Types
An abstraction for a mounted filesystem or network location.
class GObjectClass o => VolumeClass o Source
Safely cast an object to a Volume
.
castToVolume :: GObjectClass obj => obj -> VolumeSource
Volume Operations
volumeCompare :: (VolumeClass volume1, VolumeClass volume2) => volume1 -> volume2 -> IO OrderingSource
Compares two Volume
objects a
and b
. Two Volume
objects referring to different volumes are guaranteed to not
return EQ
when comparing them. If they refer to the same volume EQ
is returned.
The resulting gint should be used to determine the order in which
a
and b
are displayed in graphical user interfaces.
The comparison algorithm first of all peeks the device type of
a
and b
, they will be sorted in the following order:
- Magnetic and opto-magnetic volumes (ZIP, floppy)
- Optical volumes (CD, DVD)
- External volumes (USB sticks, music players)
- Mounted hard disks
- Network mounts
- Other volumes
Afterwards, the display name of a
and b
is compared using a
locale-sensitive sorting algorithm.
If two volumes have the same display name, their unique ID is
compared which can be queried using volumeGetID
.
:: VolumeClass volume | |
=> volume |
|
-> VolumeOpSuccessCallback |
|
-> VolumeOpFailureCallback |
|
-> IO () |
:: VolumeClass volume | |
=> volume |
|
-> IO TextURI | the volume's activation URI. |
Returns the activation URI of volume
.
The returned URI usually refers to a valid location. You can
check the validity of the location by calling
System.Gnome.VFS.URI.uriFromString
with the URI, and checking
whether the return value is not Nothing
.
:: VolumeClass volume | |
=> volume |
|
-> IO String | the volume's device path |
:: VolumeClass volume | |
=> volume |
|
-> IO DeviceType |
Returns the DeviceType
of a Volume
object.
:: VolumeClass volume | |
=> volume |
|
-> IO String | the volume's display name |
Returns the display name of a Volume
object.
:: VolumeClass volume | |
=> volume |
|
-> IO Drive | the containing drive |
Returns the Drive
that volume
is on.
:: VolumeClass volume | |
=> volume |
|
-> IO (Maybe String) | a string describing
the filesystem type,
or |
Returns a string describing the file system on volume
, or
Nothing
if no information on the underlying file system is
available.
The file system may be used to provide special functionality that
depends on the file system type, for instance to determine
whether trashing is supported (cf. volumeHandlesTrash
).
For HAL mounts, this returns the value of the "volume.fstype"
key, for traditional UNIX mounts it is set to the mntent's
mnt_type key, for connected servers, Nothing
is returned.
:: VolumeClass volume | |
=> volume |
|
-> IO (Maybe String) | the volume's HAL UDI |
:: VolumeClass volume | |
=> volume |
|
-> IO FilePath | the icon that should be used for this volume |
Returns the icon filename for a Volume
object.
:: VolumeClass volume | |
=> volume |
|
-> IO VolumeID | a unique identifier for the volume |
Returns a unique identifier for a Volume
object.
:: VolumeClass volume | |
=> volume |
|
-> IO VolumeType | the volume's volume type |
Returns the volume type of volume
.
:: VolumeClass volume | |
=> volume |
|
-> IO Bool |
Returns whether the file system on a volume supports trashing of files.
If the volume has an AutoFS file system (i.e.,
volumeGetDeviceType
returns DeviceTypeAutofs
), or if the
volume is mounted read-only (i.e., volumeIsReadOnly
returns
True
), it is assumed to not support trashing of files.
Otherwise, if the volume provides file system information, it is determined whether the file system supports trashing of files.
:: VolumeClass volume | |
=> volume |
|
-> IO Bool |
Returns whether the file system on a volume is currently mounted.
For HAL volumes, this reflects the value of the
"volume.is_mounted"
key, for traditional UNIX mounts and
connected servers, True
is returned, because their existence
implies that they are mounted.
:: VolumeClass volume | |
=> volume |
|
-> IO Bool |
Returns whether the file system on a volume is read-only.
For HAL volumes, the "volume.is_mounted_read_only"
key is
authoritative, for traditional UNIX mounts it returns (!(0)) if the
mount was done with the "ro"
option. For servers, False
is
returned.
:: VolumeClass volume | |
=> volume | |
-> IO Bool |
Returns a Bool
for whether a volume is user-visible. This should
be used by applications to determine whether the volume should be
listed in user interfaces listing available volumes.
:: VolumeClass volume | |
=> volume |
|
-> VolumeOpSuccessCallback |
|
-> VolumeOpFailureCallback |
|
-> IO () |