1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_CONTAINER_H__
32 #define __GTK_CONTAINER_H__
35 #include <gtk/gtkwidget.h>
36 #include <gtk/gtkadjustment.h>
41 #define GTK_TYPE_CONTAINER (gtk_container_get_type ())
42 #define GTK_CONTAINER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CONTAINER, GtkContainer))
43 #define GTK_CONTAINER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CONTAINER, GtkContainerClass))
44 #define GTK_IS_CONTAINER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CONTAINER))
45 #define GTK_IS_CONTAINER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CONTAINER))
46 #define GTK_CONTAINER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CONTAINER, GtkContainerClass))
49 typedef struct _GtkContainer GtkContainer;
50 typedef struct _GtkContainerPrivate GtkContainerPrivate;
51 typedef struct _GtkContainerClass GtkContainerClass;
58 GtkContainerPrivate *priv;
61 struct _GtkContainerClass
63 GtkWidgetClass parent_class;
65 unsigned int handle_border_width : 1;
67 void (*add) (GtkContainer *container,
69 void (*remove) (GtkContainer *container,
71 void (*check_resize) (GtkContainer *container);
72 void (*forall) (GtkContainer *container,
73 gboolean include_internals,
75 gpointer callback_data);
76 void (*set_focus_child) (GtkContainer *container,
78 GType (*child_type) (GtkContainer *container);
79 gchar* (*composite_name) (GtkContainer *container,
81 void (*set_child_property) (GtkContainer *container,
86 void (*get_child_property) (GtkContainer *container,
92 /* Padding for future expansion */
93 void (*_gtk_reserved1) (void);
94 void (*_gtk_reserved2) (void);
95 void (*_gtk_reserved3) (void);
96 void (*_gtk_reserved4) (void);
100 /* Application-level methods */
102 GType gtk_container_get_type (void) G_GNUC_CONST;
103 void gtk_container_set_border_width (GtkContainer *container,
105 guint gtk_container_get_border_width (GtkContainer *container);
106 void gtk_container_add (GtkContainer *container,
108 void gtk_container_remove (GtkContainer *container,
111 void gtk_container_set_resize_mode (GtkContainer *container,
112 GtkResizeMode resize_mode);
113 GtkResizeMode gtk_container_get_resize_mode (GtkContainer *container);
115 void gtk_container_check_resize (GtkContainer *container);
117 void gtk_container_foreach (GtkContainer *container,
118 GtkCallback callback,
119 gpointer callback_data);
120 GList* gtk_container_get_children (GtkContainer *container);
122 void gtk_container_propagate_expose (GtkContainer *container,
124 GdkEventExpose *event);
126 void gtk_container_set_focus_chain (GtkContainer *container,
127 GList *focusable_widgets);
128 gboolean gtk_container_get_focus_chain (GtkContainer *container,
129 GList **focusable_widgets);
130 void gtk_container_unset_focus_chain (GtkContainer *container);
132 #define GTK_IS_RESIZE_CONTAINER(widget) (GTK_IS_CONTAINER (widget) && \
133 (gtk_container_get_resize_mode (GTK_CONTAINER (widget)) != GTK_RESIZE_PARENT))
135 /* Widget-level methods */
137 void gtk_container_set_reallocate_redraws (GtkContainer *container,
138 gboolean needs_redraws);
139 void gtk_container_set_focus_child (GtkContainer *container,
142 gtk_container_get_focus_child (GtkContainer *container);
143 void gtk_container_set_focus_vadjustment (GtkContainer *container,
144 GtkAdjustment *adjustment);
145 GtkAdjustment *gtk_container_get_focus_vadjustment (GtkContainer *container);
146 void gtk_container_set_focus_hadjustment (GtkContainer *container,
147 GtkAdjustment *adjustment);
148 GtkAdjustment *gtk_container_get_focus_hadjustment (GtkContainer *container);
150 void gtk_container_resize_children (GtkContainer *container);
152 GType gtk_container_child_type (GtkContainer *container);
155 void gtk_container_class_install_child_property (GtkContainerClass *cclass,
158 GParamSpec* gtk_container_class_find_child_property (GObjectClass *cclass,
159 const gchar *property_name);
160 GParamSpec** gtk_container_class_list_child_properties (GObjectClass *cclass,
161 guint *n_properties);
162 void gtk_container_add_with_properties (GtkContainer *container,
164 const gchar *first_prop_name,
165 ...) G_GNUC_NULL_TERMINATED;
166 void gtk_container_child_set (GtkContainer *container,
168 const gchar *first_prop_name,
169 ...) G_GNUC_NULL_TERMINATED;
170 void gtk_container_child_get (GtkContainer *container,
172 const gchar *first_prop_name,
173 ...) G_GNUC_NULL_TERMINATED;
174 void gtk_container_child_set_valist (GtkContainer *container,
176 const gchar *first_property_name,
178 void gtk_container_child_get_valist (GtkContainer *container,
180 const gchar *first_property_name,
182 void gtk_container_child_set_property (GtkContainer *container,
184 const gchar *property_name,
185 const GValue *value);
186 void gtk_container_child_get_property (GtkContainer *container,
188 const gchar *property_name,
191 #define GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID(object, property_id, pspec) \
192 G_OBJECT_WARN_INVALID_PSPEC ((object), "child property id", (property_id), (pspec))
195 void gtk_container_forall (GtkContainer *container,
196 GtkCallback callback,
197 gpointer callback_data);
199 void gtk_container_class_handle_border_width (GtkContainerClass *klass);
201 /* Non-public methods */
202 void _gtk_container_queue_resize (GtkContainer *container);
203 void _gtk_container_clear_resize_widgets (GtkContainer *container);
204 gchar* _gtk_container_child_composite_name (GtkContainer *container,
206 void _gtk_container_dequeue_resize_handler (GtkContainer *container);
207 GList *_gtk_container_focus_sort (GtkContainer *container,
209 GtkDirectionType direction,
210 GtkWidget *old_focus);
211 gboolean _gtk_container_get_need_resize (GtkContainer *container);
212 void _gtk_container_set_need_resize (GtkContainer *container,
213 gboolean need_resize);
214 gboolean _gtk_container_get_reallocate_redraws (GtkContainer *container);
218 #endif /* __GTK_CONTAINER_H__ */