gtkcontainer.h 6.94 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
 */
#ifndef __GTK_CONTAINER_H__
#define __GTK_CONTAINER_H__


#include <gdk/gdk.h>
#include <gtk/gtkenums.h>
#include <gtk/gtkwidget.h>
26
#include <gtk/gtkadjustment.h>
Elliot Lee's avatar
Elliot Lee committed
27 28 29 30


#ifdef __cplusplus
extern "C" {
31
#pragma }
Elliot Lee's avatar
Elliot Lee committed
32 33 34
#endif /* __cplusplus */


35 36 37 38 39
#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))
Elliot Lee's avatar
Elliot Lee committed
40 41


42
typedef struct _GtkContainer	   GtkContainer;
Elliot Lee's avatar
Elliot Lee committed
43 44 45 46 47
typedef struct _GtkContainerClass  GtkContainerClass;

struct _GtkContainer
{
  GtkWidget widget;
48
  
Elliot Lee's avatar
Elliot Lee committed
49
  GtkWidget *focus_child;
50
  
51
  guint border_width : 16;
Elliot Lee's avatar
Elliot Lee committed
52
  guint need_resize : 1;
53
  guint resize_mode : 2;
54 55
  
  
56 57 58
  /* The list of children that requested a resize
   */
  GSList *resize_widgets;
Elliot Lee's avatar
Elliot Lee committed
59 60 61 62 63
};

struct _GtkContainerClass
{
  GtkWidgetClass parent_class;
64
  
65 66
  guint   n_child_args;

67 68 69 70
  void (* add)	       		(GtkContainer	 *container,
				 GtkWidget	 *widget);
  void (* remove)      		(GtkContainer	 *container,
				 GtkWidget	 *widget);
71
  void (* check_resize)		(GtkContainer	 *container);
72 73 74 75 76 77 78
  void (* foreach)     		(GtkContainer	 *container,
				 GtkCallback	  callback,
				 gpointer	  callbabck_data);
  gint (* focus)       		(GtkContainer	 *container,
				 GtkDirectionType  direction);
  void (* set_focus_child)	(GtkContainer	 *container,
				 GtkWidget	 *widget);
79 80 81 82 83 84 85 86 87
  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);
Elliot Lee's avatar
Elliot Lee committed
88 89
};

90
/* Application-level methods */
Elliot Lee's avatar
Elliot Lee committed
91

92 93
GtkType gtk_container_get_type		 (void);
void    gtk_container_border_width	 (GtkContainer	   *container,
94
					  guint		    border_width);
95 96 97 98
void    gtk_container_add		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
void    gtk_container_remove		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
99 100 101 102 103 104

void    gtk_container_set_resize_mode    (GtkContainer     *container,
					  GtkResizeMode     resize_mode);

void    gtk_container_check_resize       (GtkContainer     *container);

105 106 107 108
void    gtk_container_foreach		 (GtkContainer	   *container,
					  GtkCallback	    callback,
					  gpointer	    callback_data);
void    gtk_container_foreach_interp	 (GtkContainer	   *container,
109
					  GtkCallbackMarshal marshal,
110
					  gpointer	    callback_data,
111
					  GtkDestroyNotify  notify);
112 113
void    gtk_container_foreach_full	 (GtkContainer	   *container,
					  GtkCallback	    callback,
114
					  GtkCallbackMarshal marshal,
115
					  gpointer	    callback_data,
116
					  GtkDestroyNotify  notify);
117 118 119
GList* gtk_container_children		 (GtkContainer	   *container);
gint   gtk_container_focus		   (GtkContainer     *container,
					    GtkDirectionType  direction);
120 121 122

/* Widget-level methods */

123 124
void   gtk_container_set_focus_child	   (GtkContainer     *container,
					    GtkWidget	     *child);
125 126 127 128
void   gtk_container_set_focus_vadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
void   gtk_container_set_focus_hadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
129 130 131
void    gtk_container_register_toplevel	   (GtkContainer     *container);
void    gtk_container_unregister_toplevel  (GtkContainer     *container);
void    gtk_container_resize_children      (GtkContainer     *container);
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

GtkType gtk_container_child_type	   (GtkContainer     *container);

void    gtk_container_add_child_arg_type   (const gchar      *arg_name,
					    GtkType           arg_type,
					    guint             arg_flags,
					    guint             arg_id);

/* Allocate a GtkArg array of size nargs that hold the
 * names and types of the args that can be used with
 * gtk_container_child_arg_get/gtk_container_child_arg_set.
 * 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);

/* gtk_container_child_arg_getv() sets an arguments type and value, or just
 * its type to GTK_TYPE_INVALID.
 * if arg->type == GTK_TYPE_STRING, it's the callers response to
 * do a g_free (GTK_VALUE_STRING (arg));
 */
void    gtk_container_child_arg_getv	   (GtkContainer      *container,
					    GtkWidget	      *child,
					    guint	       n_args,
					    GtkArg	      *args);
void    gtk_container_child_arg_setv   	   (GtkContainer      *container,
					    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,
					    ...);
void    gtk_container_add_with_argv	   (GtkContainer      *container,
					    GtkWidget	      *widget,
					    guint	       n_args,
					    GtkArg	      *args);
179 180


181 182 183 184
/* Non-public methods */
void    gtk_container_clear_resize_widgets (GtkContainer *container);

/* Deprecated methods */
185

186 187 188 189 190 191 192
/* completely non-functional */
void    gtk_container_disable_resize	 (GtkContainer	   *container);
void    gtk_container_enable_resize	 (GtkContainer	   *container);

/* Use gtk_container_set_resize_mode() instead */
void    gtk_container_block_resize	 (GtkContainer	   *container);
void    gtk_container_unblock_resize	 (GtkContainer	   *container);
193

194 195
/* Use gtk_container_check_resize() instead */
gint    gtk_container_need_resize        (GtkContainer     *container);
196

Elliot Lee's avatar
Elliot Lee committed
197 198 199 200 201 202
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_CONTAINER_H__ */