:right-sidebar: True MountOperation =================================================================== .. currentmodule:: gi.repository.Gio .. class:: MountOperation(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` :Constructors: :: MountOperation(**properties) new() -> Gio.MountOperation Constructors ------------ .. rst-class:: interim-class .. class:: MountOperation :no-index: .. classmethod:: new() -> ~gi.repository.Gio.MountOperation Creates a new mount operation. Methods ------- .. rst-class:: interim-class .. class:: MountOperation :no-index: .. method:: get_anonymous() -> bool Check to see whether the mount operation is being used for an anonymous user. .. method:: get_choice() -> int Gets a choice from the mount operation. .. method:: get_domain() -> str | None Gets the domain of the mount operation. .. method:: get_is_tcrypt_hidden_volume() -> bool Check to see whether the mount operation is being used for a TCRYPT hidden volume. .. versionadded:: 2.58 .. method:: get_is_tcrypt_system_volume() -> bool Check to see whether the mount operation is being used for a TCRYPT system volume. .. versionadded:: 2.58 .. method:: get_password() -> str | None Gets a password from the mount operation. .. method:: get_password_save() -> ~gi.repository.Gio.PasswordSave Gets the state of saving passwords for the mount operation. .. method:: get_pim() -> int Gets a PIM from the mount operation. .. versionadded:: 2.58 .. method:: get_username() -> str | None Get the user name from the mount operation. .. method:: reply(result: ~gi.repository.Gio.MountOperationResult) -> None Emits the :obj:`~gi.repository.Gio.MountOperation`::reply signal. :param result: a :obj:`~gi.repository.Gio.MountOperationResult` .. method:: set_anonymous(anonymous: bool) -> None Sets the mount operation to use an anonymous user if ``anonymous`` is :const:`True`. :param anonymous: boolean value. .. method:: set_choice(choice: int) -> None Sets a default choice for the mount operation. :param choice: an integer. .. method:: set_domain(domain: str | None = None) -> None Sets the mount operation's domain. :param domain: the domain to set. .. method:: set_is_tcrypt_hidden_volume(hidden_volume: bool) -> None Sets the mount operation to use a hidden volume if ``hidden_volume`` is :const:`True`. .. versionadded:: 2.58 :param hidden_volume: boolean value. .. method:: set_is_tcrypt_system_volume(system_volume: bool) -> None Sets the mount operation to use a system volume if ``system_volume`` is :const:`True`. .. versionadded:: 2.58 :param system_volume: boolean value. .. method:: set_password(password: str | None = None) -> None Sets the mount operation's password to ``password``. :param password: password to set. .. method:: set_password_save(save: ~gi.repository.Gio.PasswordSave) -> None Sets the state of saving passwords for the mount operation. :param save: a set of :obj:`~gi.repository.Gio.PasswordSave` flags. .. method:: set_pim(pim: int) -> None Sets the mount operation's PIM to ``pim``. .. versionadded:: 2.58 :param pim: an unsigned integer. .. method:: set_username(username: str | None = None) -> None Sets the user name within ``op`` to ``username``. :param username: input username. Properties ---------- .. rst-class:: interim-class .. class:: MountOperation :no-index: .. attribute:: props.anonymous :type: bool Whether to use an anonymous user when authenticating. .. attribute:: props.choice :type: int The index of the user's choice when a question is asked during the mount operation. See the :obj:`~gi.repository.Gio.MountOperation`::ask-question signal. .. attribute:: props.domain :type: str The domain to use for the mount operation. .. attribute:: props.is_tcrypt_hidden_volume :type: bool Whether the device to be unlocked is a TCRYPT hidden volume. See `the VeraCrypt documentation `_. .. versionadded:: 2.58 .. attribute:: props.is_tcrypt_system_volume :type: bool 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 `_. .. versionadded:: 2.58 .. attribute:: props.password :type: str The password that is used for authentication when carrying out the mount operation. .. attribute:: props.password_save :type: ~gi.repository.Gio.PasswordSave Determines if and how the password information should be saved. .. attribute:: props.pim :type: int The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See `the VeraCrypt documentation `_.html). .. versionadded:: 2.58 .. attribute:: props.username :type: str The user name that is used for authentication when carrying out the mount operation. Signals ------- .. rst-class:: interim-class .. class:: MountOperation.signals :no-index: .. method:: aborted() -> None 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. .. versionadded:: 2.20 .. method:: ask_password(message: str, default_user: str, default_domain: str, flags: ~gi.repository.Gio.AskPasswordFlags) -> None 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``. :param message: string containing a message to display to the user. :param default_user: string containing the default user name. :param default_domain: string containing the default domain. :param flags: a set of :obj:`~gi.repository.Gio.AskPasswordFlags`. .. method:: ask_question(message: str, choices: ~typing.Sequence[str]) -> None 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``. :param message: string containing a message to display to the user. :param choices: an array of strings for each possible choice. .. method:: reply(result: ~gi.repository.Gio.MountOperationResult) -> None Emitted when the user has replied to the mount operation. :param result: a :obj:`~gi.repository.Gio.MountOperationResult` indicating how the request was handled .. method:: show_processes(message: str, processes: ~typing.Sequence[int], choices: ~typing.Sequence[str]) -> None Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a :obj:`~gi.repository.Gio.Mount` or stopping a :obj:`~gi.repository.Gio.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 :func:`~gi.repository.Gio.MountOperation.reply` to the latest signal (setting :obj:`~gi.repository.Gio.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``. .. versionadded:: 2.22 :param message: string containing a message to display to the user. :param processes: an array of :obj:`~gi.repository.GLib.Pid` for processes blocking the operation. :param choices: an array of strings for each possible choice. .. method:: show_unmount_progress(message: str, time_left: int, bytes_left: int) -> None 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 ``bytes_left`` 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 ``bytes_left`` 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``. .. versionadded:: 2.34 :param message: string containing a message to display to the user :param time_left: the estimated time left before the operation completes, in microseconds, or -1 :param bytes_left: 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 Virtual Methods --------------- .. rst-class:: interim-class .. class:: MountOperation :no-index: .. method:: do_aborted() -> None .. method:: do_ask_password(message: str, default_user: str, default_domain: str, flags: ~gi.repository.Gio.AskPasswordFlags) -> None :param message: :param default_user: :param default_domain: :param flags: .. method:: do_ask_question(message: str, choices: ~typing.Sequence[str]) -> None Virtual implementation of :obj:`~gi.repository.Gio.MountOperation`::ask-question. :param message: string containing a message to display to the user :param choices: an array of strings for each possible choice .. method:: do_reply(result: ~gi.repository.Gio.MountOperationResult) -> None Emits the :obj:`~gi.repository.Gio.MountOperation`::reply signal. :param result: a :obj:`~gi.repository.Gio.MountOperationResult` .. method:: do_show_processes(message: str, processes: ~typing.Sequence[int], choices: ~typing.Sequence[str]) -> None Virtual implementation of :obj:`~gi.repository.Gio.MountOperation`::show-processes. .. versionadded:: 2.22 :param message: string containing a message to display to the user :param processes: an array of :obj:`~gi.repository.GLib.Pid` for processes blocking the operation :param choices: an array of strings for each possible choice .. method:: do_show_unmount_progress(message: str, time_left: int, bytes_left: int) -> None :param message: :param time_left: :param bytes_left: Fields ------ .. rst-class:: interim-class .. class:: MountOperation :no-index: .. attribute:: parent_instance .. attribute:: priv