/*
 * 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


module gtk.Box;

private import glib.ConstructionException;
private import gobject.ObjectG;
private import gtk.Container;
private import gtk.OrientableIF;
private import gtk.OrientableT;
private import gtk.Widget;
private import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;


/**
 * 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 child properties. 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 that a single-row or single-column #GtkGrid provides exactly
 * the same functionality as #GtkBox.
 * 
 * # CSS nodes
 * 
 * GtkBox uses a single CSS node with name box.
 * 
 * In horizontal orientation, the nodes of the children are always arranged
 * from left to right. So :first-child will always select the leftmost child,
 * regardless of text direction.
 */
public class Box : Container, OrientableIF
{
	/** the main Gtk struct */
	protected GtkBox* gtkBox;

	/** Get the main Gtk struct */
	public GtkBox* getBoxStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkBox;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkBox;
	}

	protected override void setStruct(GObject* obj)
	{
		gtkBox = cast(GtkBox*)obj;
		super.setStruct(obj);
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GtkBox* gtkBox, bool ownedRef = false)
	{
		this.gtkBox = gtkBox;
		super(cast(GtkContainer*)gtkBox, ownedRef);
	}

	// add the Orientable capabilities
	mixin OrientableT!(GtkBox);


	/** */
	public static GType getType()
	{
		return gtk_box_get_type();
	}

	/**
	 * Creates a new #GtkBox.
	 *
	 * Params:
	 *     orientation = the box’s orientation.
	 *     spacing = the number of pixels to place by default between children.
	 *
	 * Returns: a new #GtkBox.
	 *
	 * Since: 3.0
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(GtkOrientation orientation, int spacing)
	{
		auto p = gtk_box_new(orientation, spacing);

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GtkBox*) p);
	}

	/**
	 * Gets the value set by gtk_box_set_baseline_position().
	 *
	 * Returns: the baseline position
	 *
	 * Since: 3.10
	 */
	public GtkBaselinePosition getBaselinePosition()
	{
		return gtk_box_get_baseline_position(gtkBox);
	}

	/**
	 * Retrieves the center widget of the box.
	 *
	 * Returns: the center widget
	 *     or %NULL in case no center widget is set.
	 *
	 * Since: 3.12
	 */
	public Widget getCenterWidget()
	{
		auto p = gtk_box_get_center_widget(gtkBox);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Widget)(cast(GtkWidget*) p);
	}

	/**
	 * 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 bool getHomogeneous()
	{
		return gtk_box_get_homogeneous(gtkBox) != 0;
	}

	/**
	 * Gets the value set by gtk_box_set_spacing().
	 *
	 * Returns: spacing between children
	 */
	public int getSpacing()
	{
		return gtk_box_get_spacing(gtkBox);
	}

	/**
	 * 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
	 *         #GtkBox: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, bool expand, bool fill, uint padding)
	{
		gtk_box_pack_end(gtkBox, (child is null) ? null : child.getWidgetStruct(), expand, fill, padding);
	}

	/**
	 * 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
	 *         #GtkBox: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, bool expand, bool fill, uint padding)
	{
		gtk_box_pack_start(gtkBox, (child is null) ? null : child.getWidgetStruct(), expand, fill, padding);
	}

	/**
	 * 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
	 *     fill = pointer to return location for fill child
	 *         property
	 *     padding = pointer to return location for padding
	 *         child property
	 *     packType = pointer to return location for pack-type
	 *         child property
	 */
	public void queryChildPacking(Widget child, out bool expand, out bool fill, out uint padding, out GtkPackType packType)
	{
		int outexpand;
		int outfill;

		gtk_box_query_child_packing(gtkBox, (child is null) ? null : child.getWidgetStruct(), &outexpand, &outfill, &padding, &packType);

		expand = (outexpand == 1);
		fill = (outfill == 1);
	}

	/**
	 * Moves @child to a new @position in the list of @box children.
	 * The list contains 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)
	{
		gtk_box_reorder_child(gtkBox, (child is null) ? null : child.getWidgetStruct(), position);
	}

	/**
	 * 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 available 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)
	{
		gtk_box_set_baseline_position(gtkBox, position);
	}

	/**
	 * Sets a center widget; that is a child widget that will be
	 * centered with respect to the full width of the box, even
	 * if the children at either side take up different amounts
	 * of space.
	 *
	 * Params:
	 *     widget = the widget to center
	 *
	 * Since: 3.12
	 */
	public void setCenterWidget(Widget widget)
	{
		gtk_box_set_center_widget(gtkBox, (widget is null) ? null : widget.getWidgetStruct());
	}

	/**
	 * 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, bool expand, bool fill, uint padding, GtkPackType packType)
	{
		gtk_box_set_child_packing(gtkBox, (child is null) ? null : child.getWidgetStruct(), expand, fill, padding, packType);
	}

	/**
	 * Sets the #GtkBox: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(bool homogeneous)
	{
		gtk_box_set_homogeneous(gtkBox, homogeneous);
	}

	/**
	 * Sets the #GtkBox: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)
	{
		gtk_box_set_spacing(gtkBox, spacing);
	}
}