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