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.VBox;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Box;
30 private import gtk.Widget;
31 private import gtkc.gtk;
32 public  import gtkc.gtktypes;
33 
34 
35 /**
36  * A #GtkVBox is a container that organizes child widgets into a single column.
37  * 
38  * Use the #GtkBox packing interface to determine the arrangement,
39  * spacing, height, and alignment of #GtkVBox children.
40  * 
41  * All children are allocated the same width.
42  * 
43  * GtkVBox has been deprecated. You can use #GtkBox instead, which is a
44  * very quick and easy change. If you have derived your own classes from
45  * GtkVBox, you can simply change the inheritance to derive directly
46  * from #GtkBox, and set the #GtkOrientable:orientation property to
47  * %GTK_ORIENTATION_VERTICAL in your instance init function, with a
48  * call like:
49  * |[<!-- language="C" -->
50  * gtk_orientable_set_orientation (GTK_ORIENTABLE (object),
51  * GTK_ORIENTATION_VERTICAL);
52  * ]|
53  * If you don’t need first-child or last-child styling and want your code
54  * to be future-proof, the recommendation is to switch to #GtkGrid instead
55  * of nested boxes. For more information about migrating to #GtkGrid,
56  * see [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
57  */
58 public class VBox : Box
59 {
60 	/** the main Gtk struct */
61 	protected GtkVBox* gtkVBox;
62 
63 	/** Get the main Gtk struct */
64 	public GtkVBox* getVBoxStruct()
65 	{
66 		return gtkVBox;
67 	}
68 
69 	/** the main Gtk struct as a void* */
70 	protected override void* getStruct()
71 	{
72 		return cast(void*)gtkVBox;
73 	}
74 
75 	protected override void setStruct(GObject* obj)
76 	{
77 		gtkVBox = cast(GtkVBox*)obj;
78 		super.setStruct(obj);
79 	}
80 
81 	/**
82 	 * Sets our main struct and passes it to the parent class.
83 	 */
84 	public this (GtkVBox* gtkVBox, bool ownedRef = false)
85 	{
86 		this.gtkVBox = gtkVBox;
87 		super(cast(GtkBox*)gtkVBox, ownedRef);
88 	}
89 
90 	/**
91 	 */
92 
93 	public static GType getType()
94 	{
95 		return gtk_vbox_get_type();
96 	}
97 
98 	/**
99 	 * Creates a new #GtkVBox.
100 	 *
101 	 * Deprecated: You can use gtk_box_new() with %GTK_ORIENTATION_VERTICAL instead,
102 	 * which is a quick and easy change. But the recommendation is to switch to
103 	 * #GtkGrid, since #GtkBox is going to go away eventually.
104 	 * See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
105 	 *
106 	 * Params:
107 	 *     homogeneous = %TRUE if all children are to be given equal space allotments.
108 	 *     spacing = the number of pixels to place by default between children.
109 	 *
110 	 * Return: a new #GtkVBox.
111 	 *
112 	 * Throws: ConstructionException GTK+ fails to create the object.
113 	 */
114 	public this(bool homogeneous, int spacing)
115 	{
116 		auto p = gtk_vbox_new(homogeneous, spacing);
117 		
118 		if(p is null)
119 		{
120 			throw new ConstructionException("null returned by new");
121 		}
122 		
123 		this(cast(GtkVBox*) p);
124 	}
125 }