gtkcontainer.h 8.26 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* 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
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * 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
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser 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
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * 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 */


Tim Janik's avatar
Tim Janik committed
42 43
#define GTK_TYPE_CONTAINER              (gtk_container_get_type ())
#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))
Tim Janik's avatar
Tim Janik committed
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))
Tim Janik's avatar
Tim Janik committed
47
#define GTK_CONTAINER_GET_CLASS(obj)    (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_CONTAINER, GtkContainerClass))
48 49

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


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

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

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

77 78 79 80
  void (* add)	       		(GtkContainer	 *container,
				 GtkWidget	 *widget);
  void (* remove)      		(GtkContainer	 *container,
				 GtkWidget	 *widget);
81
  void (* check_resize)		(GtkContainer	 *container);
82 83
  void (* forall)     		(GtkContainer	 *container,
				 gboolean	  include_internals,
84 85 86 87 88 89
				 GtkCallback	  callback,
				 gpointer	  callbabck_data);
  gint (* focus)       		(GtkContainer	 *container,
				 GtkDirectionType  direction);
  void (* set_focus_child)	(GtkContainer	 *container,
				 GtkWidget	 *widget);
90 91 92 93 94 95 96 97 98
  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);
99 100
  gchar*  (*composite_name)	(GtkContainer	*container,
				 GtkWidget	*child);
101 102 103 104

  /* Padding for future expansion */
  GtkFunction pad1;
  GtkFunction pad2;
Elliot Lee's avatar
Elliot Lee committed
105 106
};

107
/* Application-level methods */
Elliot Lee's avatar
Elliot Lee committed
108

109
GtkType gtk_container_get_type		 (void);
110
void    gtk_container_set_border_width	 (GtkContainer	   *container,
111
					  guint		    border_width);
112 113 114 115
void    gtk_container_add		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
void    gtk_container_remove		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
116 117 118 119 120 121

void    gtk_container_set_resize_mode    (GtkContainer     *container,
					  GtkResizeMode     resize_mode);

void    gtk_container_check_resize       (GtkContainer     *container);

122 123 124 125 126
void    gtk_container_foreach		 (GtkContainer	   *container,
					  GtkCallback	    callback,
					  gpointer	    callback_data);
void    gtk_container_foreach_full	 (GtkContainer	   *container,
					  GtkCallback	    callback,
127
					  GtkCallbackMarshal marshal,
128
					  gpointer	    callback_data,
129
					  GtkDestroyNotify  notify);
130 131 132
GList* gtk_container_children		 (GtkContainer	   *container);
gint   gtk_container_focus		   (GtkContainer     *container,
					    GtkDirectionType  direction);
133 134 135

/* Widget-level methods */

136 137
void   gtk_container_set_reallocate_redraws (GtkContainer    *container,
					     gboolean         needs_redraws);
138 139
void   gtk_container_set_focus_child	   (GtkContainer     *container,
					    GtkWidget	     *child);
140 141 142 143
void   gtk_container_set_focus_vadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
void   gtk_container_set_focus_hadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
144

145
void    gtk_container_resize_children      (GtkContainer     *container);
146 147 148

GtkType gtk_container_child_type	   (GtkContainer     *container);

149
/* the `arg_name' argument needs to be a const static string */
150 151 152 153
void    gtk_container_add_child_arg_type   (const gchar      *arg_name,
					    GtkType           arg_type,
					    guint             arg_flags,
					    guint             arg_id);
154
     
155 156
/* Allocate a GtkArg array of size nargs that hold the
 * names and types of the args that can be used with
157
 * gtk_container_child_getv/gtk_container_child_setv.
158 159 160 161 162 163 164 165 166 167
 * 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);

168
/* gtk_container_child_getv() sets an arguments type and value, or just
169
 * its type to GTK_TYPE_INVALID.
170 171
 * if GTK_FUNDAMENTAL_TYPE (arg->type) == GTK_TYPE_STRING, it's the callers
 * response to do a g_free (GTK_VALUE_STRING (arg));
172
 */
173
void    gtk_container_child_getv	   (GtkContainer      *container,
174 175 176
					    GtkWidget	      *child,
					    guint	       n_args,
					    GtkArg	      *args);
177
void    gtk_container_child_setv   	   (GtkContainer      *container,
178 179 180 181 182 183 184 185 186 187 188
					    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,
189
					    const gchar	      *first_arg_name,
190
					    ...);
191
void    gtk_container_addv		   (GtkContainer      *container,
192 193 194
					    GtkWidget	      *widget,
					    guint	       n_args,
					    GtkArg	      *args);
195
void	gtk_container_child_set		   (GtkContainer      *container,
196
					    GtkWidget         *child,
197
					    const gchar	      *first_arg_name,
198 199
					    ...);
     
200

201
/* Non-public methods */
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
void	gtk_container_queue_resize	     (GtkContainer *container);
void    gtk_container_clear_resize_widgets   (GtkContainer *container);
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,
					      const gchar  *first_arg_name,
					      va_list       args);
gchar*  gtk_container_child_arg_get_info     (GtkType       object_type,
					      const gchar  *arg_name,
					      GtkArgInfo  **info_p);
void    gtk_container_forall		     (GtkContainer *container,
					      GtkCallback   callback,
					      gpointer	    callback_data);
gchar*	gtk_container_child_composite_name   (GtkContainer *container,
					      GtkWidget	   *child);
void    gtk_container_dequeue_resize_handler (GtkContainer *container);
227

Elliot Lee's avatar
Elliot Lee committed
228 229 230 231 232 233
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_CONTAINER_H__ */