gtk.ObjectExpression 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.ObjectExpression;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Expression;
30 private import gtk.c.functions;
31 public  import gtk.c.types;
32 
33 
34 /**
35  * A `GObject` value in a `GtkExpression`.
36  */
37 public class ObjectExpression : Expression
38 {
39 	/** the main Gtk struct */
40 	protected GtkObjectExpression* gtkObjectExpression;
41 
42 	/** Get the main Gtk struct */
43 	public GtkObjectExpression* getObjectExpressionStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return gtkObjectExpression;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gtkObjectExpression;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GtkObjectExpression* gtkObjectExpression, bool ownedRef = false)
60 	{
61 		this.gtkObjectExpression = gtkObjectExpression;
62 		super(cast(GtkExpression*)gtkObjectExpression, ownedRef);
63 	}
64 
65 
66 	/** */
67 	public static GType getType()
68 	{
69 		return gtk_object_expression_get_type();
70 	}
71 
72 	/**
73 	 * Creates an expression evaluating to the given `object` with a weak reference.
74 	 *
75 	 * Once the `object` is disposed, it will fail to evaluate.
76 	 *
77 	 * This expression is meant to break reference cycles.
78 	 *
79 	 * If you want to keep a reference to `object`, use [ctor@Gtk.ConstantExpression.new].
80 	 *
81 	 * Params:
82 	 *     object = object to watch
83 	 *
84 	 * Returns: a new `GtkExpression`
85 	 *
86 	 * Throws: ConstructionException GTK+ fails to create the object.
87 	 */
88 	public this(ObjectG object)
89 	{
90 		auto __p = gtk_object_expression_new((object is null) ? null : object.getObjectGStruct());
91 
92 		if(__p is null)
93 		{
94 			throw new ConstructionException("null returned by new");
95 		}
96 
97 		this(cast(GtkObjectExpression*) __p);
98 	}
99 
100 	/**
101 	 * Gets the object that the expression evaluates to.
102 	 *
103 	 * Returns: the object, or `NULL`
104 	 */
105 	public ObjectG getObject()
106 	{
107 		auto __p = gtk_object_expression_get_object(cast(GtkExpression*)gtkObjectExpression);
108 
109 		if(__p is null)
110 		{
111 			return null;
112 		}
113 
114 		return ObjectG.getDObject!(ObjectG)(cast(GObject*) __p);
115 	}
116 }