GI.Gio.Objects.VolumeMonitor

VolumeMonitor is for listing the user interesting devices and volumes on the computer. In other words, what a file selector or file manager would show in a sidebar.

VolumeMonitor is not [thread-default-context aware][g-main-context-push-thread-default], and so should not be used other than from the main thread, with no thread-default-context active.

Exported types

newtype VolumeMonitor

Constructors

VolumeMonitor (ManagedPtr VolumeMonitor)

Instances

GObject VolumeMonitor

Methods

gobjectType :: VolumeMonitor -> IO GType

IsObject VolumeMonitor

IsVolumeMonitor VolumeMonitor

class GObject o => IsVolumeMonitor o

Instances

(GObject a, UnknownAncestorError Constraint VolumeMonitor a) => IsVolumeMonitor a

IsVolumeMonitor VolumeMonitor

IsVolumeMonitor NativeVolumeMonitor

toVolumeMonitor :: (MonadIO m, IsVolumeMonitor o) => o -> m VolumeMonitor

noVolumeMonitor :: Maybe VolumeMonitor

Methods

adoptOrphanMount

volumeMonitorAdoptOrphanMount

Arguments

:: (HasCallStack, MonadIO m, IsMount a)

=> a

mount: a Mount object to find a parent for

-> m Volume

Returns: the Volume object that is the parent for mount or Nothing if no wants to adopt the Mount.

Deprecated: (Since version 2.20)Instead of using this function, VolumeMonitorimplementations should instead create shadow mounts with the URI ofthe mount they intend to adopt. See the proxy volume monitor ingvfs for an example of this. Also see mountIsShadowed,mountShadow and mountUnshadow functions.

This function should be called by any VolumeMonitor implementation when a new Mount object is created that is not associated with a Volume object. It must be called just before emitting the mountAdded signal.

If the return value is not Nothing, the caller must associate the returned Volume object with the Mount. This involves returning it in its mountGetVolume implementation. The caller must also listen for the "removed" signal on the returned object and give up its reference when handling that signal

Similary, if implementing volumeMonitorAdoptOrphanMount, the implementor must take a reference to mount and return it in its volumeGetMount implemented. Also, the implementor must listen for the "unmounted" signal on mount and give up its reference upon handling that signal.

There are two main use cases for this function.

One is when implementing a user space file system driver that reads blocks of a block device that is already represented by the native volume monitor (for example a CD Audio file system driver). Such a driver will generate its own Mount object that needs to be associated with the Volume object that represents the volume.

The other is for implementing a VolumeMonitor whose sole purpose is to return Volume objects representing entries in the users "favorite servers" list or similar.

get

volumeMonitorGet

Arguments

:: (HasCallStack, MonadIO m)

=> m VolumeMonitor

Returns: a reference to the VolumeMonitor used by gio. Call objectUnref when done with it.

Gets the volume monitor used by gio.

getConnectedDrives

volumeMonitorGetConnectedDrives

Arguments

:: (HasCallStack, MonadIO m, IsVolumeMonitor a)

=> a

volumeMonitor: a VolumeMonitor.

-> m [Drive]

Returns: a List of connected Drive objects.

Gets a list of drives connected to the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with objectUnref.

getMountForUuid

volumeMonitorGetMountForUuid

Arguments

:: (HasCallStack, MonadIO m, IsVolumeMonitor a)

=> a

volumeMonitor: a VolumeMonitor.

-> Text

uuid: the UUID to look for

-> m Mount

Returns: a Mount or Nothing if no such mount is available. Free the returned object with objectUnref.

Finds a Mount object by its UUID (see mountGetUuid)

getMounts

volumeMonitorGetMounts

Arguments

:: (HasCallStack, MonadIO m, IsVolumeMonitor a)

=> a

volumeMonitor: a VolumeMonitor.

-> m [Mount]

Returns: a List of Mount objects.

Gets a list of the mounts on the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with objectUnref.

getVolumeForUuid

volumeMonitorGetVolumeForUuid

Arguments

:: (HasCallStack, MonadIO m, IsVolumeMonitor a)

=> a

volumeMonitor: a VolumeMonitor.

-> Text

uuid: the UUID to look for

-> m Volume

Returns: a Volume or Nothing if no such volume is available. Free the returned object with objectUnref.

