diff options
author | Matthias Clasen <mclasen@redhat.com> | 2016-03-25 11:49:34 -0400 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2016-03-25 11:49:34 -0400 |
commit | 3b76c3523aada0b82bc19f0687349e18a3dd7101 (patch) | |
tree | 3e46381b806e7c347b0fad554ddb085d1faf101e | |
parent | 2a2ae8008b9a8b3c092d3da69d740e851884c649 (diff) | |
download | xdg-app-3b76c3523aada0b82bc19f0687349e18a3dd7101.tar.gz |
docs: Document XdgProgressCallback
-rw-r--r-- | lib/xdg-app-installation.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/xdg-app-installation.h b/lib/xdg-app-installation.h index 343ecf7..11bb4f4 100644 --- a/lib/xdg-app-installation.h +++ b/lib/xdg-app-installation.h @@ -73,6 +73,19 @@ XDG_APP_EXTERN XdgAppInstallation *xdg_app_installation_new_for_path (GFile *pat GCancellable *cancellable, GError **error); +/** + * XdgAppProgressCallback: + * @status: A status string, suitable for display + * @progress: percentage of completion + * @estimating: whether @progress is just an estimate + * @user_data: User data passed to the caller + * + * The progress callback is called repeatedly during long-running operations + * such as installations or updates, and can be used to update progress information + * in a user interface. + * + * The callback occurs in the thread-default context of the caller. + */ typedef void (*XdgAppProgressCallback)(const char *status, guint progress, gboolean estimating, |