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