gtk.HBox 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.HBox;
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  * #GtkHBox is a container that organizes child widgets into a single row.
37  * 
38  * Use the #GtkBox packing interface to determine the arrangement,
39  * spacing, width, and alignment of #GtkHBox children.
40  * 
41  * All children are allocated the same height.
42  * 
43  * GtkHBox 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  * GtkHBox, you can simply change the inheritance to derive directly
46  * from #GtkBox. No further changes are needed, since the default
47  * value of the #GtkOrientable:orientation property is
48  * %GTK_ORIENTATION_HORIZONTAL.
49  * If you don’t need first-child or last-child styling, and want your code
50  * to be future-proof, the recommendation is to switch to #GtkGrid instead
51  * of nested boxes. For more information about migrating to #GtkGrid,
52  * see [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
53  */
54 public class HBox : Box
55 {
56 	/** the main Gtk struct */
57 	protected GtkHBox* gtkHBox;
58 
59 	/** Get the main Gtk struct */
60 	public GtkHBox* getHBoxStruct()
61 	{
62 		return gtkHBox;
63 	}
64 
65 	/** the main Gtk struct as a void* */
66 	protected override void* getStruct()
67 	{
68 		return cast(void*)gtkHBox;
69 	}
70 
71 	protected override void setStruct(GObject* obj)
72 	{
73 		gtkHBox = cast(GtkHBox*)obj;
74 		super.setStruct(obj);
75 	}
76 
77 	/**
78 	 * Sets our main struct and passes it to the parent class.
79 	 */
80 	public this (GtkHBox* gtkHBox, bool ownedRef = false)
81 	{
82 		this.gtkHBox = gtkHBox;
83 		super(cast(GtkBox*)gtkHBox, ownedRef);
84 	}
85 
86 	/**
87 	 */
88 
89 	public static GType getType()
90 	{
91 		return gtk_hbox_get_type();
92 	}
93 
94 	/**
95 	 * Creates a new #GtkHBox.
96 	 *
97 	 * Deprecated: You can use gtk_box_new() with %GTK_ORIENTATION_HORIZONTAL instead,
98 	 * which is a quick and easy change. But the recommendation is to switch to
99 	 * #GtkGrid, since #GtkBox is going to go away eventually.
100 	 * See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
101 	 *
102 	 * Params:
103 	 *     homogeneous = %TRUE if all children are to be given equal space allotments.
104 	 *     spacing = the number of pixels to place by default between children.
105 	 *
106 	 * Return: a new #GtkHBox.
107 	 *
108 	 * Throws: ConstructionException GTK+ fails to create the object.
109 	 */
110 	public this(bool homogeneous, int spacing)
111 	{
112 		auto p = gtk_hbox_new(homogeneous, spacing);
113 		
114 		if(p is null)
115 		{
116 			throw new ConstructionException("null returned by new");
117 		}
118 		
119 		this(cast(GtkHBox*) p);
120 	}
121 }