.\" Copyright (c) 2002-2007 Hypertriton, Inc. <http://hypertriton.com/>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd June 10, 2003
.Dt AG_HBOX 3
.Os
.ds vT Agar API Reference
.ds oS Agar 1.0
.Sh NAME
.Nm AG_HBox
.Nd agar horizontal container widget
.Sh SYNOPSIS
.Bd -literal
#include <agar/core.h>
#include <agar/gui.h>
.Ed
.Sh DESCRIPTION
The
.Nm
widget is a variant of
.Xr AG_Box 3
which packs its children horizontally.
.Sh INHERITANCE HIERARCHY
.Xr AG_Object 3 ->
.Xr AG_Widget 3 ->
.Xr AG_Box 3 ->
.Nm .
.Sh INITIALIZATION
.nr nS 1
.Ft "AG_HBox *"
.Fn AG_HBoxNew "AG_Widget *parent" "int flags"
.Pp
.Ft void
.Fn AG_HBoxSetHomogenous "AG_HBox *box" "int homogenous"
.Pp
.Ft void
.Fn AG_HBoxSetPadding "AG_HBox *box" "int padding"
.Pp
.Ft void
.Fn AG_HBoxSetSpacing "AG_Box *hbox" "int spacing"
.Pp
.nr nS 0
The
.Fn AG_HBoxNew
function allocates, initializes, and attaches a new
.Nm
widget.
There are currently no
.Fa flags
specific to this widget.
.Pp
The
.Fn AG_HBoxSetHomogenous
function defines whether avialable space is divided evenly between attached
widgets.
.Pp
The
.Fn AG_HBoxSetPadding
function sets the padding around the group of child widgets to
.Fa padding
pixels.
.Fn AG_HBoxSetSpacing
sets the spacing between individual child widgets to
.Fa spacing
pixels.
.Sh EVENTS
The
.Nm
widget neither reacts to nor generates any event.
.Sh SEE ALSO
.Xr AG_Intro 3 ,
.Xr AG_Box 3 ,
.Xr AG_VBox 3 ,
.Xr AG_Widget 3 ,
.Xr AG_Window 3
.Sh HISTORY
The
.Nm
widget first appeared in Agar 1.0.