/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = GtkBox.html
 * outPack = gtk
 * outFile = Box
 * strct   = GtkBox
 * realStrct=
 * ctorStrct=
 * clss    = Box
 * interf  = 
 * class Code: Yes
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * 	- OrientableIF
 * prefixes:
 * 	- gtk_box_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- gtk.Widget
 * 	- gtk.OrientableIF
 * 	- gtk.OrientableT
 * structWrap:
 * 	- GtkWidget* -> Widget
 * module aliases:
 * local aliases:
 * overrides:
 */

module gtk.Box;

public  import gtkc.gtktypes;

private import gtkc.gtk;
private import glib.ConstructionException;
private import gobject.ObjectG;

private import gtk.Widget;
private import gtk.OrientableIF;
private import gtk.OrientableT;


private import gtk.Container;

/**
 * The GtkBox widget organizes child widgets into a rectangular area.
 *
 * The rectangular area of a GtkBox is organized into either a single row
 * or a single column of child widgets depending upon the orientation.
 * Thus, all children of a GtkBox are allocated one dimension in common,
 * which is the height of a row, or the width of a column.
 *
 * GtkBox uses a notion of packing. Packing refers
 * to adding widgets with reference to a particular position in a
 * GtkContainer. For a GtkBox, there are two reference positions: the
 * start and the end of the box.
 * For a vertical GtkBox, the start is defined as the top of the box and
 * the end is defined as the bottom. For a horizontal GtkBox the start
 * is defined as the left side and the end is defined as the right side.
 *
 * Use repeated calls to gtk_box_pack_start() to pack widgets into a
 * GtkBox from start to end. Use gtk_box_pack_end() to add widgets from
 * end to start. You may intersperse these calls and add widgets from
 * both ends of the same GtkBox.
 *
 * Because GtkBox is a GtkContainer, you may also use gtk_container_add()
 * to insert widgets into the box, and they will be packed with the default
 * values for "expand" and "fill". Use gtk_container_remove()
 * to remove widgets from the GtkBox.
 *
 * Use gtk_box_set_homogeneous() to specify whether or not all children
 * of the GtkBox are forced to get the same amount of space.
 *
 * Use gtk_box_set_spacing() to determine how much space will be
 * minimally placed between all children in the GtkBox. Note that
 * spacing is added between the children, while
 * padding added by gtk_box_pack_start() or gtk_box_pack_end() is added
 * on either side of the widget it belongs to.
 *
 * Use gtk_box_reorder_child() to move a GtkBox child to a different
 * place in the box.
 *
 * Use gtk_box_set_child_packing() to reset the "expand",
 * "fill" and "padding" child properties.
 * Use gtk_box_query_child_packing() to query these fields.
 *
 * Note
 *
 * Note that a single-row or single-column GtkGrid provides exactly
 * the same functionality as GtkBox.
 */
public class Box : Container, OrientableIF
{
	
