1/*
2 * Copyright © 2010 Codethink Limited
3 *
4 * SPDX-License-Identifier: LGPL-2.1-or-later
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 *
19 * Author: Ryan Lortie <desrt@desrt.ca>
20 */
21
22#ifndef __G_PERMISSION_H__
23#define __G_PERMISSION_H__
24
25#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
26#error "Only <gio/gio.h> can be included directly."
27#endif
28
29#include <gio/giotypes.h>
30
31G_BEGIN_DECLS
32
33#define G_TYPE_PERMISSION (g_permission_get_type ())
34#define G_PERMISSION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
35 G_TYPE_PERMISSION, GPermission))
36#define G_PERMISSION_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
37 G_TYPE_PERMISSION, GPermissionClass))
38#define G_IS_PERMISSION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
39 G_TYPE_PERMISSION))
40#define G_IS_PERMISSION_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), \
41 G_TYPE_PERMISSION))
42#define G_PERMISSION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
43 G_TYPE_PERMISSION, GPermissionClass))
44
45typedef struct _GPermissionPrivate GPermissionPrivate;
46typedef struct _GPermissionClass GPermissionClass;
47
48struct _GPermission
49{
50 GObject parent_instance;
51
52 /*< private >*/
53 GPermissionPrivate *priv;
54};
55
56struct _GPermissionClass {
57 GObjectClass parent_class;
58
59 gboolean (*acquire) (GPermission *permission,
60 GCancellable *cancellable,
61 GError **error);
62 void (*acquire_async) (GPermission *permission,
63 GCancellable *cancellable,
64 GAsyncReadyCallback callback,
65 gpointer user_data);
66 gboolean (*acquire_finish) (GPermission *permission,
67 GAsyncResult *result,
68 GError **error);
69
70 gboolean (*release) (GPermission *permission,
71 GCancellable *cancellable,
72 GError **error);
73 void (*release_async) (GPermission *permission,
74 GCancellable *cancellable,
75 GAsyncReadyCallback callback,
76 gpointer user_data);
77 gboolean (*release_finish) (GPermission *permission,
78 GAsyncResult *result,
79 GError **error);
80
81 gpointer reserved[16];
82};
83
84GIO_AVAILABLE_IN_ALL
85GType g_permission_get_type (void);
86GIO_AVAILABLE_IN_ALL
87gboolean g_permission_acquire (GPermission *permission,
88 GCancellable *cancellable,
89 GError **error);
90GIO_AVAILABLE_IN_ALL
91void g_permission_acquire_async (GPermission *permission,
92 GCancellable *cancellable,
93 GAsyncReadyCallback callback,
94 gpointer user_data);
95GIO_AVAILABLE_IN_ALL
96gboolean g_permission_acquire_finish (GPermission *permission,
97 GAsyncResult *result,
98 GError **error);
99
100GIO_AVAILABLE_IN_ALL
101gboolean g_permission_release (GPermission *permission,
102 GCancellable *cancellable,
103 GError **error);
104GIO_AVAILABLE_IN_ALL
105void g_permission_release_async (GPermission *permission,
106 GCancellable *cancellable,
107 GAsyncReadyCallback callback,
108 gpointer user_data);
109GIO_AVAILABLE_IN_ALL
110gboolean g_permission_release_finish (GPermission *permission,
111 GAsyncResult *result,
112 GError **error);
113
114GIO_AVAILABLE_IN_ALL
115gboolean g_permission_get_allowed (GPermission *permission);
116GIO_AVAILABLE_IN_ALL
117gboolean g_permission_get_can_acquire (GPermission *permission);
118GIO_AVAILABLE_IN_ALL
119gboolean g_permission_get_can_release (GPermission *permission);
120
121GIO_AVAILABLE_IN_ALL
122void g_permission_impl_update (GPermission *permission,
123 gboolean allowed,
124 gboolean can_acquire,
125 gboolean can_release);
126
127G_END_DECLS
128
129#endif /* __G_PERMISSION_H__ */
130

source code of include/glib-2.0/gio/gpermission.h