gtkcontainer.h 9.17 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
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 29 30
#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

Elliot Lee's avatar
Elliot Lee committed
48

49 50 51
typedef struct _GtkContainer              GtkContainer;
typedef struct _GtkContainerPrivate       GtkContainerPrivate;
typedef struct _GtkContainerClass         GtkContainerClass;
Elliot Lee's avatar
Elliot Lee committed
52 53 54 55

struct _GtkContainer
{
  GtkWidget widget;
56

57
  /*< private >*/
58
  GtkContainerPrivate *priv;
Elliot Lee's avatar
Elliot Lee committed
59 60 61 62 63
};

struct _GtkContainerClass
{
  GtkWidgetClass parent_class;
64

65 66
  unsigned int handle_border_width : 1;

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

92
  /* Padding for future expansion */
93 94 95 96
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
97 98 99 100
  void (*_gtk_reserved5) (void);
  void (*_gtk_reserved6) (void);
  void (*_gtk_reserved7) (void);
  void (*_gtk_reserved8) (void);
Elliot Lee's avatar
Elliot Lee committed
101 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 125
GList*   gtk_container_get_children     (GtkContainer       *container);

126 127 128
void     gtk_container_propagate_draw   (GtkContainer   *container,
					 GtkWidget      *child,
					 cairo_t        *cr);
129

130 131
void     gtk_container_set_focus_chain  (GtkContainer   *container,
                                         GList          *focusable_widgets);
132 133
gboolean gtk_container_get_focus_chain  (GtkContainer   *container,
					 GList         **focusable_widgets);
134 135
void     gtk_container_unset_focus_chain (GtkContainer  *container);

136 137 138
#define GTK_IS_RESIZE_CONTAINER(widget) (GTK_IS_CONTAINER (widget) && \
                                        (gtk_container_get_resize_mode (GTK_CONTAINER (widget)) != GTK_RESIZE_PARENT))

139 140
/* Widget-level methods */

141 142
void   gtk_container_set_reallocate_redraws (GtkContainer    *container,
					     gboolean         needs_redraws);
143 144
void   gtk_container_set_focus_child	   (GtkContainer     *container,
					    GtkWidget	     *child);
145 146
GtkWidget *
       gtk_container_get_focus_child	   (GtkContainer     *container);
147 148
void   gtk_container_set_focus_vadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
149
GtkAdjustment *gtk_container_get_focus_vadjustment (GtkContainer *container);
150 151
void   gtk_container_set_focus_hadjustment (GtkContainer     *container,
					    GtkAdjustment    *adjustment);
152
GtkAdjustment *gtk_container_get_focus_hadjustment (GtkContainer *container);
153

154
void    gtk_container_resize_children      (GtkContainer     *container);
155

Manish Singh's avatar
Manish Singh committed
156
GType   gtk_container_child_type	   (GtkContainer     *container);
157

158

Tim Janik's avatar
Tim Janik committed
159 160 161 162 163 164 165 166 167 168
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,
169
							 ...) G_GNUC_NULL_TERMINATED;
Tim Janik's avatar
Tim Janik committed
170 171 172
void         gtk_container_child_set			(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_prop_name,
173
							 ...) G_GNUC_NULL_TERMINATED;
Tim Janik's avatar
Tim Janik committed
174 175 176
void         gtk_container_child_get			(GtkContainer	   *container,
							 GtkWidget	   *child,
							 const gchar	   *first_prop_name,
177
							 ...) G_GNUC_NULL_TERMINATED;
Tim Janik's avatar
Tim Janik committed
178 179 180 181 182 183 184 185
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);
186 187 188 189 190 191 192 193
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
194

195 196 197 198 199 200 201 202 203 204
/**
 * GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID:
 * @object: the #GObject on which set_child_property() or get_child_property()
 *  was called
 * @property_id: the numeric id of the property
 * @pspec: the #GParamSpec of the property
 *
 * This macro should be used to emit a standard warning about unexpected
 * properties in set_child_property() and get_child_property() implementations.
 */
Tim Janik's avatar
Tim Janik committed
205 206
#define GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID(object, property_id, pspec) \
    G_OBJECT_WARN_INVALID_PSPEC ((object), "child property id", (property_id), (pspec))
207

Tim Janik's avatar
Tim Janik committed
208

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

213 214
void    gtk_container_class_handle_border_width (GtkContainerClass *klass);

215 216
/* Non-public methods */
void	_gtk_container_queue_resize	     (GtkContainer *container);
217
void	_gtk_container_resize_invalidate     (GtkContainer *container);
218 219
void    _gtk_container_clear_resize_widgets   (GtkContainer *container);
gchar*	_gtk_container_child_composite_name   (GtkContainer *container,
220
					      GtkWidget	   *child);
221
void   _gtk_container_dequeue_resize_handler (GtkContainer *container);
222 223 224 225
GList *_gtk_container_focus_sort             (GtkContainer     *container,
					      GList            *children,
					      GtkDirectionType  direction,
					      GtkWidget        *old_focus);
226 227 228
gboolean _gtk_container_get_need_resize      (GtkContainer     *container);
void     _gtk_container_set_need_resize      (GtkContainer     *container,
                                              gboolean          need_resize);
229
gboolean _gtk_container_get_reallocate_redraws (GtkContainer   *container);
230

231
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
232 233

#endif /* __GTK_CONTAINER_H__ */