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 void (*add) (GtkContainer *container,
67 void (*remove) (GtkContainer *container,
69 void (*check_resize) (GtkContainer *container);
70 void (*forall) (GtkContainer *container,
71 gboolean include_internals,
73 gpointer callback_data);
74 void (*set_focus_child) (GtkContainer *container,
76 GType (*child_type) (GtkContainer *container);
77 gchar* (*composite_name) (GtkContainer *container,
79 void (*set_child_property) (GtkContainer *container,
84 void (*get_child_property) (GtkContainer *container,
89 GtkWidgetPath * (*get_path_for_child) (GtkContainer *container,
95 unsigned int _handle_border_width : 1;
97 /* Padding for future expansion */
98 void (*_gtk_reserved1) (void);
99 void (*_gtk_reserved2) (void);
100 void (*_gtk_reserved3) (void);
101 void (*_gtk_reserved4) (void);
102 void (*_gtk_reserved5) (void);
103 void (*_gtk_reserved6) (void);
104 void (*_gtk_reserved7) (void);
105 void (*_gtk_reserved8) (void);
109 /* Application-level methods */
111 GType gtk_container_get_type (void) G_GNUC_CONST;
112 void gtk_container_set_border_width (GtkContainer *container,
114 guint gtk_container_get_border_width (GtkContainer *container);
115 void gtk_container_add (GtkContainer *container,
117 void gtk_container_remove (GtkContainer *container,
120 void gtk_container_set_resize_mode (GtkContainer *container,
121 GtkResizeMode resize_mode);
122 GtkResizeMode gtk_container_get_resize_mode (GtkContainer *container);
124 void gtk_container_check_resize (GtkContainer *container);
126 void gtk_container_foreach (GtkContainer *container,
127 GtkCallback callback,
128 gpointer callback_data);
129 GList* gtk_container_get_children (GtkContainer *container);
131 void gtk_container_propagate_draw (GtkContainer *container,
135 void gtk_container_set_focus_chain (GtkContainer *container,
136 GList *focusable_widgets);
137 gboolean gtk_container_get_focus_chain (GtkContainer *container,
138 GList **focusable_widgets);
139 void gtk_container_unset_focus_chain (GtkContainer *container);
141 #define GTK_IS_RESIZE_CONTAINER(widget) (GTK_IS_CONTAINER (widget) && \
142 (gtk_container_get_resize_mode (GTK_CONTAINER (widget)) != GTK_RESIZE_PARENT))
144 /* Widget-level methods */
146 void gtk_container_set_reallocate_redraws (GtkContainer *container,
147 gboolean needs_redraws);
148 void gtk_container_set_focus_child (GtkContainer *container,
151 gtk_container_get_focus_child (GtkContainer *container);
152 void gtk_container_set_focus_vadjustment (GtkContainer *container,
153 GtkAdjustment *adjustment);
154 GtkAdjustment *gtk_container_get_focus_vadjustment (GtkContainer *container);
155 void gtk_container_set_focus_hadjustment (GtkContainer *container,
156 GtkAdjustment *adjustment);
157 GtkAdjustment *gtk_container_get_focus_hadjustment (GtkContainer *container);
159 void gtk_container_resize_children (GtkContainer *container);
161 GType gtk_container_child_type (GtkContainer *container);
164 void gtk_container_class_install_child_property (GtkContainerClass *cclass,
167 GParamSpec* gtk_container_class_find_child_property (GObjectClass *cclass,
168 const gchar *property_name);
169 GParamSpec** gtk_container_class_list_child_properties (GObjectClass *cclass,
170 guint *n_properties);
171 void gtk_container_add_with_properties (GtkContainer *container,
173 const gchar *first_prop_name,
174 ...) G_GNUC_NULL_TERMINATED;
175 void gtk_container_child_set (GtkContainer *container,
177 const gchar *first_prop_name,
178 ...) G_GNUC_NULL_TERMINATED;
179 void gtk_container_child_get (GtkContainer *container,
181 const gchar *first_prop_name,
182 ...) G_GNUC_NULL_TERMINATED;
183 void gtk_container_child_set_valist (GtkContainer *container,
185 const gchar *first_property_name,
187 void gtk_container_child_get_valist (GtkContainer *container,
189 const gchar *first_property_name,
191 void gtk_container_child_set_property (GtkContainer *container,
193 const gchar *property_name,
194 const GValue *value);
195 void gtk_container_child_get_property (GtkContainer *container,
197 const gchar *property_name,
200 void gtk_container_child_notify (GtkContainer *container,
202 const gchar *child_property);
205 * GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID:
206 * @object: the #GObject on which set_child_property() or get_child_property()
208 * @property_id: the numeric id of the property
209 * @pspec: the #GParamSpec of the property
211 * This macro should be used to emit a standard warning about unexpected
212 * properties in set_child_property() and get_child_property() implementations.
214 #define GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID(object, property_id, pspec) \
215 G_OBJECT_WARN_INVALID_PSPEC ((object), "child property id", (property_id), (pspec))
218 void gtk_container_forall (GtkContainer *container,
219 GtkCallback callback,
220 gpointer callback_data);
222 void gtk_container_class_handle_border_width (GtkContainerClass *klass);
224 GtkWidgetPath * gtk_container_get_path_for_child (GtkContainer *container,
229 #endif /* __GTK_CONTAINER_H__ */