Finds a Volume object by its UUID (see volumeGetUuid)

getVolumes

volumeMonitorGetVolumes

Arguments

:: (HasCallStack, MonadIO m, IsVolumeMonitor a)

=> a

volumeMonitor: a VolumeMonitor.

-> m [Volume]

Returns: a List of Volume objects.

Gets a list of the volumes on the system.

The returned list should be freed with g_list_free(), after its elements have been unreffed with objectUnref.

Signals

driveChanged

type C_VolumeMonitorDriveChangedCallback = Ptr () -> Ptr Drive -> Ptr () -> IO ()

type VolumeMonitorDriveChangedCallback = Drive -> IO ()

afterVolumeMonitorDriveChanged :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveChangedCallback -> m SignalHandlerId

genClosure_VolumeMonitorDriveChanged :: VolumeMonitorDriveChangedCallback -> IO Closure

mk_VolumeMonitorDriveChangedCallback :: C_VolumeMonitorDriveChangedCallback -> IO (FunPtr C_VolumeMonitorDriveChangedCallback)

noVolumeMonitorDriveChangedCallback :: Maybe VolumeMonitorDriveChangedCallback

onVolumeMonitorDriveChanged :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveChangedCallback -> m SignalHandlerId

wrap_VolumeMonitorDriveChangedCallback :: VolumeMonitorDriveChangedCallback -> Ptr () -> Ptr Drive -> Ptr () -> IO ()

driveConnected

type C_VolumeMonitorDriveConnectedCallback = Ptr () -> Ptr Drive -> Ptr () -> IO ()

type VolumeMonitorDriveConnectedCallback = Drive -> IO ()

afterVolumeMonitorDriveConnected :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveConnectedCallback -> m SignalHandlerId

genClosure_VolumeMonitorDriveConnected :: VolumeMonitorDriveConnectedCallback -> IO Closure

mk_VolumeMonitorDriveConnectedCallback :: C_VolumeMonitorDriveConnectedCallback -> IO (FunPtr C_VolumeMonitorDriveConnectedCallback)

noVolumeMonitorDriveConnectedCallback :: Maybe VolumeMonitorDriveConnectedCallback

onVolumeMonitorDriveConnected :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveConnectedCallback -> m SignalHandlerId

wrap_VolumeMonitorDriveConnectedCallback :: VolumeMonitorDriveConnectedCallback -> Ptr () -> Ptr Drive -> Ptr () -> IO ()

driveDisconnected

type C_VolumeMonitorDriveDisconnectedCallback = Ptr () -> Ptr Drive -> Ptr () -> IO ()

type VolumeMonitorDriveDisconnectedCallback = Drive -> IO ()

afterVolumeMonitorDriveDisconnected :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveDisconnectedCallback -> m SignalHandlerId

genClosure_VolumeMonitorDriveDisconnected :: VolumeMonitorDriveDisconnectedCallback -> IO Closure

mk_VolumeMonitorDriveDisconnectedCallback :: C_VolumeMonitorDriveDisconnectedCallback -> IO (FunPtr C_VolumeMonitorDriveDisconnectedCallback)

noVolumeMonitorDriveDisconnectedCallback :: Maybe VolumeMonitorDriveDisconnectedCallback

onVolumeMonitorDriveDisconnected :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveDisconnectedCallback -> m SignalHandlerId

wrap_VolumeMonitorDriveDisconnectedCallback :: VolumeMonitorDriveDisconnectedCallback -> Ptr () -> Ptr Drive -> Ptr () -> IO ()

driveEjectButton

type C_VolumeMonitorDriveEjectButtonCallback = Ptr () -> Ptr Drive -> Ptr () -> IO ()

type VolumeMonitorDriveEjectButtonCallback = Drive -> IO ()

afterVolumeMonitorDriveEjectButton :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveEjectButtonCallback -> m SignalHandlerId

genClosure_VolumeMonitorDriveEjectButton :: VolumeMonitorDriveEjectButtonCallback -> IO Closure

mk_VolumeMonitorDriveEjectButtonCallback :: C_VolumeMonitorDriveEjectButtonCallback -> IO (FunPtr C_VolumeMonitorDriveEjectButtonCallback)

noVolumeMonitorDriveEjectButtonCallback :: Maybe VolumeMonitorDriveEjectButtonCallback

