package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.gio/Ocgtk_gio/Gio/Wrappers/Permission/index.html

Module Wrappers.Permission

type t = [ `permission | `object_ ] Gobject.obj
val release_finish : t -> [ `async_result ] Gobject.obj -> (bool, GError.t) result

Collects the result of attempting to release the permission represented by @permission.

This is the second half of the asynchronous version of g_permission_release().

val release : t -> [ `cancellable | `object_ ] Gobject.obj option -> (bool, GError.t) result

Attempts to release the permission represented by @permission.

The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the permission will be dropped immediately without further action.

You should check with g_permission_get_can_release() before calling this function.

If the permission is released then %TRUE is returned. Otherwise, %FALSE is returned and @error is set appropriately.

This call is blocking, likely for a very long time (in the case that user interaction is required). See g_permission_release_async() for the non-blocking version.

val impl_update : t -> bool -> bool -> bool -> unit

This function is called by the #GPermission implementation to update the properties of the permission. You should never call this function except from a #GPermission implementation.

GObject notify signals are generated, as appropriate.

val get_can_release : t -> bool

Gets the value of the 'can-release' property. This property is %TRUE if it is generally possible to release the permission by calling g_permission_release().

val get_can_acquire : t -> bool

Gets the value of the 'can-acquire' property. This property is %TRUE if it is generally possible to acquire the permission by calling g_permission_acquire().

val get_allowed : t -> bool

Gets the value of the 'allowed' property. This property is %TRUE if the caller currently has permission to perform the action that @permission represents the permission to perform.

val acquire_finish : t -> [ `async_result ] Gobject.obj -> (bool, GError.t) result

Collects the result of attempting to acquire the permission represented by @permission.

This is the second half of the asynchronous version of g_permission_acquire().

val acquire : t -> [ `cancellable | `object_ ] Gobject.obj option -> (bool, GError.t) result

Attempts to acquire the permission represented by @permission.

The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is that a dialog may appear asking the user to enter their password.

You should check with g_permission_get_can_acquire() before calling this function.

If the permission is acquired then %TRUE is returned. Otherwise, %FALSE is returned and @error is set appropriately.

This call is blocking, likely for a very long time (in the case that user interaction is required). See g_permission_acquire_async() for the non-blocking version.