gtk.Requisition 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.Requisition;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtkc.gtk;
30 public  import gtkc.gtktypes;
31 private import gtkd.Loader;
32 
33 
34 /**
35  * A #GtkRequisition-struct represents the desired size of a widget. See
36  * [GtkWidget’s geometry management section][geometry-management] for
37  * more information.
38  */
39 public class Requisition
40 {
41 	/** the main Gtk struct */
42 	protected GtkRequisition* gtkRequisition;
43 	protected bool ownedRef;
44 
45 	/** Get the main Gtk struct */
46 	public GtkRequisition* getRequisitionStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gtkRequisition;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected void* getStruct()
55 	{
56 		return cast(void*)gtkRequisition;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GtkRequisition* gtkRequisition, bool ownedRef = false)
63 	{
64 		this.gtkRequisition = gtkRequisition;
65 		this.ownedRef = ownedRef;
66 	}
67 
68 	~this ()
69 	{
70 		if (  Linker.isLoaded(LIBRARY_GTK) && ownedRef )
71 			gtk_requisition_free(gtkRequisition);
72 	}
73 
74 
75 	/** */
76 	public static GType getType()
77 	{
78 		return gtk_requisition_get_type();
79 	}
80 
81 	/**
82 	 * Allocates a new #GtkRequisition-struct and initializes its elements to zero.
83 	 *
84 	 * Returns: a new empty #GtkRequisition. The newly allocated #GtkRequisition should
85 	 *     be freed with gtk_requisition_free().
86 	 *
87 	 * Since: 3.0
88 	 *
89 	 * Throws: ConstructionException GTK+ fails to create the object.
90 	 */
91 	public this()
92 	{
93 		auto p = gtk_requisition_new();
94 		
95 		if(p is null)
96 		{
97 			throw new ConstructionException("null returned by new");
98 		}
99 		
100 		this(cast(GtkRequisition*) p);
101 	}
102 
103 	/**
104 	 * Copies a #GtkRequisition.
105 	 *
106 	 * Returns: a copy of @requisition
107 	 */
108 	public Requisition copy()
109 	{
110 		auto p = gtk_requisition_copy(gtkRequisition);
111 		
112 		if(p is null)
113 		{
114 			return null;
115 		}
116 		
117 		return ObjectG.getDObject!(Requisition)(cast(GtkRequisition*) p, true);
118 	}
119 
120 	/**
121 	 * Frees a #GtkRequisition.
122 	 */
123 	public void free()
124 	{
125 		gtk_requisition_free(gtkRequisition);
126 		ownedRef = false;
127 	}
128 }