gio.SimplePermission source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.SimplePermission;
26 
27 private import gio.Permission;
28 private import gio.c.functions;
29 public  import gio.c.types;
30 private import glib.ConstructionException;
31 private import gobject.ObjectG;
32 public  import gtkc.giotypes;
33 
34 
35 /**
36  * #GSimplePermission is a trivial implementation of #GPermission that
37  * represents a permission that is either always or never allowed.  The
38  * value is given at construction and doesn't change.
39  * 
40  * Calling request or release will result in errors.
41  */
42 public class SimplePermission : Permission
43 {
44 	/** the main Gtk struct */
45 	protected GSimplePermission* gSimplePermission;
46 
47 	/** Get the main Gtk struct */
48 	public GSimplePermission* getSimplePermissionStruct(bool transferOwnership = false)
49 	{
50 		if (transferOwnership)
51 			ownedRef = false;
52 		return gSimplePermission;
53 	}
54 
55 	/** the main Gtk struct as a void* */
56 	protected override void* getStruct()
57 	{
58 		return cast(void*)gSimplePermission;
59 	}
60 
61 	/**
62 	 * Sets our main struct and passes it to the parent class.
63 	 */
64 	public this (GSimplePermission* gSimplePermission, bool ownedRef = false)
65 	{
66 		this.gSimplePermission = gSimplePermission;
67 		super(cast(GPermission*)gSimplePermission, ownedRef);
68 	}
69 
70 
71 	/** */
72 	public static GType getType()
73 	{
74 		return g_simple_permission_get_type();
75 	}
76 
77 	/**
78 	 * Creates a new #GPermission instance that represents an action that is
79 	 * either always or never allowed.
80 	 *
81 	 * Params:
82 	 *     allowed = %TRUE if the action is allowed
83 	 *
84 	 * Returns: the #GSimplePermission, as a #GPermission
85 	 *
86 	 * Since: 2.26
87 	 *
88 	 * Throws: ConstructionException GTK+ fails to create the object.
89 	 */
90 	public this(bool allowed)
91 	{
92 		auto p = g_simple_permission_new(allowed);
93 
94 		if(p is null)
95 		{
96 			throw new ConstructionException("null returned by new");
97 		}
98 
99 		this(cast(GSimplePermission*) p, true);
100 	}
101 }