Pileus Git - ~andy/gtk/blob - gtk/gtkbox.h

   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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_BOX_H__
  32 #define __GTK_BOX_H__
  33
  34
  35 #include <gtk/gtkcontainer.h>
  36
  37
  38 G_BEGIN_DECLS
  39
  40
  41 #define GTK_TYPE_BOX            (gtk_box_get_type ())
  42 #define GTK_BOX(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_BOX, GtkBox))
  43 #define GTK_BOX_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_BOX, GtkBoxClass))
  44 #define GTK_IS_BOX(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_BOX))
  45 #define GTK_IS_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_BOX))
  46 #define GTK_BOX_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_BOX, GtkBoxClass))
  47
  48
  49 typedef struct _GtkBox        GtkBox;
  50 typedef struct _GtkBoxClass   GtkBoxClass;
  51 typedef struct _GtkBoxChild   GtkBoxChild;
  52
  53 struct _GtkBox
  54 {
  55   GtkContainer container;
  56
  57   /*< public >*/
  58   GList *GSEAL (children);
  59   gint16 GSEAL (spacing);
  60   guint GSEAL (homogeneous) : 1;
  61 };
  62
  63 struct _GtkBoxClass
  64 {
  65   GtkContainerClass parent_class;
  66 };
  67
  68 /**
  69  * GtkBoxChild:
  70  * @widget: the child widget, packed into the GtkBox.
  71  * @padding: the number of extra pixels to put between this child and its
  72  *  neighbors, set when packed, zero by default.
  73  * @expand: flag indicates whether extra space should be given to this child.
  74  *  Any extra space given to the parent GtkBox is divided up among all children
  75  *  with this attribute set to %TRUE; set when packed, %TRUE by default.
  76  * @fill: flag indicates whether any extra space given to this child due to its
  77  *  @expand attribute being set is actually allocated to the child, rather than
  78  *  being used as padding around the widget; set when packed, %TRUE by default.
  79  * @pack: one of #GtkPackType indicating whether the child is packed with
  80  *  reference to the start (top/left) or end (bottom/right) of the GtkBox.
  81  * @is_secondary: %TRUE if the child is secondary
  82  *
  83  * The #GtkBoxChild holds a child widget of #GtkBox and describes how the child
  84  * is to be packed into the #GtkBox. All fields of this #GtkBoxChild should be
  85  * considered read-only and they should never be set directly by an application.
  86  * Use gtk_box_query_child_packing() and gtk_box_set_child_packing() to query
  87  * and set the #GtkBoxChild.padding, #GtkBoxChild.expand, #GtkBoxChild.fill and
  88  * #GtkBoxChild.pack fields.
  89  */
  90 struct _GtkBoxChild
  91 {
  92   GtkWidget *widget;
  93   guint16 padding;
  94   guint expand : 1;
  95   guint fill : 1;
  96   guint pack : 1;
  97   guint is_secondary : 1;
  98 };
  99
 100
 101 GType       gtk_box_get_type            (void) G_GNUC_CONST;
 102 GtkWidget* _gtk_box_new                 (GtkOrientation  orientation,
 103                                          gboolean        homogeneous,
 104                                          gint            spacing);
 105
 106 void        gtk_box_pack_start          (GtkBox         *box,
 107                                          GtkWidget      *child,
 108                                          gboolean        expand,
 109                                          gboolean        fill,
 110                                          guint           padding);
 111 void        gtk_box_pack_end            (GtkBox         *box,
 112                                          GtkWidget      *child,
 113                                          gboolean        expand,
 114                                          gboolean        fill,
 115                                          guint           padding);
 116
 117 void        gtk_box_set_homogeneous     (GtkBox         *box,
 118                                          gboolean        homogeneous);
 119 gboolean    gtk_box_get_homogeneous     (GtkBox         *box);
 120 void        gtk_box_set_spacing         (GtkBox         *box,
 121                                          gint            spacing);
 122 gint        gtk_box_get_spacing         (GtkBox         *box);
 123
 124 void        gtk_box_reorder_child       (GtkBox         *box,
 125                                          GtkWidget      *child,
 126                                          gint            position);
 127
 128 void        gtk_box_query_child_packing (GtkBox         *box,
 129                                          GtkWidget      *child,
 130                                          gboolean       *expand,
 131                                          gboolean       *fill,
 132                                          guint          *padding,
 133                                          GtkPackType    *pack_type);
 134 void        gtk_box_set_child_packing   (GtkBox         *box,
 135                                          GtkWidget      *child,
 136                                          gboolean        expand,
 137                                          gboolean        fill,
 138                                          guint           padding,
 139                                          GtkPackType     pack_type);
 140
 141 /* internal API */
 142 void        _gtk_box_set_old_defaults   (GtkBox         *box);
 143 gboolean    _gtk_box_get_spacing_set    (GtkBox         *box);
 144 void        _gtk_box_set_spacing_set    (GtkBox         *box,
 145                                          gboolean        spacing_set);
 146
 147 G_END_DECLS
 148
 149 #endif /* __GTK_BOX_H__ */