gtkcontainer.h 8.77 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * 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
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27 28 29 30
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34 35
#ifndef __GTK_CONTAINER_H__
#define __GTK_CONTAINER_H__


#include <gtk/gtkwidget.h>
36
#include <gtk/gtkadjustment.h>
Elliot Lee's avatar
Elliot Lee committed
37 38


39
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
40

Tim Janik's avatar
Tim Janik committed
41
#define GTK_TYPE_CONTAINER              (gtk_container_get_type ())
Manish Singh's avatar
Manish Singh committed
42 43 44 45 46
#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))
47 48

#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

Tim Janik's avatar
Tim Janik committed
58
  GtkWidget *GSEAL (focus_child);
59

60
  guint GSEAL (border_width) : 16;
61 62

  /*< private >*/
63 64 65 66
  guint GSEAL (need_resize) : 1;
  guint GSEAL (resize_mode) : 2;
  guint GSEAL (reallocate_redraws) : 1;
  guint GSEAL (has_focus_chain) : 1;
Elliot Lee's avatar
Elliot Lee committed
67 68 69 70 71
};

struct _GtkContainerClass
{
  GtkWidgetClass parent_class;
72

Tim Janik's avatar
Tim Janik committed
73
  void    (*add)       		(GtkContainer	 *container,
74
				 GtkWidget	 *widget);
Tim Janik's avatar
Tim Janik committed
75
  void    (*remove)    		(GtkContainer	 *container,
76
				 GtkWidget	 *widget);
Tim Janik's avatar
Tim Janik committed
77 78
  void    (*check_resize)	(GtkContainer	 *container);
  void    (*forall)    		(GtkContainer	 *container,
79
				 gboolean	  include_internals,
80
				 GtkCallback	  callback,
81
				 gpointer	  callback_data);
Tim Janik's avatar
Tim Janik committed
82
  void    (*set_focus_child)	(GtkContainer	 *container,
83
				 GtkWidget	 *widget);
Manish Singh's avatar
Manish Singh committed
84
  GType   (*child_type)		(GtkContainer	 *container);
Tim Janik's avatar
Tim Janik committed
85 86 87 88 89 90 91 92 93 94 95 96
  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);
97

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

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

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

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

void    gtk_container_check_resize       (GtkContainer     *container);

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

#ifndef GTK_DISABLE_DEPRECATED
#define gtk_container_children gtk_container_get_children
#endif

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

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

148 149
/* Widget-level methods */

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

163
void    gtk_container_resize_children      (GtkContainer     *container);
164

Manish Singh's avatar
Manish Singh committed
165
GType   gtk_container_child_type	   (GtkContainer     *container);
166

167

Tim Janik's avatar
Tim Janik committed
168 169 170 171 172 173 174 175 176 177
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,
178
							 ...) G_GNUC_NULL_TERMINATED;
Tim Janik's avatar
Tim Janik committed
179 180 181
void         gtk_container_child_set			(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_prop_name,
182
							 ...) G_GNUC_NULL_TERMINATED;
Tim Janik's avatar
Tim Janik committed
183 184 185
void         gtk_container_child_get			(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_prop_name,
186
							 ...) G_GNUC_NULL_TERMINATED;
Tim Janik's avatar
Tim Janik committed
187 188 189 190 191 192 193 194
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);
195 196 197 198 199 200 201 202
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
203 204 205

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

Tim Janik's avatar
Tim Janik committed
207

208 209 210
void    gtk_container_forall		     (GtkContainer *container,
					      GtkCallback   callback,
					      gpointer	    callback_data);
211 212 213 214 215

/* 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,
216
					      GtkWidget	   *child);
217
void   _gtk_container_dequeue_resize_handler (GtkContainer *container);
218 219 220 221
GList *_gtk_container_focus_sort             (GtkContainer     *container,
					      GList            *children,
					      GtkDirectionType  direction,
					      GtkWidget        *old_focus);
222

223 224 225 226
#ifndef GTK_DISABLE_DEPRECATED
#define	gtk_container_border_width		gtk_container_set_border_width
#endif /* GTK_DISABLE_DEPRECATED */

227
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
228 229

#endif /* __GTK_CONTAINER_H__ */