class: MountOperationMeta

[766:14] static extends: object

Generated metadata helpers for MountOperation class surfaces.

Methods

• properties ()

  Returns property metadata for MountOperation.

  • @r A list.

• signals ()

  Returns signal metadata for MountOperation.

  • @r A list.

class: MountOperation

[30:7] extends: object

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 [iface@Gio.Mount] objects – for example it is also used in [method@Gio.Drive.start] and [method@Gio.Drive.stop]. 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.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• MountOperation ()

  Creates a new mount operation.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnAborted (callback Fn, UserData = null)

  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.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (MountOperation Self).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnAskpassword (callback Fn, UserData = null)

  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.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (MountOperation Self, string Message, string Default_user, string Default_domain, string Flags).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnReply (callback Fn, UserData = null)

  Emitted when the user has replied to the mount operation.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (MountOperation Self, string Result).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setAnonymous (bool Value)

  Whether to use an anonymous user when authenticating.

  • @p Value is the new property value.
  • @r None.

• setChoice (int Value)

  The index of the user's choice when a question is asked during the mount operation. See the #GMountOperation::ask-question signal.

  • @p Value is the new property value.
  • @r None.

• setDomain (string Value)

  The domain to use for the mount operation.

  • @p Value is the new property value.
  • @r None.

• setIstcrypthiddenvolume (bool Value)

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

  • @p Value is the new property value.
  • @r None.

• setIstcryptsystemvolume (bool Value)

  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.

  • @p Value is the new property value.
  • @r None.

• setPassword (string Value)

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

  • @p Value is the new property value.
  • @r None.

• setPasswordsave (string Value)

  Determines if and how the password information should be saved.

  • @p Value is the new property value.
  • @r None.

• setPim (int Value)

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

  • @p Value is the new property value.
  • @r None.

• setUsername (string Value)

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

  • @p Value is the new property value.
  • @r None.

• get_anonymous ()

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

• get_choice ()

  Gets a choice from the mount operation.

• get_domain ()

  Gets the domain of the mount operation.

• get_is_tcrypt_hidden_volume ()

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

• get_is_tcrypt_system_volume ()

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

• get_password ()

  Gets a password from the mount operation.

• get_password_save ()

  Gets the state of saving passwords for the mount operation.

• get_pim ()

  Gets a PIM from the mount operation.

• get_username ()

  Get the user name from the mount operation.

• reply (string result)

  Emits the #GMountOperation::reply signal.

  • @p result is a #GMountOperationResult.
  • @r None.

• set_anonymous (bool anonymous)

  Sets the mount operation to use an anonymous user if @anonymous is %TRUE.

  • @p anonymous is boolean value..
  • @r None.

• set_choice (int choice)

  Sets a default choice for the mount operation.

  • @p choice is an integer..
  • @r None.

• set_domain (string domain)

  Sets the mount operation's domain.

  • @p domain is the domain to set..
  • @r None.

• set_is_tcrypt_hidden_volume (bool hidden_volume)

  Sets the mount operation to use a hidden volume if @hidden_volume is %TRUE.

  • @p hidden_volume is boolean value..
  • @r None.

• set_is_tcrypt_system_volume (bool system_volume)

  Sets the mount operation to use a system volume if @system_volume is %TRUE.

  • @p system_volume is boolean value..
  • @r None.

• set_password (string password)

  Sets the mount operation's password to @password.

  • @p password is password to set..
  • @r None.

• set_password_save (string save)

  Sets the state of saving passwords for the mount operation.

  • @p save is a set of #GPasswordSave flags..
  • @r None.

• set_pim (int pim)

  Sets the mount operation's PIM to @pim.

  • @p pim is an unsigned integer..
  • @r None.

• set_username (string username)

  Sets the user name within @op to @username.

  • @p username is input username..
  • @r None.

class: MountOperationAskpasswordCallback

[624:7] extends: object

Generated low-level callback wrapper for GIR callback ask-password.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• MountOperationAskpasswordCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, message, default_user, default_domain, flags, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: MountOperationAbortedCallback

[554:7] extends: object

Generated low-level callback wrapper for GIR callback aborted.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• MountOperationAbortedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: MountOperationReplyCallback

[695:7] extends: object

Generated low-level callback wrapper for GIR callback reply.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• MountOperationReplyCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, result, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.