gi-gio
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.MountOperation

Description

GMountOperation provides a mechanism for interacting with the user. It can be used for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. It can also be used to ask the user questions or show a list of applications preventing unmount or eject operations from completing.

Note that GMountOperation is used for more than just Mount objects – for example it is also used in driveStart and driveStop.

Users should instantiate a subclass of this that implements all the various callbacks to show the required dialogs, such as `GtkMountOperation`. If no user interaction is desired (for example when automounting filesystems at login time), usually NULL can be passed, see each method taking a GMountOperation for details.

Throughout the API, the term ‘TCRYPT’ is used to mean ‘compatible with TrueCrypt and VeraCrypt’. TrueCrypt is a discontinued system for encrypting file containers, partitions or whole disks, typically used with Windows. VeraCrypt is a maintained fork of TrueCrypt with various improvements and auditing fixes.

Synopsis

Exported types

newtype MountOperation Source #

Memory-managed wrapper type.

Instances

Instances details
Eq MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

GObject MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

ManagedPtrNewtype MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

TypedObject MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Methods

glibType :: IO GType #

HasParentTypes MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

HasAttributeList MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

(info ~ ResolveMountOperationMethod t MountOperation, OverloadedMethod info MountOperation p, HasField t MountOperation p) => HasField (t :: Symbol) MountOperation (p :: Type) Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Methods

getField :: MountOperation -> p #

(info ~ ResolveMountOperationMethod t MountOperation, OverloadedMethodInfo info MountOperation) => IsLabel t (MethodProxy info MountOperation) Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

(info ~ ResolveMountOperationMethod t MountOperation, OverloadedMethod info MountOperation p) => IsLabel t (MountOperation -> p) Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Methods

fromLabel :: MountOperation -> p #

IsGValue (Maybe MountOperation) Source #

Convert MountOperation to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gio.Objects.MountOperation

type AttributeList MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type ParentTypes MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type SignalList MountOperation Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

class (GObject o, IsDescendantOf MountOperation o) => IsMountOperation o Source #

Type class for types which can be safely cast to MountOperation, for instance with toMountOperation.

Instances

Instances details
(GObject o, IsDescendantOf MountOperation o) => IsMountOperation o Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

toMountOperation :: (MonadIO m, IsMountOperation o) => o -> m MountOperation Source #

Cast to MountOperation, for types for which this is known to be safe. For general casts, use castTo.

Methods

type family ResolveMountOperationMethod (t :: Symbol) o where ... Source #

Equations

ResolveMountOperationMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveMountOperationMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveMountOperationMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveMountOperationMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveMountOperationMethod "getv" o = ObjectGetvMethodInfo 
ResolveMountOperationMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveMountOperationMethod "notify" o = ObjectNotifyMethodInfo 
ResolveMountOperationMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveMountOperationMethod "ref" o = ObjectRefMethodInfo 
ResolveMountOperationMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveMountOperationMethod "reply" o = MountOperationReplyMethodInfo 
ResolveMountOperationMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveMountOperationMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveMountOperationMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveMountOperationMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveMountOperationMethod "unref" o = ObjectUnrefMethodInfo 
ResolveMountOperationMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveMountOperationMethod "getAnonymous" o = MountOperationGetAnonymousMethodInfo 
ResolveMountOperationMethod "getChoice" o = MountOperationGetChoiceMethodInfo 
ResolveMountOperationMethod "getData" o = ObjectGetDataMethodInfo 
ResolveMountOperationMethod "getDomain" o = MountOperationGetDomainMethodInfo 
ResolveMountOperationMethod "getIsTcryptHiddenVolume" o = MountOperationGetIsTcryptHiddenVolumeMethodInfo 
ResolveMountOperationMethod "getIsTcryptSystemVolume" o = MountOperationGetIsTcryptSystemVolumeMethodInfo 
ResolveMountOperationMethod "getPassword" o = MountOperationGetPasswordMethodInfo 
ResolveMountOperationMethod "getPasswordSave" o = MountOperationGetPasswordSaveMethodInfo 
ResolveMountOperationMethod "getPim" o = MountOperationGetPimMethodInfo 
ResolveMountOperationMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveMountOperationMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveMountOperationMethod "getUsername" o = MountOperationGetUsernameMethodInfo 
ResolveMountOperationMethod "setAnonymous" o = MountOperationSetAnonymousMethodInfo 
ResolveMountOperationMethod "setChoice" o = MountOperationSetChoiceMethodInfo 
ResolveMountOperationMethod "setData" o = ObjectSetDataMethodInfo 
ResolveMountOperationMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveMountOperationMethod "setDomain" o = MountOperationSetDomainMethodInfo 
ResolveMountOperationMethod "setIsTcryptHiddenVolume" o = MountOperationSetIsTcryptHiddenVolumeMethodInfo 
ResolveMountOperationMethod "setIsTcryptSystemVolume" o = MountOperationSetIsTcryptSystemVolumeMethodInfo 
ResolveMountOperationMethod "setPassword" o = MountOperationSetPasswordMethodInfo 
ResolveMountOperationMethod "setPasswordSave" o = MountOperationSetPasswordSaveMethodInfo 
ResolveMountOperationMethod "setPim" o = MountOperationSetPimMethodInfo 
ResolveMountOperationMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveMountOperationMethod "setUsername" o = MountOperationSetUsernameMethodInfo 
ResolveMountOperationMethod l o = MethodResolutionFailed l o :: Type 

