gio/gsimplepermission.c

   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 #include "config.h"
  23
  24 #include "gsimplepermission.h"
  25 #include "gpermission.h"
  26
  27
  28 /**
  29  * SECTION:gsimplepermission
  30  * @title: GSimplePermission
  31  * @short_description: A GPermission that doesn't change value
  32  * @include: gio/gio.h
  33  *
  34  * #GSimplePermission is a trivial implementation of #GPermission that
  35  * represents a permission that is either always or never allowed.  The
  36  * value is given at construction and doesn't change.
  37  *
  38  * Calling request or release will result in errors.
  39  **/
  40
  41 /**
  42  * GSimplePermission:
  43  *
  44  * #GSimplePermission is an opaque data structure.  There are no methods
  45  * except for those defined by #GPermission.
  46  **/
  47
  48 typedef GPermissionClass GSimplePermissionClass;
  49
  50 struct _GSimplePermission
  51 {
  52   GPermission parent_instance;
  53 };
  54
  55 G_DEFINE_TYPE (GSimplePermission, g_simple_permission, G_TYPE_PERMISSION)
  56
  57 static void
  58 g_simple_permission_init (GSimplePermission *simple)
  59 {
  60 }
  61
  62 static void
  63 g_simple_permission_class_init (GSimplePermissionClass *class)
  64 {
  65 }
  66
  67 /**
  68  * g_simple_permission_new:
  69  * @allowed: %TRUE if the action is allowed
  70  *
  71  * Creates a new #GPermission instance that represents an action that is
  72  * either always or never allowed.
  73  *
  74  * Returns: the #GSimplePermission, as a #GPermission
  75  *
  76  * Since: 2.26
  77  **/
  78 GPermission *
  79 g_simple_permission_new (gboolean allowed)
  80 {
  81   GPermission *permission = g_object_new (G_TYPE_SIMPLE_PERMISSION, NULL);
  82
  83   g_permission_impl_update (permission, allowed, FALSE, FALSE);
  84
  85   return permission;
  86 }