luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-23 20:46:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GMountOperation SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-23 14:41:19 +01:00
parent 47da98d7f7
commit f17cb81ce5
2 changed files with 9 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
gio/gmountoperation.c
View File

@ -31,27 +31,25 @@
/**
* SECTION:gmountoperation
* @short_description: Object used for authentication and user interaction
* @include: gio/gio.h
* GMountOperation:
*
* #GMountOperation provides a mechanism for interacting with the user.
* `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 #GMount
* objects – for example it is also used in g_drive_start() and
* g_drive_stop().
* 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.
* [class@Gtk.MountOperation]. 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.
*
* The term ‘TCRYPT’ is used to mean ‘compatible with TrueCrypt and VeraCrypt’.
* 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

6
gio/gmountoperation.h
View File

@ -38,12 +38,6 @@ G_BEGIN_DECLS
#define G_IS_MOUNT_OPERATION_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MOUNT_OPERATION))
#define G_MOUNT_OPERATION_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MOUNT_OPERATION, GMountOperationClass))
/**
* GMountOperation:
*
* Class for providing authentication methods for mounting operations,
* such as mounting a file locally, or authenticating with a server.
**/
typedef struct _GMountOperationClass GMountOperationClass;
typedef struct _GMountOperationPrivate GMountOperationPrivate;