gtkcontainer.h 8.53 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
#define GTK_TYPE_CONTAINER              (gtk_container_get_type ())
Manish Singh's avatar
Manish Singh committed
43 44 45 46 47
#define GTK_CONTAINER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CONTAINER, GtkContainer))
#define GTK_CONTAINER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CONTAINER, GtkContainerClass))
#define GTK_IS_CONTAINER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CONTAINER))
#define GTK_IS_CONTAINER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CONTAINER))
#define GTK_CONTAINER_GET_CLASS(obj)    (G_TYPE_INSTANCE_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
  guint has_focus_chain : 1;
Elliot Lee's avatar
Elliot Lee committed
66 67 68 69 70
};

struct _GtkContainerClass
{
  GtkWidgetClass parent_class;
71

Tim Janik's avatar
Tim Janik committed
72
  void    (*add)       		(GtkContainer	 *container,
73
				 GtkWidget	 *widget);
Tim Janik's avatar
Tim Janik committed
74
  void    (*remove)    		(GtkContainer	 *container,
75
				 GtkWidget	 *widget);
Tim Janik's avatar
Tim Janik committed
76 77
  void    (*check_resize)	(GtkContainer	 *container);
  void    (*forall)    		(GtkContainer	 *container,
78
				 gboolean	  include_internals,
79
				 GtkCallback	  callback,
80
				 gpointer	  callback_data);
Tim Janik's avatar
Tim Janik committed
81
  void    (*set_focus_child)	(GtkContainer	 *container,
82
				 GtkWidget	 *widget);
Manish Singh's avatar
Manish Singh committed
83
  GType   (*child_type)		(GtkContainer	 *container);
Tim Janik's avatar
Tim Janik committed
84 85 86 87 88 89 90 91 92 93 94 95
  gchar*  (*composite_name)	(GtkContainer	 *container,
				 GtkWidget	 *child);
  void    (*set_child_property) (GtkContainer    *container,
				 GtkWidget       *child,
				 guint            property_id,
				 const GValue    *value,
				 GParamSpec      *pspec);
  void    (*get_child_property) (GtkContainer    *container,
                                 GtkWidget       *child,
				 guint            property_id,
				 GValue          *value,
				 GParamSpec      *pspec);
96

97
  /* Padding for future expansion */
98 99 100 101
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Elliot Lee's avatar
Elliot Lee committed
102 103
};

104
/* Application-level methods */
Elliot Lee's avatar
Elliot Lee committed
105

Manish Singh's avatar
Manish Singh committed
106
GType   gtk_container_get_type		 (void) G_GNUC_CONST;
107
void    gtk_container_set_border_width	 (GtkContainer	   *container,
108
					  guint		    border_width);
109
guint   gtk_container_get_border_width   (GtkContainer     *container);
110 111 112 113
void    gtk_container_add		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
void    gtk_container_remove		 (GtkContainer	   *container,
					  GtkWidget	   *widget);
114 115 116

void    gtk_container_set_resize_mode    (GtkContainer     *container,
					  GtkResizeMode     resize_mode);
117
GtkResizeMode gtk_container_get_resize_mode (GtkContainer     *container);
118 119 120

void    gtk_container_check_resize       (GtkContainer     *container);

121 122 123
void     gtk_container_foreach      (GtkContainer       *container,
				     GtkCallback         callback,
				     gpointer            callback_data);
124
#ifndef GTK_DISABLE_DEPRECATED
125 126 127 128 129
void     gtk_container_foreach_full (GtkContainer       *container,
				     GtkCallback         callback,
				     GtkCallbackMarshal  marshal,
				     gpointer            callback_data,
				     GtkDestroyNotify    notify);
130
#endif /*  GTK_DISABLE_DEPRECATED */
131 132 133 134 135 136
GList*   gtk_container_get_children     (GtkContainer       *container);

#ifndef GTK_DISABLE_DEPRECATED
#define gtk_container_children gtk_container_get_children
#endif

137 138 139
void     gtk_container_propagate_expose (GtkContainer   *container,
					 GtkWidget      *child,
					 GdkEventExpose *event);
140

141 142
void     gtk_container_set_focus_chain  (GtkContainer   *container,
                                         GList          *focusable_widgets);
143 144
gboolean gtk_container_get_focus_chain  (GtkContainer   *container,
					 GList         **focusable_widgets);
145 146
void     gtk_container_unset_focus_chain (GtkContainer  *container);

147 148
/* Widget-level methods */

149 150
void   gtk_container_set_reallocate_redraws (GtkContainer    *container,
					     gboolean         needs_redraws);
151 152
void   gtk_container_set_focus_child	   (GtkContainer     *container,
					    GtkWidget	     *child);
153 154
void   gtk_container_set_focus_vadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
155
GtkAdjustment *gtk_container_get_focus_vadjustment (GtkContainer *container);
156 157
void   gtk_container_set_focus_hadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
158
GtkAdjustment *gtk_container_get_focus_hadjustment (GtkContainer *container);
159

160
void    gtk_container_resize_children      (GtkContainer     *container);
161

Manish Singh's avatar
Manish Singh committed
162
GType   gtk_container_child_type	   (GtkContainer     *container);
163

164

Tim Janik's avatar
Tim Janik committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
void         gtk_container_class_install_child_property (GtkContainerClass *cclass,
							 guint		    property_id,
							 GParamSpec	   *pspec);
GParamSpec*  gtk_container_class_find_child_property	(GObjectClass	   *cclass,
							 const gchar	   *property_name);
GParamSpec** gtk_container_class_list_child_properties	(GObjectClass	   *cclass,
							 guint		   *n_properties);
void         gtk_container_add_with_properties		(GtkContainer	   *container,
							 GtkWidget	   *widget,
							 const gchar	   *first_prop_name,
							 ...);
void         gtk_container_child_set			(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_prop_name,
							 ...);	   
void         gtk_container_child_get			(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_prop_name,
							 ...);	   
void         gtk_container_child_set_valist		(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_property_name,
							 va_list	    var_args);
void         gtk_container_child_get_valist		(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_property_name,
							 va_list	    var_args);
192 193 194 195 196 197 198 199
void	     gtk_container_child_set_property		(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *property_name,
							 const GValue	   *value);
void	     gtk_container_child_get_property		(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *property_name,
							 GValue		   *value);
Tim Janik's avatar
Tim Janik committed
200 201 202

#define GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID(object, property_id, pspec) \
    G_OBJECT_WARN_INVALID_PSPEC ((object), "child property id", (property_id), (pspec))
203

Tim Janik's avatar
Tim Janik committed
204

205 206 207
void    gtk_container_forall		     (GtkContainer *container,
					      GtkCallback   callback,
					      gpointer	    callback_data);
208 209 210 211 212

/* Non-public methods */
void	_gtk_container_queue_resize	     (GtkContainer *container);
void    _gtk_container_clear_resize_widgets   (GtkContainer *container);
gchar*	_gtk_container_child_composite_name   (GtkContainer *container,
213
					      GtkWidget	   *child);
214
void   _gtk_container_dequeue_resize_handler (GtkContainer *container);
215 216 217 218
GList *_gtk_container_focus_sort             (GtkContainer     *container,
					      GList            *children,
					      GtkDirectionType  direction,
					      GtkWidget        *old_focus);
219

220 221 222 223
#ifndef GTK_DISABLE_DEPRECATED
#define	gtk_container_border_width		gtk_container_set_border_width
#endif /* GTK_DISABLE_DEPRECATED */

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


#endif /* __GTK_CONTAINER_H__ */