]> Pileus Git - ~andy/gtk/blob - gtk/deprecated/gtkhbox.c
3ea3253a30cb7dc12e6604109cc0b667dc414ddc
[~andy/gtk] / gtk / deprecated / 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 "gtkboxprivate.h"
30 #include "gtkorientable.h"
31
32 #include "gtkhbox.h"
33
34
35 /**
36  * SECTION:gtkhbox
37  * @Short_description: A horizontal container box
38  * @Title: GtkHBox
39  * @See_also: #GtkVBox
40  *
41  * #GtkHBox is a container that organizes child widgets into a single row.
42  *
43  * Use the #GtkBox packing interface to determine the arrangement,
44  * spacing, width, and alignment of #GtkHBox children.
45  *
46  * All children are allocated the same height.
47  *
48  * GtkHBox has been deprecated. You can use #GtkBox instead, which is a
49  * very quick and easy change. If you have derived your own classes from
50  * GtkHBox, you can simply change the inheritance to derive directly
51  * from #GtkBox. No further changes are needed, since the default
52  * value of the #GtkOrientable:orientation property is
53  * %GTK_ORIENTATION_HORIZONTAL.
54  * If you want your code to be future-proof, the recommendation is to
55  * switch to #GtkGrid, since #GtkBox is going to be deprecated in favor
56  * of the more flexible grid widget eventually. For more information
57  * about migrating to #GtkGrid, see <xref linkend="gtk-migrating-GtkGrid"/>
58  */
59
60
61 G_DEFINE_TYPE (GtkHBox, gtk_hbox, GTK_TYPE_BOX)
62
63 static void
64 gtk_hbox_class_init (GtkHBoxClass *class)
65 {
66 }
67
68 static void
69 gtk_hbox_init (GtkHBox *hbox)
70 {
71   gtk_orientable_set_orientation (GTK_ORIENTABLE (hbox),
72                                   GTK_ORIENTATION_HORIZONTAL);
73
74   _gtk_box_set_old_defaults (GTK_BOX (hbox));
75 }
76
77 /**
78  * gtk_hbox_new:
79  * @homogeneous: %TRUE if all children are to be given equal space allotments.
80  * @spacing: the number of pixels to place by default between children.
81  *
82  * Creates a new #GtkHBox.
83  *
84  * Returns: a new #GtkHBox.
85  *
86  * Deprecated: 3.2: You can use gtk_box_new() with %GTK_ORIENTATION_HORIZONTAL instead,
87  *   which is a quick and easy change. But the recommendation is to switch to
88  *   #GtkGrid, since #GtkBox is going to go away eventually.
89  *   See <xref linkend="gtk-migrating-GtkGrid"/>.
90  */
91 GtkWidget *
92 gtk_hbox_new (gboolean homogeneous,
93               gint     spacing)
94 {
95   return g_object_new (GTK_TYPE_HBOX,
96                        "spacing",     spacing,
97                        "homogeneous", homogeneous ? TRUE : FALSE,
98                        NULL);
99 }