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 #ifndef __GTK_CONTAINER_H__
28 #define __GTK_CONTAINER_H__
32 #include <gtk/gtkenums.h>
33 #include <gtk/gtkwidget.h>
34 #include <gtk/gtkadjustment.h>
39 #endif /* __cplusplus */
42 #define GTK_TYPE_CONTAINER (gtk_container_get_type ())
43 #define GTK_CONTAINER(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_CONTAINER, GtkContainer))
44 #define GTK_CONTAINER_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_CONTAINER, GtkContainerClass))
45 #define GTK_IS_CONTAINER(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_CONTAINER))
46 #define GTK_IS_CONTAINER_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CONTAINER))
47 #define GTK_CONTAINER_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_CONTAINER, GtkContainerClass))
49 #define GTK_IS_RESIZE_CONTAINER(widget) (GTK_IS_CONTAINER (widget) && ((GtkContainer*) (widget))->resize_mode != GTK_RESIZE_PARENT)
52 typedef struct _GtkContainer GtkContainer;
53 typedef struct _GtkContainerClass GtkContainerClass;
59 GtkWidget *focus_child;
61 guint border_width : 16;
62 guint need_resize : 1;
63 guint resize_mode : 2;
64 guint reallocate_redraws : 1;
66 /* The list of children that requested a resize
68 GSList *resize_widgets;
71 struct _GtkContainerClass
73 GtkWidgetClass parent_class;
77 void (* add) (GtkContainer *container,
79 void (* remove) (GtkContainer *container,
81 void (* check_resize) (GtkContainer *container);
82 void (* forall) (GtkContainer *container,
83 gboolean include_internals,
85 gpointer callbabck_data);
86 gboolean (* focus) (GtkContainer *container,
87 GtkDirectionType direction);
88 void (* set_focus_child) (GtkContainer *container,
90 GtkType (*child_type) (GtkContainer *container);
91 void (*set_child_arg) (GtkContainer *container,
95 void (*get_child_arg) (GtkContainer *container,
99 gchar* (*composite_name) (GtkContainer *container,
102 /* Padding for future expansion */
107 /* Application-level methods */
109 GtkType gtk_container_get_type (void) G_GNUC_CONST;
110 void gtk_container_set_border_width (GtkContainer *container,
112 void gtk_container_add (GtkContainer *container,
114 void gtk_container_remove (GtkContainer *container,
117 void gtk_container_set_resize_mode (GtkContainer *container,
118 GtkResizeMode resize_mode);
120 void gtk_container_check_resize (GtkContainer *container);
122 void gtk_container_foreach (GtkContainer *container,
123 GtkCallback callback,
124 gpointer callback_data);
125 void gtk_container_foreach_full (GtkContainer *container,
126 GtkCallback callback,
127 GtkCallbackMarshal marshal,
128 gpointer callback_data,
129 GtkDestroyNotify notify);
130 GList* gtk_container_children (GtkContainer *container);
131 gboolean gtk_container_focus (GtkContainer *container,
132 GtkDirectionType direction);
134 /* Widget-level methods */
136 void gtk_container_set_reallocate_redraws (GtkContainer *container,
137 gboolean needs_redraws);
138 void gtk_container_set_focus_child (GtkContainer *container,
140 void gtk_container_set_focus_vadjustment (GtkContainer *container,
141 GtkAdjustment *adjustment);
142 void gtk_container_set_focus_hadjustment (GtkContainer *container,
143 GtkAdjustment *adjustment);
145 void gtk_container_resize_children (GtkContainer *container);
147 GtkType gtk_container_child_type (GtkContainer *container);
149 /* the `arg_name' argument needs to be a const static string */
150 void gtk_container_add_child_arg_type (const gchar *arg_name,
155 /* Allocate a GtkArg array of size nargs that hold the
156 * names and types of the args that can be used with
157 * gtk_container_child_getv/gtk_container_child_setv.
158 * if (arg_flags!=NULL),
159 * (*arg_flags) will be set to point to a newly allocated
160 * guint array that holds the flags of the args.
161 * It is the callers response to do a
162 * g_free (returned_args); g_free (*arg_flags).
164 GtkArg* gtk_container_query_child_args (GtkType class_type,
168 /* gtk_container_child_getv() sets an arguments type and value, or just
169 * its type to GTK_TYPE_INVALID.
170 * if GTK_FUNDAMENTAL_TYPE (arg->type) == GTK_TYPE_STRING, it's the callers
171 * response to do a g_free (GTK_VALUE_STRING (arg));
173 void gtk_container_child_getv (GtkContainer *container,
177 void gtk_container_child_setv (GtkContainer *container,
182 /* gtk_container_add_with_args() takes a variable argument list of the form:
183 * (..., gchar *arg_name, ARG_VALUES, [repeatedly name/value pairs,] NULL)
184 * where ARG_VALUES type depend on the argument and can consist of
185 * more than one c-function argument.
187 void gtk_container_add_with_args (GtkContainer *container,
189 const gchar *first_arg_name,
191 void gtk_container_addv (GtkContainer *container,
195 void gtk_container_child_set (GtkContainer *container,
197 const gchar *first_arg_name,
201 /* Non-public methods */
203 void gtk_container_queue_resize (GtkContainer *container);
204 void gtk_container_clear_resize_widgets (GtkContainer *container);
205 void gtk_container_arg_set (GtkContainer *container,
209 void gtk_container_arg_get (GtkContainer *container,
213 gchar* gtk_container_child_args_collect (GtkType object_type,
215 GSList **info_list_p,
216 const gchar *first_arg_name,
218 gchar* gtk_container_child_arg_get_info (GtkType object_type,
219 const gchar *arg_name,
220 GtkArgInfo **info_p);
221 void gtk_container_forall (GtkContainer *container,
222 GtkCallback callback,
223 gpointer callback_data);
224 gchar* gtk_container_child_composite_name (GtkContainer *container,
226 void gtk_container_dequeue_resize_handler (GtkContainer *container);
230 #endif /* __cplusplus */
233 #endif /* __GTK_CONTAINER_H__ */