onVolumeMonitorDriveEjectButton :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveEjectButtonCallback -> m SignalHandlerId

wrap_VolumeMonitorDriveEjectButtonCallback :: VolumeMonitorDriveEjectButtonCallback -> Ptr () -> Ptr Drive -> Ptr () -> IO ()

driveStopButton

type C_VolumeMonitorDriveStopButtonCallback = Ptr () -> Ptr Drive -> Ptr () -> IO ()

type VolumeMonitorDriveStopButtonCallback = Drive -> IO ()

afterVolumeMonitorDriveStopButton :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveStopButtonCallback -> m SignalHandlerId

genClosure_VolumeMonitorDriveStopButton :: VolumeMonitorDriveStopButtonCallback -> IO Closure

mk_VolumeMonitorDriveStopButtonCallback :: C_VolumeMonitorDriveStopButtonCallback -> IO (FunPtr C_VolumeMonitorDriveStopButtonCallback)

noVolumeMonitorDriveStopButtonCallback :: Maybe VolumeMonitorDriveStopButtonCallback

onVolumeMonitorDriveStopButton :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorDriveStopButtonCallback -> m SignalHandlerId

wrap_VolumeMonitorDriveStopButtonCallback :: VolumeMonitorDriveStopButtonCallback -> Ptr () -> Ptr Drive -> Ptr () -> IO ()

mountAdded

type C_VolumeMonitorMountAddedCallback = Ptr () -> Ptr Mount -> Ptr () -> IO ()

type VolumeMonitorMountAddedCallback = Mount -> IO ()

afterVolumeMonitorMountAdded :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountAddedCallback -> m SignalHandlerId

genClosure_VolumeMonitorMountAdded :: VolumeMonitorMountAddedCallback -> IO Closure

mk_VolumeMonitorMountAddedCallback :: C_VolumeMonitorMountAddedCallback -> IO (FunPtr C_VolumeMonitorMountAddedCallback)

noVolumeMonitorMountAddedCallback :: Maybe VolumeMonitorMountAddedCallback

onVolumeMonitorMountAdded :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountAddedCallback -> m SignalHandlerId

wrap_VolumeMonitorMountAddedCallback :: VolumeMonitorMountAddedCallback -> Ptr () -> Ptr Mount -> Ptr () -> IO ()

mountChanged

type C_VolumeMonitorMountChangedCallback = Ptr () -> Ptr Mount -> Ptr () -> IO ()

type VolumeMonitorMountChangedCallback = Mount -> IO ()

afterVolumeMonitorMountChanged :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountChangedCallback -> m SignalHandlerId

genClosure_VolumeMonitorMountChanged :: VolumeMonitorMountChangedCallback -> IO Closure

mk_VolumeMonitorMountChangedCallback :: C_VolumeMonitorMountChangedCallback -> IO (FunPtr C_VolumeMonitorMountChangedCallback)

noVolumeMonitorMountChangedCallback :: Maybe VolumeMonitorMountChangedCallback

onVolumeMonitorMountChanged :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountChangedCallback -> m SignalHandlerId

wrap_VolumeMonitorMountChangedCallback :: VolumeMonitorMountChangedCallback -> Ptr () -> Ptr Mount -> Ptr () -> IO ()

mountPreUnmount

type C_VolumeMonitorMountPreUnmountCallback = Ptr () -> Ptr Mount -> Ptr () -> IO ()

type VolumeMonitorMountPreUnmountCallback = Mount -> IO ()

afterVolumeMonitorMountPreUnmount :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountPreUnmountCallback -> m SignalHandlerId

genClosure_VolumeMonitorMountPreUnmount :: VolumeMonitorMountPreUnmountCallback -> IO Closure

mk_VolumeMonitorMountPreUnmountCallback :: C_VolumeMonitorMountPreUnmountCallback -> IO (FunPtr C_VolumeMonitorMountPreUnmountCallback)

noVolumeMonitorMountPreUnmountCallback :: Maybe VolumeMonitorMountPreUnmountCallback

onVolumeMonitorMountPreUnmount :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountPreUnmountCallback -> m SignalHandlerId

wrap_VolumeMonitorMountPreUnmountCallback :: VolumeMonitorMountPreUnmountCallback -> Ptr () -> Ptr Mount -> Ptr () -> IO ()

