gtk.ConstantExpression 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.ConstantExpression;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gobject.Value;
30 private import gtk.Expression;
31 private import gtk.c.functions;
32 public  import gtk.c.types;
33 
34 
35 /**
36  * A constant value in a `GtkExpression`.
37  */
38 public class ConstantExpression : Expression
39 {
40 	/** the main Gtk struct */
41 	protected GtkConstantExpression* gtkConstantExpression;
42 
43 	/** Get the main Gtk struct */
44 	public GtkConstantExpression* getConstantExpressionStruct(bool transferOwnership = false)
45 	{
46 		if (transferOwnership)
47 			ownedRef = false;
48 		return gtkConstantExpression;
49 	}
50 
51 	/** the main Gtk struct as a void* */
52 	protected override void* getStruct()
53 	{
54 		return cast(void*)gtkConstantExpression;
55 	}
56 
57 	/**
58 	 * Sets our main struct and passes it to the parent class.
59 	 */
60 	public this (GtkConstantExpression* gtkConstantExpression, bool ownedRef = false)
61 	{
62 		this.gtkConstantExpression = gtkConstantExpression;
63 		super(cast(GtkExpression*)gtkConstantExpression, ownedRef);
64 	}
65 
66 
67 	/** */
68 	public static GType getType()
69 	{
70 		return gtk_constant_expression_get_type();
71 	}
72 
73 	/**
74 	 * Creates an expression that always evaluates to the given `value`.
75 	 *
76 	 * Params:
77 	 *     value = a `GValue`
78 	 *
79 	 * Returns: a new `GtkExpression`
80 	 *
81 	 * Throws: ConstructionException GTK+ fails to create the object.
82 	 */
83 	public this(Value value)
84 	{
85 		auto __p = gtk_constant_expression_new_for_value((value is null) ? null : value.getValueStruct());
86 
87 		if(__p is null)
88 		{
89 			throw new ConstructionException("null returned by new_for_value");
90 		}
91 
92 		this(cast(GtkConstantExpression*) __p);
93 	}
94 
95 	/**
96 	 * Gets the value that a constant expression evaluates to.
97 	 *
98 	 * Returns: the value
99 	 */
100 	public Value getValue()
101 	{
102 		auto __p = gtk_constant_expression_get_value(cast(GtkExpression*)gtkConstantExpression);
103 
104 		if(__p is null)
105 		{
106 			return null;
107 		}
108 
109 		return ObjectG.getDObject!(Value)(cast(GValue*) __p);
110 	}
111 }