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.CellAreaBox;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.CellArea;
30 private import gtk.CellRenderer;
31 private import gtk.OrientableIF;
32 private import gtk.OrientableT;
33 private import gtk.c.functions;
34 public  import gtk.c.types;
35 public  import gtkc.gtktypes;
36 
37 
38 /**
39  * The #GtkCellAreaBox renders cell renderers into a row or a column
40  * depending on its #GtkOrientation.
41  * 
42  * GtkCellAreaBox uses a notion of packing. Packing
43  * refers to adding cell renderers with reference to a particular position
44  * in a #GtkCellAreaBox. There are two reference positions: the
45  * start and the end of the box.
46  * When the #GtkCellAreaBox is oriented in the %GTK_ORIENTATION_VERTICAL
47  * orientation, the start is defined as the top of the box and the end is
48  * defined as the bottom. In the %GTK_ORIENTATION_HORIZONTAL orientation
49  * start is defined as the left side and the end is defined as the right
50  * side.
51  * 
52  * Alignments of #GtkCellRenderers rendered in adjacent rows can be
53  * configured by configuring the #GtkCellAreaBox align child cell property
54  * with gtk_cell_area_cell_set_property() or by specifying the "align"
55  * argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end().
56  */
57 public class CellAreaBox : CellArea, OrientableIF
58 {
59 	/** the main Gtk struct */
60 	protected GtkCellAreaBox* gtkCellAreaBox;
61 
62 	/** Get the main Gtk struct */
63 	public GtkCellAreaBox* getCellAreaBoxStruct(bool transferOwnership = false)
64 	{
65 		if (transferOwnership)
66 			ownedRef = false;
67 		return gtkCellAreaBox;
68 	}
69 
70 	/** the main Gtk struct as a void* */
71 	protected override void* getStruct()
72 	{
73 		return cast(void*)gtkCellAreaBox;
74 	}
75 
76 	/**
77 	 * Sets our main struct and passes it to the parent class.
78 	 */
79 	public this (GtkCellAreaBox* gtkCellAreaBox, bool ownedRef = false)
80 	{
81 		this.gtkCellAreaBox = gtkCellAreaBox;
82 		super(cast(GtkCellArea*)gtkCellAreaBox, ownedRef);
83 	}
84 
85 	// add the Orientable capabilities
86 	mixin OrientableT!(GtkCellAreaBox);
87 
88 
89 	/** */
90 	public static GType getType()
91 	{
92 		return gtk_cell_area_box_get_type();
93 	}
94 
95 	/**
96 	 * Creates a new #GtkCellAreaBox.
97 	 *
98 	 * Returns: a newly created #GtkCellAreaBox
99 	 *
100 	 * Since: 3.0
101 	 *
102 	 * Throws: ConstructionException GTK+ fails to create the object.
103 	 */
104 	public this()
105 	{
106 		auto p = gtk_cell_area_box_new();
107 
108 		if(p is null)
109 		{
110 			throw new ConstructionException("null returned by new");
111 		}
112 
113 		this(cast(GtkCellAreaBox*) p);
114 	}
115 
116 	/**
117 	 * Gets the spacing added between cell renderers.
118 	 *
119 	 * Returns: the space added between cell renderers in @box.
120 	 *
121 	 * Since: 3.0
122 	 */
123 	public int getSpacing()
124 	{
125 		return gtk_cell_area_box_get_spacing(gtkCellAreaBox);
126 	}
127 
128 	/**
129 	 * Adds @renderer to @box, packed with reference to the end of @box.
130 	 *
131 	 * The @renderer is packed after (away from end of) any other
132 	 * #GtkCellRenderer packed with reference to the end of @box.
133 	 *
134 	 * Params:
135 	 *     renderer = the #GtkCellRenderer to add
136 	 *     expand = whether @renderer should receive extra space when the area receives
137 	 *         more than its natural size
138 	 *     alig = whether @renderer should be aligned in adjacent rows
139 	 *     fixed = whether @renderer should have the same size in all rows
140 	 *
141 	 * Since: 3.0
142 	 */
143 	public void packEnd(CellRenderer renderer, bool expand, bool alig, bool fixed)
144 	{
145 		gtk_cell_area_box_pack_end(gtkCellAreaBox, (renderer is null) ? null : renderer.getCellRendererStruct(), expand, alig, fixed);
146 	}
147 
148 	/**
149 	 * Adds @renderer to @box, packed with reference to the start of @box.
150 	 *
151 	 * The @renderer is packed after any other #GtkCellRenderer packed
152 	 * with reference to the start of @box.
153 	 *
154 	 * Params:
155 	 *     renderer = the #GtkCellRenderer to add
156 	 *     expand = whether @renderer should receive extra space when the area receives
157 	 *         more than its natural size
158 	 *     alig = whether @renderer should be aligned in adjacent rows
159 	 *     fixed = whether @renderer should have the same size in all rows
160 	 *
161 	 * Since: 3.0
162 	 */
163 	public void packStart(CellRenderer renderer, bool expand, bool alig, bool fixed)
164 	{
165 		gtk_cell_area_box_pack_start(gtkCellAreaBox, (renderer is null) ? null : renderer.getCellRendererStruct(), expand, alig, fixed);
166 	}
167 
168 	/**
169 	 * Sets the spacing to add between cell renderers in @box.
170 	 *
171 	 * Params:
172 	 *     spacing = the space to add between #GtkCellRenderers
173 	 *
174 	 * Since: 3.0
175 	 */
176 	public void setSpacing(int spacing)
177 	{
178 		gtk_cell_area_box_set_spacing(gtkCellAreaBox, spacing);
179 	}
180 }