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