	/** the main Gtk struct */
	protected GtkBox* gtkBox;
	
	
	/** Get the main Gtk struct */
	public GtkBox* getBoxStruct()
	{
		return gtkBox;
	}
	
	
	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkBox;
	}
	
	/**
	 * Sets our main struct and passes it to the parent class
	 */
	public this (GtkBox* gtkBox)
	{
		super(cast(GtkContainer*)gtkBox);
		this.gtkBox = gtkBox;
	}
	
	protected override void setStruct(GObject* obj)
	{
		super.setStruct(obj);
		gtkBox = cast(GtkBox*)obj;
	}
	
	// add the Orientable capabilities
	mixin OrientableT!(GtkBox);
	
	/**
	 */
	
	/**
	 * Creates a new GtkBox.
	 * Params:
	 * orientation = the box's orientation.
	 * spacing = the number of pixels to place by default between children.
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this (GtkOrientation orientation, int spacing)
	{
		// GtkWidget * gtk_box_new (GtkOrientation orientation,  gint spacing);
		auto p = gtk_box_new(orientation, spacing);
		if(p is null)
		{
			throw new ConstructionException("null returned by gtk_box_new(orientation, spacing)");
		}
		this(cast(GtkBox*) p);
	}
	
	/**
	 * Adds child to box, packed with reference to the start of box.
	 * The child is packed after any other child packed with reference
	 * to the start of box.
	 * Params:
	 * child = the GtkWidget to be added to box
	 * expand = TRUE if the new child is to be given extra space allocated
	 * to box. The extra space will be divided evenly between all children
	 * that use this option
	 * fill = TRUE if space given to child by the expand option is
	 * actually allocated to child, rather than just padding it. This
	 * parameter has no effect if expand is set to FALSE. A child is
	 * always allocated the full height of a horizontal GtkBox and the full width
	 * of a vertical GtkBox. This option affects the other dimension
	 * padding = extra space in pixels to put between this child and its
	 * neighbors, over and above the global amount specified by
	 * "spacing" property. If child is a widget at one of the
	 * reference ends of box, then padding pixels are also put between
	 * child and the reference edge of box
	 */
	public void packStart(Widget child, int expand, int fill, uint padding)
	{
		// void gtk_box_pack_start (GtkBox *box,  GtkWidget *child,  gboolean expand,  gboolean fill,  guint padding);
		gtk_box_pack_start(gtkBox, (child is null) ? null : child.getWidgetStruct(), expand, fill, padding);
	}
	
	/**
	 * Adds child to box, packed with reference to the end of box.
	 * The child is packed after (away from end of) any other child
	 * packed with reference to the end of box.
	 * Params:
	 * child = the GtkWidget to be added to box
	 * expand = TRUE if the new child is to be given extra space allocated
	 * to box. The extra space will be divided evenly between all children
	 * of box that use this option
	 * fill = TRUE if space given to child by the expand option is
	 * actually allocated to child, rather than just padding it. This
	 * parameter has no effect if expand is set to FALSE. A child is
	 * always allocated the full height of a horizontal GtkBox and the full width
	 * of a vertical GtkBox. This option affects the other dimension
	 * padding = extra space in pixels to put between this child and its
	 * neighbors, over and above the global amount specified by
	 * "spacing" property. If child is a widget at one of the
	 * reference ends of box, then padding pixels are also put between
	 * child and the reference edge of box
	 */
	public void packEnd(Widget child, int expand, int fill, uint padding)
	{
		// void gtk_box_pack_end (GtkBox *box,  GtkWidget *child,  gboolean expand,  gboolean fill,  guint padding);
		gtk_box_pack_end(gtkBox, (child is null) ? null : child.getWidgetStruct(), expand, fill, padding);
	}
	
	/**
	 * Returns whether the box is homogeneous (all children are the
	 * same size). See gtk_box_set_homogeneous().
	 * Returns: TRUE if the box is homogeneous.
	 */
	public int getHomogeneous()
	{
		// gboolean gtk_box_get_homogeneous (GtkBox *box);
		return gtk_box_get_homogeneous(gtkBox);
	}
	
	/**
	 * Sets the "homogeneous" property of box, controlling
	 * whether or not all children of box are given equal space
	 * in the box.
	 * Params:
	 * homogeneous = a boolean value, TRUE to create equal allotments,
	 * FALSE for variable allotments
	 */
	public void setHomogeneous(int homogeneous)
	{
		// void gtk_box_set_homogeneous (GtkBox *box,  gboolean homogeneous);
		gtk_box_set_homogeneous(gtkBox, homogeneous);
	}
	
	/**
	 * Gets the value set by gtk_box_set_spacing().
	 * Returns: spacing between children
	 */
	public int getSpacing()
	{
		// gint gtk_box_get_spacing (GtkBox *box);
		return gtk_box_get_spacing(gtkBox);
	}
	
	/**
	 * Sets the "spacing" property of box, which is the
	 * number of pixels to place between children of box.
	 * Params:
	 * spacing = the number of pixels to put between children
	 */
	public void setSpacing(int spacing)
	{
		// void gtk_box_set_spacing (GtkBox *box,  gint spacing);
		gtk_box_set_spacing(gtkBox, spacing);
	}
	
	/**
	 * Moves child to a new position in the list of box children.
	 * The list is the children field of
	 * GtkBox, and contains both widgets packed GTK_PACK_START
	 * as well as widgets packed GTK_PACK_END, in the order that these
	 * widgets were added to box.
	 * A widget's position in the box children list determines where
	 * the widget is packed into box. A child widget at some position
	 * in the list will be packed just after all other widgets of the
	 * same packing type that appear earlier in the list.
	 * Params:
	 * child = the GtkWidget to move
	 * position = the new position for child in the list of children
	 * of box, starting from 0. If negative, indicates the end of
	 * the list
	 */
	public void reorderChild(Widget child, int position)
	{
		// void gtk_box_reorder_child (GtkBox *box,  GtkWidget *child,  gint position);
		gtk_box_reorder_child(gtkBox, (child is null) ? null : child.getWidgetStruct(), position);
	}
	
	/**
	 * Obtains information about how child is packed into box.
	 * Params:
	 * child = the GtkWidget of the child to query
	 * expand = pointer to return location for "expand" child
	 * property. [out]
	 * fill = pointer to return location for "fill" child
	 * property. [out]
	 * padding = pointer to return location for "padding"
	 * child property. [out]
	 * packType = pointer to return location for "pack-type"
	 * child property. [out]
	 */
	public void queryChildPacking(Widget child, out int expand, out int fill, out uint padding, out GtkPackType packType)
	{
		// void gtk_box_query_child_packing (GtkBox *box,  GtkWidget *child,  gboolean *expand,  gboolean *fill,  guint *padding,  GtkPackType *pack_type);
		gtk_box_query_child_packing(gtkBox, (child is null) ? null : child.getWidgetStruct(), &expand, &fill, &padding, &packType);
	}
	
	/**
	 * Sets the way child is packed into box.
	 * Params:
	 * child = the GtkWidget of the child to set
	 * expand = the new value of the "expand" child property
	 * fill = the new value of the "fill" child property
	 * padding = the new value of the "padding" child property
	 * packType = the new value of the "pack-type" child property
	 */
	public void setChildPacking(Widget child, int expand, int fill, uint padding, GtkPackType packType)
	{
		// void gtk_box_set_child_packing (GtkBox *box,  GtkWidget *child,  gboolean expand,  gboolean fill,  guint padding,  GtkPackType pack_type);
		gtk_box_set_child_packing(gtkBox, (child is null) ? null : child.getWidgetStruct(), expand, fill, padding, packType);
	}
	
	/**
	 * Gets the value set by gtk_box_set_baseline_position().
	 * Returns: the baseline position Since 3.10
	 */
	public GtkBaselinePosition getBaselinePosition()
	{
		// GtkBaselinePosition gtk_box_get_baseline_position (GtkBox *box);
		return gtk_box_get_baseline_position(gtkBox);
	}
	
	/**
	 * Sets the baseline position of a box. This affects
	 * only horizontal boxes with at least one baseline aligned
	 * child. If there is more vertical space availible than requested,
	 * and the baseline is not allocated by the parent then
	 * position is used to allocate the baseline wrt the
	 * extra space available.
	 * Params:
	 * position = a GtkBaselinePosition
	 * Since 3.10
	 */
	public void setBaselinePosition(GtkBaselinePosition position)
	{
		// void gtk_box_set_baseline_position (GtkBox *box,  GtkBaselinePosition position);
		gtk_box_set_baseline_position(gtkBox, position);
	}
}