gtk.ClosureExpression 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 gtk.ClosureExpression;
26 
27 private import glib.ConstructionException;
28 private import gobject.Closure;
29 private import gobject.ObjectG;
30 private import gtk.Expression;
31 private import gtk.c.functions;
32 public  import gtk.c.types;
33 
34 
35 /**
36  * An expression using a custom `GClosure` to compute the value from
37  * its parameters.
38  */
39 public class ClosureExpression : Expression
40 {
41 	/** the main Gtk struct */
42 	protected GtkClosureExpression* gtkClosureExpression;
43 
44 	/** Get the main Gtk struct */
45 	public GtkClosureExpression* getClosureExpressionStruct(bool transferOwnership = false)
46 	{
47 		if (transferOwnership)
48 			ownedRef = false;
49 		return gtkClosureExpression;
50 	}
51 
52 	/** the main Gtk struct as a void* */
53 	protected override void* getStruct()
54 	{
55 		return cast(void*)gtkClosureExpression;
56 	}
57 
58 	/**
59 	 * Sets our main struct and passes it to the parent class.
60 	 */
61 	public this (GtkClosureExpression* gtkClosureExpression, bool ownedRef = false)
62 	{
63 		this.gtkClosureExpression = gtkClosureExpression;
64 		super(cast(GtkExpression*)gtkClosureExpression, ownedRef);
65 	}
66 
67 
68 	/** */
69 	public static GType getType()
70 	{
71 		return gtk_closure_expression_get_type();
72 	}
73 
74 	/**
75 	 * Creates a `GtkExpression` that calls `closure` when it is evaluated.
76 	 * `closure` is called with the `this` object and the results of evaluating
77 	 * the `params` expressions.
78 	 *
79 	 * Params:
80 	 *     valueType = the type of the value that this expression evaluates to
81 	 *     closure = closure to call when evaluating this expression. If closure is floating, it is adopted
82 	 *     params = expressions for each parameter
83 	 *
84 	 * Returns: a new `GtkExpression`
85 	 *
86 	 * Throws: ConstructionException GTK+ fails to create the object.
87 	 */
88 	public this(GType valueType, Closure closure, Expression[] params)
89 	{
90 		GtkExpression*[] paramsArray = new GtkExpression*[params.length];
91 		for ( int i = 0; i < params.length; i++ )
92 		{
93 			paramsArray[i] = params[i].getExpressionStruct();
94 		}
95 
96 		auto __p = gtk_closure_expression_new(valueType, (closure is null) ? null : closure.getClosureStruct(), cast(uint)params.length, paramsArray.ptr);
97 
98 		if(__p is null)
99 		{
100 			throw new ConstructionException("null returned by new");
101 		}
102 
103 		this(cast(GtkClosureExpression*) __p);
104 	}
105 }