gtkcontainer.h 8 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4 5 6 7 8 9 10
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
Elliot Lee's avatar
Elliot Lee committed
12 13 14
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20 21 22 23 24 25 26

/*
 * Modified by the GTK+ Team and others 1997-1999.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31 32 33
#ifndef __GTK_CONTAINER_H__
#define __GTK_CONTAINER_H__


#include <gdk/gdk.h>
#include <gtk/gtkenums.h>
#include <gtk/gtkwidget.h>
34
#include <gtk/gtkadjustment.h>
Elliot Lee's avatar
Elliot Lee committed
35 36 37 38 39 40 41


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


42 43 44 45 46 47 48
#define GTK_TYPE_CONTAINER	        (gtk_container_get_type ())
#define GTK_CONTAINER(obj)	        (GTK_CHECK_CAST ((obj), GTK_TYPE_CONTAINER, GtkContainer))
#define GTK_CONTAINER_CLASS(klass)      (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_CONTAINER, GtkContainerClass))
#define GTK_IS_CONTAINER(obj)	        (GTK_CHECK_TYPE ((obj), GTK_TYPE_CONTAINER))
#define GTK_IS_CONTAINER_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CONTAINER))

#define GTK_IS_RESIZE_CONTAINER(widget) (GTK_IS_CONTAINER (widget) && ((GtkContainer*) (widget))->resize_mode != GTK_RESIZE_PARENT)
Elliot Lee's avatar
Elliot Lee committed
49 50


51
typedef struct _GtkContainer	   GtkContainer;
Elliot Lee's avatar
Elliot Lee committed
52 53 54 55 56
typedef struct _GtkContainerClass  GtkContainerClass;

struct _GtkContainer
{
  GtkWidget widget;
57
  
Elliot Lee's avatar
Elliot Lee committed
58
  GtkWidget *focus_child;
59
  
60
  guint border_width : 16;
Elliot Lee's avatar
Elliot Lee committed
61
  guint need_resize : 1;
62
  guint resize_mode : 2;
63 64
  
  
65 66 67
  /* The list of children that requested a resize
   */
  GSList *resize_widgets;
Elliot Lee's avatar
Elliot Lee committed
68 69 70 71 72
};

struct _GtkContainerClass
{
  GtkWidgetClass parent_class;
73
  
74 75
  guint   n_child_args;

76 77 78 79
  void (* add)	       		(GtkContainer	 *container,
				 GtkWidget	 *widget);
  void (* remove)      		(GtkContainer	 *container,
				 GtkWidget	 *widget);
80
  void (* check_resize)		(GtkContainer	 *container);
81 82
  void (* forall)     		(GtkContainer	 *container,
				 gboolean	  include_internals,
83 84 85 86 87 88
				 GtkCallback	  callback,
				 gpointer	  callbabck_data);
  gint (* focus)       		(GtkContainer	 *container,
				 GtkDirectionType  direction);
  void (* set_focus_child)	(GtkContainer	 *container,
				 GtkWidget	 *widget);
89 90 91 92 93 94 95 96 97
  GtkType (*child_type)		(GtkContainer	*container);
  void    (*set_child_arg)	(GtkContainer 	*container,
				 GtkWidget    	*child,
				 GtkArg       	*arg,
				 guint        	 arg_id);
  void    (*get_child_arg)	(GtkContainer	*container,
				 GtkWidget    	*child,
				 GtkArg       	*arg,
				 guint        	 arg_id);
98 99
  gchar*  (*composite_name)	(GtkContainer	*container,
				 GtkWidget	*child);
Elliot Lee's avatar
Elliot Lee committed
100 101
};

102
/* Application-level methods */
Elliot Lee's avatar
Elliot Lee committed
103

104
GtkType gtk_container_get_type		 (void);
105
void    gtk_container_set_border_width	 (GtkContainer	   *container,
106
					  guint		    border_width);
107 108 109 110
void    gtk_container_add		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
void    gtk_container_remove		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
111 112 113 114 115 116

void    gtk_container_set_resize_mode    (GtkContainer     *container,
					  GtkResizeMode     resize_mode);

void    gtk_container_check_resize       (GtkContainer     *container);

117 118 119 120 121
void    gtk_container_foreach		 (GtkContainer	   *container,
					  GtkCallback	    callback,
					  gpointer	    callback_data);
void    gtk_container_foreach_full	 (GtkContainer	   *container,
					  GtkCallback	    callback,
122
					  GtkCallbackMarshal marshal,
123
					  gpointer	    callback_data,
124
					  GtkDestroyNotify  notify);