getAnonymous

mountOperationGetAnonymous Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m Bool

Returns: True if mount operation is anonymous.

Check to see whether the mount operation is being used for an anonymous user.

getChoice

mountOperationGetChoice Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m Int32

Returns: an integer containing an index of the user's choice from the choice's list, or 0.

Gets a choice from the mount operation.

getDomain

mountOperationGetDomain Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m (Maybe Text)

Returns: a string set to the domain.

Gets the domain of the mount operation.

getIsTcryptHiddenVolume

mountOperationGetIsTcryptHiddenVolume Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m Bool

Returns: True if mount operation is for hidden volume.

Check to see whether the mount operation is being used for a TCRYPT hidden volume.

Since: 2.58

getIsTcryptSystemVolume

mountOperationGetIsTcryptSystemVolume Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m Bool

Returns: True if mount operation is for system volume.

Check to see whether the mount operation is being used for a TCRYPT system volume.

Since: 2.58

getPassword

mountOperationGetPassword Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m (Maybe Text)

Returns: a string containing the password within op.

Gets a password from the mount operation.

getPasswordSave

mountOperationGetPasswordSave Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m PasswordSave

Returns: a PasswordSave flag.

Gets the state of saving passwords for the mount operation.

getPim

mountOperationGetPim Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m Word32

Returns: The VeraCrypt PIM within op.

Gets a PIM from the mount operation.

Since: 2.58

getUsername

mountOperationGetUsername Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> m (Maybe Text)

Returns: a string containing the user name.

Get the user name from the mount operation.

new

mountOperationNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m MountOperation

Returns: a MountOperation.

Creates a new mount operation.

reply

setAnonymous

mountOperationSetAnonymous Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Bool

anonymous: boolean value.

-> m () 

Sets the mount operation to use an anonymous user if anonymous is True.

setChoice

mountOperationSetChoice Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Int32

choice: an integer.

-> m () 

Sets a default choice for the mount operation.

setDomain

mountOperationSetDomain Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Maybe Text

domain: the domain to set.

-> m () 

Sets the mount operation's domain.

setIsTcryptHiddenVolume

mountOperationSetIsTcryptHiddenVolume Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Bool

hiddenVolume: boolean value.

-> m () 

Sets the mount operation to use a hidden volume if hiddenVolume is True.

Since: 2.58

setIsTcryptSystemVolume

mountOperationSetIsTcryptSystemVolume Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Bool

systemVolume: boolean value.

-> m () 

Sets the mount operation to use a system volume if systemVolume is True.

Since: 2.58

setPassword

mountOperationSetPassword Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Maybe Text

password: password to set.

-> m () 

Sets the mount operation's password to password.

setPasswordSave

mountOperationSetPasswordSave Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> PasswordSave

save: a set of PasswordSave flags.

-> m () 

Sets the state of saving passwords for the mount operation.

setPim

mountOperationSetPim Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Word32

pim: an unsigned integer.

-> m () 

Sets the mount operation's PIM to pim.

Since: 2.58

setUsername

mountOperationSetUsername Source #

Arguments

:: (HasCallStack, MonadIO m, IsMountOperation a) 
=> a

op: a MountOperation.

