Merge remote branch 'gvdb/master'
[platform/upstream/glib.git] / gio / gpermission.h
1 /*
2  * Copyright © 2010 Codethink Limited
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the licence, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  *
19  * Author: Ryan Lortie <desrt@desrt.ca>
20  */
21
22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
23 #error "Only <gio/gio.h> can be included directly."
24 #endif
25
26 #ifndef __G_PERMISSION_H__
27 #define __G_PERMISSION_H__
28
29 #include <gio/giotypes.h>
30
31 G_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
45 typedef struct _GPermissionPrivate    GPermissionPrivate;
46 typedef struct _GPermissionClass      GPermissionClass;
47
48 struct _GPermission
49 {
50   GObject parent_instance;
51
52   /*< private >*/
53   GPermissionPrivate *priv;
54 };
55
56 struct _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
84 GType           g_permission_get_type           (void);
85 gboolean        g_permission_acquire            (GPermission          *permission,
86                                                  GCancellable         *cancellable,
87                                                  GError              **error);
88 void            g_permission_acquire_async      (GPermission          *permission,
89                                                  GCancellable         *cancellable,
90                                                  GAsyncReadyCallback   callback,
91                                                  gpointer              user_data);
92 gboolean        g_permission_acquire_finish     (GPermission          *permission,
93                                                  GAsyncResult         *result,
94                                                  GError              **error);
95
96 gboolean        g_permission_release            (GPermission          *permission,
97                                                  GCancellable         *cancellable,
98                                                  GError              **error);
99 void            g_permission_release_async      (GPermission          *permission,
100                                                  GCancellable         *cancellable,
101                                                  GAsyncReadyCallback   callback,
102                                                  gpointer              user_data);
103 gboolean        g_permission_release_finish     (GPermission          *permission,
104                                                  GAsyncResult         *result,
105                                                  GError              **error);
106
107 gboolean        g_permission_get_allowed        (GPermission   *permission);
108 gboolean        g_permission_get_can_acquire    (GPermission   *permission);
109 gboolean        g_permission_get_can_release    (GPermission   *permission);
110
111 void            g_permission_impl_update        (GPermission  *permission,
112                                                  gboolean      allowed,
113                                                  gboolean      can_acquire,
114                                                  gboolean      can_release);
115
116 G_END_DECLS
117
118 #endif /* __G_PERMISSION_H__ */