125 126 127
GList* gtk_container_children		 (GtkContainer	   *container);
gint   gtk_container_focus		   (GtkContainer     *container,
					    GtkDirectionType  direction);
128 129 130

/* Widget-level methods */

131 132
void   gtk_container_set_focus_child	   (GtkContainer     *container,
					    GtkWidget	     *child);
133 134 135 136
void   gtk_container_set_focus_vadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
void   gtk_container_set_focus_hadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
137 138
void    gtk_container_register_toplevel	   (GtkContainer     *container);
void    gtk_container_unregister_toplevel  (GtkContainer     *container);
139 140
GList * gtk_container_get_toplevels        (void);

141
void    gtk_container_resize_children      (GtkContainer     *container);
142 143 144

GtkType gtk_container_child_type	   (GtkContainer     *container);

145
/* the `arg_name' argument needs to be a const static string */
146 147 148 149
void    gtk_container_add_child_arg_type   (const gchar      *arg_name,
					    GtkType           arg_type,
					    guint             arg_flags,
					    guint             arg_id);
150
     
151 152
/* Allocate a GtkArg array of size nargs that hold the
 * names and types of the args that can be used with
153
 * gtk_container_child_getv/gtk_container_child_setv.
154 155 156 157 158 159 160 161 162 163
 * if (arg_flags!=NULL),
 * (*arg_flags) will be set to point to a newly allocated
 * guint array that holds the flags of the args.
 * It is the callers response to do a
 * g_free (returned_args); g_free (*arg_flags).
 */
GtkArg* gtk_container_query_child_args	   (GtkType	       class_type,
					    guint32          **arg_flags,
					    guint             *nargs);

164
/* gtk_container_child_getv() sets an arguments type and value, or just
165
 * its type to GTK_TYPE_INVALID.
166 167
 * if GTK_FUNDAMENTAL_TYPE (arg->type) == GTK_TYPE_STRING, it's the callers
 * response to do a g_free (GTK_VALUE_STRING (arg));
168
 */
169
void    gtk_container_child_getv	   (GtkContainer      *container,
170 171 172
					    GtkWidget	      *child,
					    guint	       n_args,
					    GtkArg	      *args);
173
void    gtk_container_child_setv   	   (GtkContainer      *container,
174 175 176 177 178 179 180 181 182 183 184
					    GtkWidget	      *child,
					    guint	       n_args,
					    GtkArg	      *args);

/* gtk_container_add_with_args() takes a variable argument list of the form:
 * (..., gchar *arg_name, ARG_VALUES, [repeatedly name/value pairs,] NULL)
 * where ARG_VALUES type depend on the argument and can consist of
 * more than one c-function argument.
 */
void    gtk_container_add_with_args	   (GtkContainer      *container,
					    GtkWidget	      *widget,
185
					    const gchar	      *first_arg_name,
186
					    ...);
187
void    gtk_container_addv		   (GtkContainer      *container,
188 189 190
					    GtkWidget	      *widget,
					    guint	       n_args,
					    GtkArg	      *args);
191
void	gtk_container_child_set		   (GtkContainer      *container,
192
					    GtkWidget         *child,
193
					    const gchar	      *first_arg_name,
194 195
					    ...);
     
196

197
/* Non-public methods */
198

199
void	gtk_container_queue_resize	   (GtkContainer *container);
200
void    gtk_container_clear_resize_widgets (GtkContainer *container);
201 202 203 204 205 206 207 208 209 210 211
void    gtk_container_arg_set		   (GtkContainer *container,
					    GtkWidget	 *child,
					    GtkArg       *arg,
					    GtkArgInfo   *info);
void    gtk_container_arg_get		   (GtkContainer *container,
					    GtkWidget	 *child,
					    GtkArg       *arg,
					    GtkArgInfo   *info);
gchar*	gtk_container_child_args_collect   (GtkType       object_type,
					    GSList      **arg_list_p,
					    GSList      **info_list_p,
212 213
					    const gchar	 *first_arg_name,
					    va_list       args);
214 215 216
gchar*  gtk_container_child_arg_get_info   (GtkType       object_type,
					    const gchar  *arg_name,
					    GtkArgInfo  **info_p);
217 218 219
void    gtk_container_forall		   (GtkContainer *container,
					    GtkCallback	  callback,
					    gpointer	  callback_data);
220 221
gchar*	gtk_container_child_composite_name (GtkContainer *container,
					    GtkWidget	 *child);
222 223


Elliot Lee's avatar
Elliot Lee committed
224 225 226 227 228 229
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_CONTAINER_H__ */