mountRemoved

type C_VolumeMonitorMountRemovedCallback = Ptr () -> Ptr Mount -> Ptr () -> IO ()

type VolumeMonitorMountRemovedCallback = Mount -> IO ()

afterVolumeMonitorMountRemoved :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountRemovedCallback -> m SignalHandlerId

genClosure_VolumeMonitorMountRemoved :: VolumeMonitorMountRemovedCallback -> IO Closure

mk_VolumeMonitorMountRemovedCallback :: C_VolumeMonitorMountRemovedCallback -> IO (FunPtr C_VolumeMonitorMountRemovedCallback)

noVolumeMonitorMountRemovedCallback :: Maybe VolumeMonitorMountRemovedCallback

onVolumeMonitorMountRemoved :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorMountRemovedCallback -> m SignalHandlerId

wrap_VolumeMonitorMountRemovedCallback :: VolumeMonitorMountRemovedCallback -> Ptr () -> Ptr Mount -> Ptr () -> IO ()

volumeAdded

type C_VolumeMonitorVolumeAddedCallback = Ptr () -> Ptr Volume -> Ptr () -> IO ()

type VolumeMonitorVolumeAddedCallback = Volume -> IO ()

afterVolumeMonitorVolumeAdded :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorVolumeAddedCallback -> m SignalHandlerId

genClosure_VolumeMonitorVolumeAdded :: VolumeMonitorVolumeAddedCallback -> IO Closure

mk_VolumeMonitorVolumeAddedCallback :: C_VolumeMonitorVolumeAddedCallback -> IO (FunPtr C_VolumeMonitorVolumeAddedCallback)

noVolumeMonitorVolumeAddedCallback :: Maybe VolumeMonitorVolumeAddedCallback

onVolumeMonitorVolumeAdded :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorVolumeAddedCallback -> m SignalHandlerId

wrap_VolumeMonitorVolumeAddedCallback :: VolumeMonitorVolumeAddedCallback -> Ptr () -> Ptr Volume -> Ptr () -> IO ()

volumeChanged

type C_VolumeMonitorVolumeChangedCallback = Ptr () -> Ptr Volume -> Ptr () -> IO ()

type VolumeMonitorVolumeChangedCallback = Volume -> IO ()

afterVolumeMonitorVolumeChanged :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorVolumeChangedCallback -> m SignalHandlerId

genClosure_VolumeMonitorVolumeChanged :: VolumeMonitorVolumeChangedCallback -> IO Closure

mk_VolumeMonitorVolumeChangedCallback :: C_VolumeMonitorVolumeChangedCallback -> IO (FunPtr C_VolumeMonitorVolumeChangedCallback)

noVolumeMonitorVolumeChangedCallback :: Maybe VolumeMonitorVolumeChangedCallback

onVolumeMonitorVolumeChanged :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorVolumeChangedCallback -> m SignalHandlerId

wrap_VolumeMonitorVolumeChangedCallback :: VolumeMonitorVolumeChangedCallback -> Ptr () -> Ptr Volume -> Ptr () -> IO ()

volumeRemoved

type C_VolumeMonitorVolumeRemovedCallback = Ptr () -> Ptr Volume -> Ptr () -> IO ()

type VolumeMonitorVolumeRemovedCallback = Volume -> IO ()

afterVolumeMonitorVolumeRemoved :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorVolumeRemovedCallback -> m SignalHandlerId

genClosure_VolumeMonitorVolumeRemoved :: VolumeMonitorVolumeRemovedCallback -> IO Closure

mk_VolumeMonitorVolumeRemovedCallback :: C_VolumeMonitorVolumeRemovedCallback -> IO (FunPtr C_VolumeMonitorVolumeRemovedCallback)

noVolumeMonitorVolumeRemovedCallback :: Maybe VolumeMonitorVolumeRemovedCallback

onVolumeMonitorVolumeRemoved :: (IsVolumeMonitor a, MonadIO m) => a -> VolumeMonitorVolumeRemovedCallback -> m SignalHandlerId

wrap_VolumeMonitorVolumeRemovedCallback :: VolumeMonitorVolumeRemovedCallback -> Ptr () -> Ptr Volume -> Ptr () -> IO ()