@gtkx/ffi 0.1.45 → 0.1.47

package/dist/generated/gio/mount-operation.d.ts

@@ -2,26 +2,99 @@ import { AskPasswordFlags, MountOperationResult, PasswordSave } from "./enums.js
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 export declare class MountOperation extends GObject.GObject {
+    /**
+     * Creates a new mount operation.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Check to see whether the mount operation is being used
+     * for an anonymous user.
+     */
     getAnonymous(): boolean;
+    /**
+     * Gets a choice from the mount operation.
+     */
     getChoice(): number;
+    /**
+     * Gets the domain of the mount operation.
+     */
     getDomain(): string | null;
+    /**
+     * Check to see whether the mount operation is being used
+     * for a TCRYPT hidden volume.
+     */
     getIsTcryptHiddenVolume(): boolean;
+    /**
+     * Check to see whether the mount operation is being used
+     * for a TCRYPT system volume.
+     */
     getIsTcryptSystemVolume(): boolean;
+    /**
+     * Gets a password from the mount operation.
+     */
     getPassword(): string | null;
+    /**
+     * Gets the state of saving passwords for the mount operation.
+     */
     getPasswordSave(): PasswordSave;
+    /**
+     * Gets a PIM from the mount operation.
+     */
     getPim(): number;
+    /**
+     * Get the user name from the mount operation.
+     */
     getUsername(): string | null;
+    /**
+     * Emits the #GMountOperation::reply signal.
+     * @param result - a #GMountOperationResult
+     */
     reply(result: MountOperationResult): void;
+    /**
+     * Sets the mount operation to use an anonymous user if `anonymous` is %TRUE.
+     * @param anonymous - boolean value.
+     */
     setAnonymous(anonymous: boolean): void;
+    /**
+     * Sets a default choice for the mount operation.
+     * @param choice - an integer.
+     */
     setChoice(choice: number): void;
+    /**
+     * Sets the mount operation's domain.
+     * @param domain - the domain to set.
+     */
     setDomain(domain?: string | null): void;
+    /**
+     * Sets the mount operation to use a hidden volume if `hidden_volume` is %TRUE.
+     * @param hiddenVolume - boolean value.
+     */
     setIsTcryptHiddenVolume(hiddenVolume: boolean): void;
+    /**
+     * Sets the mount operation to use a system volume if `system_volume` is %TRUE.
+     * @param systemVolume - boolean value.
+     */
     setIsTcryptSystemVolume(systemVolume: boolean): void;
+    /**
+     * Sets the mount operation's password to @password.
+     * @param password - password to set.
+     */
     setPassword(password?: string | null): void;
+    /**
+     * Sets the state of saving passwords for the mount operation.
+     * @param save - a set of #GPasswordSave flags.
+     */
     setPasswordSave(save: PasswordSave): void;
+    /**
+     * Sets the mount operation's PIM to @pim.
+     * @param pim - an unsigned integer.
+     */
     setPim(pim: number): void;
+    /**
+     * Sets the user name within `op` to @username.
+     * @param username - input username.
+     */
     setUsername(username?: string | null): void;
     connect(signal: "aborted", handler: (self: MountOperation) => void, after?: boolean): number;
     connect(signal: "ask-password", handler: (self: MountOperation, message: string, defaultUser: string, defaultDomain: string, flags: AskPasswordFlags) => void, after?: boolean): number;

package/dist/generated/gio/mount-operation.js

@@ -1,6 +1,30 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
+/**
+ * `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](https://en.wikipedia.org/wiki/TrueCrypt) is a discontinued system for
+ * encrypting file containers, partitions or whole disks, typically used with Windows.
+ * [VeraCrypt](https://www.veracrypt.fr/) is a maintained fork of TrueCrypt with various
+ * improvements and auditing fixes.
+ */
 const SIGNAL_META = {
     aborted: { params: [], returnType: { type: "undefined" } },
     "ask-password": {
@@ -45,6 +69,9 @@ const SIGNAL_META = {
     },
 };
 export class MountOperation extends GObject.GObject {
+    /**
+     * Creates a new mount operation.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -54,6 +81,10 @@ export class MountOperation extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Check to see whether the mount operation is being used
+     * for an anonymous user.
+     */
     getAnonymous() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_anonymous", [
             {
@@ -62,6 +93,9 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets a choice from the mount operation.
+     */
     getChoice() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_choice", [
             {
@@ -70,6 +104,9 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the domain of the mount operation.
+     */
     getDomain() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_domain", [
             {
@@ -78,6 +115,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Check to see whether the mount operation is being used
+     * for a TCRYPT hidden volume.
+     */
     getIsTcryptHiddenVolume() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_is_tcrypt_hidden_volume", [
             {
@@ -86,6 +127,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Check to see whether the mount operation is being used
+     * for a TCRYPT system volume.
+     */
     getIsTcryptSystemVolume() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_is_tcrypt_system_volume", [
             {
@@ -94,6 +139,9 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets a password from the mount operation.
+     */
     getPassword() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_password", [
             {
@@ -102,6 +150,9 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the state of saving passwords for the mount operation.
+     */
     getPasswordSave() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_password_save", [
             {
@@ -110,6 +161,9 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets a PIM from the mount operation.
+     */
     getPim() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_pim", [
             {
@@ -118,6 +172,9 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Get the user name from the mount operation.
+     */
     getUsername() {
         return call("libgio-2.0.so.0", "g_mount_operation_get_username", [
             {
@@ -126,6 +183,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Emits the #GMountOperation::reply signal.
+     * @param result - a #GMountOperationResult
+     */
     reply(result) {
         call("libgio-2.0.so.0", "g_mount_operation_reply", [
             {
@@ -138,6 +199,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the mount operation to use an anonymous user if `anonymous` is %TRUE.
+     * @param anonymous - boolean value.
+     */
     setAnonymous(anonymous) {
         call("libgio-2.0.so.0", "g_mount_operation_set_anonymous", [
             {
@@ -150,6 +215,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a default choice for the mount operation.
+     * @param choice - an integer.
+     */
     setChoice(choice) {
         call("libgio-2.0.so.0", "g_mount_operation_set_choice", [
             {
@@ -162,6 +231,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the mount operation's domain.
+     * @param domain - the domain to set.
+     */
     setDomain(domain) {
         call("libgio-2.0.so.0", "g_mount_operation_set_domain", [
             {
@@ -175,6 +248,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the mount operation to use a hidden volume if `hidden_volume` is %TRUE.
+     * @param hiddenVolume - boolean value.
+     */
     setIsTcryptHiddenVolume(hiddenVolume) {
         call("libgio-2.0.so.0", "g_mount_operation_set_is_tcrypt_hidden_volume", [
             {
@@ -187,6 +264,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the mount operation to use a system volume if `system_volume` is %TRUE.
+     * @param systemVolume - boolean value.
+     */
     setIsTcryptSystemVolume(systemVolume) {
         call("libgio-2.0.so.0", "g_mount_operation_set_is_tcrypt_system_volume", [
             {
@@ -199,6 +280,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the mount operation's password to @password.
+     * @param password - password to set.
+     */
     setPassword(password) {
         call("libgio-2.0.so.0", "g_mount_operation_set_password", [
             {
@@ -212,6 +297,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the state of saving passwords for the mount operation.
+     * @param save - a set of #GPasswordSave flags.
+     */
     setPasswordSave(save) {
         call("libgio-2.0.so.0", "g_mount_operation_set_password_save", [
             {
@@ -224,6 +313,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the mount operation's PIM to @pim.
+     * @param pim - an unsigned integer.
+     */
     setPim(pim) {
         call("libgio-2.0.so.0", "g_mount_operation_set_pim", [
             {
@@ -236,6 +329,10 @@ export class MountOperation extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the user name within `op` to @username.
+     * @param username - input username.
+     */
     setUsername(username) {
         call("libgio-2.0.so.0", "g_mount_operation_set_username", [
             {

package/dist/generated/gio/mount.d.ts

@@ -6,35 +6,252 @@ import { File } from "./file.js";
 import { Icon } from "./icon.js";
 import { MountOperation } from "./mount-operation.js";
 import { Volume } from "./volume.js";
+/**
+ * The `GMount` interface represents a user-visible mount, such as a mounted
+ * file system.
+ *
+ * `GMount` is a ‘mounted’ filesystem that you can access. Mounted is in
+ * quotes because it’s not the same as a UNIX mount, it might be a GVFS
+ * mount, but you can still access the files on it if you use GIO.
+ *
+ * A `GMount` might be associated with a [iface@Gio.Volume] (such as a USB flash
+ * drive) which hosts it.
+ *
+ * Unmounting a `GMount` instance is an asynchronous operation. For
+ * more information about asynchronous operations, see [iface@Gio.AsyncResult]
+ * and [class@Gio.Task]. To unmount a `GMount` instance, first call
+ * [method@Gio.Mount.unmount_with_operation] with (at least) the `GMount`
+ * instance and a [type@Gio.AsyncReadyCallback].  The callback will be fired
+ * when the operation has resolved (either with success or failure), and a
+ * [iface@Gio.AsyncResult] structure will be passed to the callback.  That
+ * callback should then call [method@Gio.Mount.unmount_with_operation_finish]
+ * with the `GMount` and the [iface@Gio.AsyncResult] data to see if the
+ * operation was completed successfully.  If an `error` is present when
+ * [method@Gio.Mount.unmount_with_operation_finish] is called, then it will be
+ * filled with any error information.
+ *
+ * Note, when porting from GnomeVFS, `GMount` is the
+ * moral equivalent of `GnomeVFSVolume`.
+ */
 export declare class Mount {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): Mount;
+    /**
+     * Checks if `mount` can be ejected.
+     */
     canEject(): boolean;
+    /**
+     * Checks if `mount` can be unmounted.
+     */
     canUnmount(): boolean;
+    /**
+     * Ejects a mount. This is an asynchronous operation, and is
+     * finished by calling g_mount_eject_finish() with the `mount` and #GAsyncResult data returned in the @callback.
+     * @param flags - flags affecting the unmount if required for eject
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback, or %NULL.
+     * @param userData - user data passed to @callback.
+     */
     eject(flags: MountUnmountFlags, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes ejecting a mount. If any errors occurred during the operation,
+     * `error` will be set to contain the errors and %FALSE will be returned.
+     * @param result - a #GAsyncResult.
+     */
     ejectFinish(result: AsyncResult): boolean;
+    /**
+     * Ejects a mount. This is an asynchronous operation, and is
+     * finished by calling g_mount_eject_with_operation_finish() with the `mount` and #GAsyncResult data returned in the @callback.
+     * @param flags - flags affecting the unmount if required for eject
+     * @param mountOperation - a #GMountOperation or %NULL to avoid
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback, or %NULL.
+     * @param userData - user data passed to @callback.
+     */
     ejectWithOperation(flags: MountUnmountFlags, mountOperation?: MountOperation | null, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes ejecting a mount. If any errors occurred during the operation,
+     * `error` will be set to contain the errors and %FALSE will be returned.
+     * @param result - a #GAsyncResult.
+     */
     ejectWithOperationFinish(result: AsyncResult): boolean;
+    /**
+     * Gets the default location of @mount. The default location of the given
+     * `mount` is a path that reflects the main entry point for the user (e.g.
+     * the home directory, or the root of the volume).
+     */
     getDefaultLocation(): File;
+    /**
+     * Gets the drive for the @mount.
+     *
+     * This is a convenience method for getting the #GVolume and then
+     * using that object to get the #GDrive.
+     */
     getDrive(): Drive | null;
+    /**
+     * Gets the icon for @mount.
+     */
     getIcon(): Icon;
+    /**
+     * Gets the name of @mount.
+     */
     getName(): string;
+    /**
+     * Gets the root directory on @mount.
+     */
     getRoot(): File;
+    /**
+     * Gets the sort key for @mount, if any.
+     */
     getSortKey(): string | null;
+    /**
+     * Gets the symbolic icon for @mount.
+     */
     getSymbolicIcon(): Icon;
+    /**
+     * Gets the UUID for the @mount. The reference is typically based on
+     * the file system UUID for the mount in question and should be
+     * considered an opaque string. Returns %NULL if there is no UUID
+     * available.
+     */
     getUuid(): string | null;
+    /**
+     * Gets the volume for the @mount.
+     */
     getVolume(): Volume | null;
+    /**
+     * Tries to guess the type of content stored on @mount. Returns one or
+     * more textual identifiers of well-known content types (typically
+     * prefixed with "x-content/"), e.g. x-content/image-dcf for camera
+     * memory cards. See the
+     * [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec)
+     * specification for more on x-content types.
+     *
+     * This is an asynchronous operation (see
+     * g_mount_guess_content_type_sync() for the synchronous version), and
+     * is finished by calling g_mount_guess_content_type_finish() with the
+     * `mount` and #GAsyncResult data returned in the @callback.
+     * @param forceRescan - Whether to force a rescan of the content.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore
+     * @param callback - a #GAsyncReadyCallback
+     * @param userData - user data passed to @callback
+     */
     guessContentType(forceRescan: boolean, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes guessing content types of @mount. If any errors occurred
+     * during the operation, `error` will be set to contain the errors and
+     * %FALSE will be returned. In particular, you may get an
+     * %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content
+     * guessing.
+     * @param result - a #GAsyncResult
+     */
     guessContentTypeFinish(result: AsyncResult): string[];
+    /**
+     * Tries to guess the type of content stored on @mount. Returns one or
+     * more textual identifiers of well-known content types (typically
+     * prefixed with "x-content/"), e.g. x-content/image-dcf for camera
+     * memory cards. See the
+     * [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec)
+     * specification for more on x-content types.
+     *
+     * This is a synchronous operation and as such may block doing IO;
+     * see g_mount_guess_content_type() for the asynchronous version.
+     * @param forceRescan - Whether to force a rescan of the content.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore
+     */
     guessContentTypeSync(forceRescan: boolean, cancellable?: Cancellable | null): string[];
+    /**
+     * Determines if `mount` is shadowed. Applications or libraries should
+     * avoid displaying `mount` in the user interface if it is shadowed.
+     *
+     * A mount is said to be shadowed if there exists one or more user
+     * visible objects (currently #GMount objects) with a root that is
+     * inside the root of @mount.
+     *
+     * One application of shadow mounts is when exposing a single file
+     * system that is used to address several logical volumes. In this
+     * situation, a #GVolumeMonitor implementation would create two
+     * #GVolume objects (for example, one for the camera functionality of
+     * the device and one for a SD card reader on the device) with
+     * activation URIs `gphoto2://[usb:001,002]/store1/`
+     * and `gphoto2://[usb:001,002]/store2/`. When the
+     * underlying mount (with root
+     * `gphoto2://[usb:001,002]/`) is mounted, said
+     * #GVolumeMonitor implementation would create two #GMount objects
+     * (each with their root matching the corresponding volume activation
+     * root) that would shadow the original mount.
+     *
+     * The proxy monitor in GVfs 2.26 and later, automatically creates and
+     * manage shadow mounts (and shadows the underlying mount) if the
+     * activation root on a #GVolume is set.
+     */
     isShadowed(): boolean;
+    /**
+     * Remounts a mount. This is an asynchronous operation, and is
+     * finished by calling g_mount_remount_finish() with the `mount` and #GAsyncResults data returned in the @callback.
+     *
+     * Remounting is useful when some setting affecting the operation
+     * of the volume has been changed, as these may need a remount to
+     * take affect. While this is semantically equivalent with unmounting
+     * and then remounting not all backends might need to actually be
+     * unmounted.
+     * @param flags - flags affecting the operation
+     * @param mountOperation - a #GMountOperation or %NULL to avoid
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback, or %NULL.
+     * @param userData - user data passed to @callback.
+     */
     remount(flags: MountMountFlags, mountOperation?: MountOperation | null, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes remounting a mount. If any errors occurred during the operation,
+     * `error` will be set to contain the errors and %FALSE will be returned.
+     * @param result - a #GAsyncResult.
+     */
     remountFinish(result: AsyncResult): boolean;
+    /**
+     * Increments the shadow count on @mount. Usually used by
+     * #GVolumeMonitor implementations when creating a shadow mount for
+     * @mount, see g_mount_is_shadowed() for more information. The caller
+     * will need to emit the #GMount::changed signal on `mount` manually.
+     */
     shadow(): void;
+    /**
+     * Unmounts a mount. This is an asynchronous operation, and is
+     * finished by calling g_mount_unmount_finish() with the `mount` and #GAsyncResult data returned in the @callback.
+     * @param flags - flags affecting the operation
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback, or %NULL.
+     * @param userData - user data passed to @callback.
+     */
     unmount(flags: MountUnmountFlags, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes unmounting a mount. If any errors occurred during the operation,
+     * `error` will be set to contain the errors and %FALSE will be returned.
+     * @param result - a #GAsyncResult.
+     */
     unmountFinish(result: AsyncResult): boolean;
+    /**
+     * Unmounts a mount. This is an asynchronous operation, and is
+     * finished by calling g_mount_unmount_with_operation_finish() with the `mount` and #GAsyncResult data returned in the @callback.
+     * @param flags - flags affecting the operation
+     * @param mountOperation - a #GMountOperation or %NULL to avoid
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback, or %NULL.
+     * @param userData - user data passed to @callback.
+     */
     unmountWithOperation(flags: MountUnmountFlags, mountOperation?: MountOperation | null, cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes unmounting a mount. If any errors occurred during the operation,
+     * `error` will be set to contain the errors and %FALSE will be returned.
+     * @param result - a #GAsyncResult.
+     */
     unmountWithOperationFinish(result: AsyncResult): boolean;
+    /**
+     * Decrements the shadow count on @mount. Usually used by
+     * #GVolumeMonitor implementations when destroying a shadow mount for
+     * @mount, see g_mount_is_shadowed() for more information. The caller
+     * will need to emit the #GMount::changed signal on `mount` manually.
+     */
     unshadow(): void;
 }