gtk2/gtk/deprecated/gtkvbox.c
Emmanuele Bassi d1936c1ae3 docs: Clarify when to replace old boxes with Grid
Mention that GtkGrid should only replace grid-like layouts achieved with
nested boxes.

Additionally, remove any mention of "future proofing": boxes are not
going away.
2019-11-08 18:02:13 +00:00

107 lines
3.5 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.

This file contains Unicode characters that might be confused with other characters. 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 "gtkvbox.h"
#include "gtkboxprivate.h"
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
/**
* SECTION:gtkvbox
* @Short_description: A vertical container box
* @Title: GtkVBox
* @See_also: #GtkHBox
*
* A #GtkVBox is a container that organizes child widgets into a single column.
*
* Use the #GtkBox packing interface to determine the arrangement,
* spacing, height, and alignment of #GtkVBox children.
*
* All children are allocated the same width.
*
* GtkVBox has been deprecated. You can use #GtkBox with a #GtkOrientable:orientation
* set to %GTK_ORIENTATION_VERTICAL instead when calling gtk_box_new(),
* which is a very quick and easy change.
*
* If you have derived your own classes from GtkVBox, you can change the
* inheritance to derive directly from #GtkBox, and set the #GtkOrientable:orientation
* property to %GTK_ORIENTATION_VERTICAL in your instance init function,
* with a call like:
*
* |[<!-- language="C" -->
* gtk_orientable_set_orientation (GTK_ORIENTABLE (object),
* GTK_ORIENTATION_VERTICAL);
* ]|
*
* If you have a grid-like layout composed of nested boxes, and you dont
* need first-child or last-child styling, the recommendation is to switch
* to #GtkGrid. For more information about migrating to #GtkGrid, see
* [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
*/
G_DEFINE_TYPE (GtkVBox, gtk_vbox, GTK_TYPE_BOX)
static void
gtk_vbox_class_init (GtkVBoxClass *class)
{
}
static void
gtk_vbox_init (GtkVBox *vbox)
{
gtk_orientable_set_orientation (GTK_ORIENTABLE (vbox),
GTK_ORIENTATION_VERTICAL);
_gtk_box_set_old_defaults (GTK_BOX (vbox));
}
/**
* gtk_vbox_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 #GtkVBox.
*
* Returns: a new #GtkVBox.
*
* Deprecated: 3.2: You can use gtk_box_new() with %GTK_ORIENTATION_VERTICAL 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 [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
*/
GtkWidget *
gtk_vbox_new (gboolean homogeneous,
gint spacing)
{
return g_object_new (GTK_TYPE_VBOX,
"spacing", spacing,
"homogeneous", homogeneous ? TRUE : FALSE,
NULL);
}