gtk2/gtk/deprecated/gtkhbox.c
Matthias Clasen f503d4debd Clarify GtkH/VBox documentation
Make it clearer that GtkBox still has uses.

https://bugzilla.gnome.org/show_bug.cgi?id=706269
2013-09-16 22:38:49 -04:00

99 lines
3.2 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library 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 2 of the License, or (at your option) any later version.
*
* This library 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 this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include "gtkboxprivate.h"
#include "gtkorientable.h"
#include "gtkhbox.h"
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
/**
* SECTION:gtkhbox
* @Short_description: A horizontal container box
* @Title: GtkHBox
* @See_also: #GtkVBox
*
* #GtkHBox is a container that organizes child widgets into a single row.
*
* Use the #GtkBox packing interface to determine the arrangement,
* spacing, width, and alignment of #GtkHBox children.
*
* All children are allocated the same height.
*
* GtkHBox has been deprecated. You can use #GtkBox instead, which is a
* very quick and easy change. If you have derived your own classes from
* GtkHBox, you can simply change the inheritance to derive directly
* from #GtkBox. No further changes are needed, since the default
* value of the #GtkOrientable:orientation property is
* %GTK_ORIENTATION_HORIZONTAL.
* If you don't need first-child or last-child styling, and want your code
* to be future-proof, the recommendation is to switch to #GtkGrid instead
* of nested boxes. For more information about migrating to #GtkGrid,
* see <xref linkend="gtk-migrating-GtkGrid"/>
*/
G_DEFINE_TYPE (GtkHBox, gtk_hbox, GTK_TYPE_BOX)
static void
gtk_hbox_class_init (GtkHBoxClass *class)
{
}
static void
gtk_hbox_init (GtkHBox *hbox)
{
gtk_orientable_set_orientation (GTK_ORIENTABLE (hbox),
GTK_ORIENTATION_HORIZONTAL);
_gtk_box_set_old_defaults (GTK_BOX (hbox));
}
/**
* gtk_hbox_new:
* @homogeneous: %TRUE if all children are to be given equal space allotments.
* @spacing: the number of pixels to place by default between children.
*
* Creates a new #GtkHBox.
*
* Returns: a new #GtkHBox.
*
* Deprecated: 3.2: You can use gtk_box_new() with %GTK_ORIENTATION_HORIZONTAL instead,
* which is a quick and easy change. But the recommendation is to switch to
* #GtkGrid, since #GtkBox is going to go away eventually.
* See <xref linkend="gtk-migrating-GtkGrid"/>.
*/
GtkWidget *
gtk_hbox_new (gboolean homogeneous,
gint spacing)
{
return g_object_new (GTK_TYPE_HBOX,
"spacing", spacing,
"homogeneous", homogeneous ? TRUE : FALSE,
NULL);
}