-> Maybe Text

username: input username.

-> m () 

Sets the user name within op to username.

Properties

anonymous

Whether to use an anonymous user when authenticating.

data MountOperationAnonymousPropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Associated Types

type AttrAllowedOps MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationAnonymousPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationAnonymousPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

constructMountOperationAnonymous :: (IsMountOperation o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “anonymous” property. This is rarely needed directly, but it is used by new.

getMountOperationAnonymous :: (MonadIO m, IsMountOperation o) => o -> m Bool Source #

Get the value of the “anonymous” property. When overloading is enabled, this is equivalent to

get mountOperation #anonymous

setMountOperationAnonymous :: (MonadIO m, IsMountOperation o) => o -> Bool -> m () Source #

Set the value of the “anonymous” property. When overloading is enabled, this is equivalent to

set mountOperation [ #anonymous := value ]

choice

The index of the user's choice when a question is asked during the mount operation. See the MountOperation::askQuestion signal.

data MountOperationChoicePropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationChoicePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

constructMountOperationChoice :: (IsMountOperation o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “choice” property. This is rarely needed directly, but it is used by new.

getMountOperationChoice :: (MonadIO m, IsMountOperation o) => o -> m Int32 Source #

Get the value of the “choice” property. When overloading is enabled, this is equivalent to

get mountOperation #choice

setMountOperationChoice :: (MonadIO m, IsMountOperation o) => o -> Int32 -> m () Source #

Set the value of the “choice” property. When overloading is enabled, this is equivalent to

set mountOperation [ #choice := value ]

domain

The domain to use for the mount operation.

data MountOperationDomainPropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Associated Types

type AttrAllowedOps MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationDomainPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationDomainPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

clearMountOperationDomain :: (MonadIO m, IsMountOperation o) => o -> m () Source #

Set the value of the “domain” property to Nothing. When overloading is enabled, this is equivalent to

clear #domain

constructMountOperationDomain :: (IsMountOperation o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “domain” property. This is rarely needed directly, but it is used by new.

getMountOperationDomain :: (MonadIO m, IsMountOperation o) => o -> m (Maybe Text) Source #

Get the value of the “domain” property. When overloading is enabled, this is equivalent to

get mountOperation #domain

setMountOperationDomain :: (MonadIO m, IsMountOperation o) => o -> Text -> m () Source #

Set the value of the “domain” property. When overloading is enabled, this is equivalent to

set mountOperation [ #domain := value ]

isTcryptHiddenVolume

Whether the device to be unlocked is a TCRYPT hidden volume. See the VeraCrypt documentation.

Since: 2.58

data MountOperationIsTcryptHiddenVolumePropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Associated Types

type AttrAllowedOps MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationIsTcryptHiddenVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationIsTcryptHiddenVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

constructMountOperationIsTcryptHiddenVolume :: (IsMountOperation o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “is-tcrypt-hidden-volume” property. This is rarely needed directly, but it is used by new.

getMountOperationIsTcryptHiddenVolume :: (MonadIO m, IsMountOperation o) => o -> m Bool Source #

Get the value of the “is-tcrypt-hidden-volume” property. When overloading is enabled, this is equivalent to

get mountOperation #isTcryptHiddenVolume

setMountOperationIsTcryptHiddenVolume :: (MonadIO m, IsMountOperation o) => o -> Bool -> m () Source #

Set the value of the “is-tcrypt-hidden-volume” property. When overloading is enabled, this is equivalent to

set mountOperation [ #isTcryptHiddenVolume := value ]

isTcryptSystemVolume

Whether the device to be unlocked is a TCRYPT system volume. In this context, a system volume is a volume with a bootloader and operating system installed. This is only supported for Windows operating systems. For further documentation, see the VeraCrypt documentation.

Since: 2.58

data MountOperationIsTcryptSystemVolumePropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Associated Types

type AttrAllowedOps MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationIsTcryptSystemVolumePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationIsTcryptSystemVolumePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

constructMountOperationIsTcryptSystemVolume :: (IsMountOperation o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “is-tcrypt-system-volume” property. This is rarely needed directly, but it is used by new.

getMountOperationIsTcryptSystemVolume :: (MonadIO m, IsMountOperation o) => o -> m Bool Source #

Get the value of the “is-tcrypt-system-volume” property. When overloading is enabled, this is equivalent to

get mountOperation #isTcryptSystemVolume

setMountOperationIsTcryptSystemVolume :: (MonadIO m, IsMountOperation o) => o -> Bool -> m () Source #

Set the value of the “is-tcrypt-system-volume” property. When overloading is enabled, this is equivalent to

set mountOperation [ #isTcryptSystemVolume := value ]

password

The password that is used for authentication when carrying out the mount operation.

data MountOperationPasswordPropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Associated Types

type AttrAllowedOps MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationPasswordPropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationPasswordPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

clearMountOperationPassword :: (MonadIO m, IsMountOperation o) => o -> m () Source #

Set the value of the “password” property to Nothing. When overloading is enabled, this is equivalent to

clear #password

constructMountOperationPassword :: (IsMountOperation o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “password” property. This is rarely needed directly, but it is used by new.

getMountOperationPassword :: (MonadIO m, IsMountOperation o) => o -> m (Maybe Text) Source #

Get the value of the “password” property. When overloading is enabled, this is equivalent to

get mountOperation #password

setMountOperationPassword :: (MonadIO m, IsMountOperation o) => o -> Text -> m () Source #

Set the value of the “password” property. When overloading is enabled, this is equivalent to

set mountOperation [ #password := value ]

passwordSave

Determines if and how the password information should be saved.

data MountOperationPasswordSavePropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Associated Types

type AttrAllowedOps MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationPasswordSavePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationPasswordSavePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

constructMountOperationPasswordSave :: (IsMountOperation o, MonadIO m) => PasswordSave -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “password-save” property. This is rarely needed directly, but it is used by new.

getMountOperationPasswordSave :: (MonadIO m, IsMountOperation o) => o -> m PasswordSave Source #

Get the value of the “password-save” property. When overloading is enabled, this is equivalent to

get mountOperation #passwordSave

setMountOperationPasswordSave :: (MonadIO m, IsMountOperation o) => o -> PasswordSave -> m () Source #

Set the value of the “password-save” property. When overloading is enabled, this is equivalent to

set mountOperation [ #passwordSave := value ]

pim

The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See the VeraCrypt documentation.html).

Since: 2.58

data MountOperationPimPropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationPimPropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

constructMountOperationPim :: (IsMountOperation o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “pim” property. This is rarely needed directly, but it is used by new.

getMountOperationPim :: (MonadIO m, IsMountOperation o) => o -> m Word32 Source #

Get the value of the “pim” property. When overloading is enabled, this is equivalent to

get mountOperation #pim

setMountOperationPim :: (MonadIO m, IsMountOperation o) => o -> Word32 -> m () Source #

Set the value of the “pim” property. When overloading is enabled, this is equivalent to

set mountOperation [ #pim := value ]

username

The user name that is used for authentication when carrying out the mount operation.

data MountOperationUsernamePropertyInfo Source #

Instances

Instances details
AttrInfo MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

Associated Types

type AttrAllowedOps MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationUsernamePropertyInfo 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrAllowedOps MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrBaseTypeConstraint MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrGetType MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrLabel MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrOrigin MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrSetTypeConstraint MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferType MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

type AttrTransferTypeConstraint MountOperationUsernamePropertyInfo Source # 
Instance details

Defined in GI.Gio.Objects.MountOperation

clearMountOperationUsername :: (MonadIO m, IsMountOperation o) => o -> m () Source #

Set the value of the “username” property to Nothing. When overloading is enabled, this is equivalent to

clear #username

constructMountOperationUsername :: (IsMountOperation o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “username” property. This is rarely needed directly, but it is used by new.

getMountOperationUsername :: (MonadIO m, IsMountOperation o) => o -> m (Maybe Text) Source #

Get the value of the “username” property. When overloading is enabled, this is equivalent to

get mountOperation #username

setMountOperationUsername :: (MonadIO m, IsMountOperation o) => o -> Text -> m () Source #

Set the value of the “username” property. When overloading is enabled, this is equivalent to

set mountOperation [ #username := value ]

Signals

aborted

type MountOperationAbortedCallback = IO () Source #

Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress.

Implementations of GMountOperation should handle this signal by dismissing open password dialogs.

Since: 2.20

afterMountOperationAborted :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationAbortedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the aborted signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after mountOperation #aborted callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountOperationAborted :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationAbortedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the aborted signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on mountOperation #aborted callback

askPassword

type MountOperationAskPasswordCallback Source #

Arguments

 = Text

message: string containing a message to display to the user.

-> Text

defaultUser: string containing the default user name.

-> Text

defaultDomain: string containing the default domain.

-> [AskPasswordFlags]

flags: a set of AskPasswordFlags.

-> IO () 

Emitted when a mount operation asks the user for a password.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

afterMountOperationAskPassword :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationAskPasswordCallback) -> m SignalHandlerId Source #

Connect a signal handler for the askPassword signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after mountOperation #askPassword callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountOperationAskPassword :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationAskPasswordCallback) -> m SignalHandlerId Source #

Connect a signal handler for the askPassword signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on mountOperation #askPassword callback

askQuestion

type MountOperationAskQuestionCallback Source #

Arguments

 = Text

message: string containing a message to display to the user.

-> [Text]

choices: an array of strings for each possible choice.

-> IO () 

Emitted when asking the user a question and gives a list of choices for the user to choose from.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

afterMountOperationAskQuestion :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationAskQuestionCallback) -> m SignalHandlerId Source #

Connect a signal handler for the askQuestion signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after mountOperation #askQuestion callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountOperationAskQuestion :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationAskQuestionCallback) -> m SignalHandlerId Source #

Connect a signal handler for the askQuestion signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on mountOperation #askQuestion callback

reply

type MountOperationReplyCallback Source #

Arguments

 = MountOperationResult

result: a MountOperationResult indicating how the request was handled

-> IO () 

Emitted when the user has replied to the mount operation.

afterMountOperationReply :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationReplyCallback) -> m SignalHandlerId Source #

Connect a signal handler for the reply signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after mountOperation #reply callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountOperationReply :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationReplyCallback) -> m SignalHandlerId Source #

Connect a signal handler for the reply signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on mountOperation #reply callback

showProcesses

type MountOperationShowProcessesCallback Source #

Arguments

 = Text

message: string containing a message to display to the user.

-> [Int32]

processes: an array of GPid for processes blocking the operation.

-> [Text]

choices: an array of strings for each possible choice.

-> IO () 

Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a Mount or stopping a Drive.

Note that this signal may be emitted several times to update the list of blocking processes as processes close files. The application should only respond with mountOperationReply to the latest signal (setting MountOperation:choice to the choice the user made).

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Since: 2.22

afterMountOperationShowProcesses :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationShowProcessesCallback) -> m SignalHandlerId Source #

Connect a signal handler for the showProcesses signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after mountOperation #showProcesses callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountOperationShowProcesses :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationShowProcessesCallback) -> m SignalHandlerId Source #

Connect a signal handler for the showProcesses signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on mountOperation #showProcesses callback

showUnmountProgress

type MountOperationShowUnmountProgressCallback Source #

Arguments

 = Text

message: string containing a message to display to the user

-> Int64

timeLeft: the estimated time left before the operation completes, in microseconds, or -1

-> Int64

bytesLeft: the amount of bytes to be written before the operation completes (or -1 if such amount is not known), or zero if the operation is completed

-> IO () 

Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds).

When unmounting or ejecting a volume, the kernel might need to flush pending data in its buffers to the volume stable storage, and this operation can take a considerable amount of time. This signal may be emitted several times as long as the unmount operation is outstanding, and then one last time when the operation is completed, with bytesLeft set to zero.

Implementations of GMountOperation should handle this signal by showing an UI notification, and then dismiss it, or show another notification of completion, when bytesLeft reaches zero.

If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the primary text in a GtkMessageDialog.

Since: 2.34

afterMountOperationShowUnmountProgress :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationShowUnmountProgressCallback) -> m SignalHandlerId Source #

Connect a signal handler for the showUnmountProgress signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after mountOperation #showUnmountProgress callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onMountOperationShowUnmountProgress :: (IsMountOperation a, MonadIO m) => a -> ((?self :: a) => MountOperationShowUnmountProgressCallback) -> m SignalHandlerId Source #

Connect a signal handler for the showUnmountProgress signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on mountOperation #showUnmountProgress callback