]> Pileus Git - ~andy/gtk/blob - gtk/gtkhbox.c
Move documentation to inline comments: GtkHBox
[~andy/gtk] / gtk / gtkhbox.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25  */
26
27 #include "config.h"
28
29 #include "gtkhbox.h"
30 #include "gtkorientable.h"
31 #include "gtkalias.h"
32
33
34 /**
35  * SECTION:gtkhbox
36  * @Short_description: A horizontal container box
37  * @Title: GtkHBox
38  * @See_also: #GtkVBox
39  *
40  * #GtkHBox is a container that organizes child widgets into a single row.
41  *
42  * Use the #GtkBox packing interface to determine the arrangement,
43  * spacing, width, and alignment of #GtkHBox children.
44  *
45  * All children are allocated the same height.
46  */
47
48
49 G_DEFINE_TYPE (GtkHBox, gtk_hbox, GTK_TYPE_BOX)
50
51 static void
52 gtk_hbox_class_init (GtkHBoxClass *class)
53 {
54 }
55
56 static void
57 gtk_hbox_init (GtkHBox *hbox)
58 {
59   gtk_orientable_set_orientation (GTK_ORIENTABLE (hbox),
60                                   GTK_ORIENTATION_HORIZONTAL);
61
62   _gtk_box_set_old_defaults (GTK_BOX (hbox));
63 }
64
65 /**
66  * gtk_hbox_new:
67  * @homogeneous: %TRUE if all children are to be given equal space allotments.
68  * @spacing: the number of pixels to place by default between children.
69  *
70  * Creates a new #GtkHBox.
71  *
72  * Returns: a new #GtkHBox.
73  */
74 GtkWidget *
75 gtk_hbox_new (gboolean homogeneous,
76               gint     spacing)
77 {
78   return g_object_new (GTK_TYPE_HBOX,
79                        "spacing",     spacing,
80                        "homogeneous", homogeneous ? TRUE : FALSE,
81                        NULL);
82 }
83
84 #define __GTK_HBOX_C__
85 #include "gtkaliasdef.c"