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