Pileus Git - ~andy/gtk/blob - gtk/gtkcontainer.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * 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.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * 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 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_CONTAINER_H__
  32 #define __GTK_CONTAINER_H__
  33
  34
  35 #include <gtk/gtkwidget.h>
  36 #include <gtk/gtkadjustment.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41 #define GTK_TYPE_CONTAINER              (gtk_container_get_type ())
  42 #define GTK_CONTAINER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CONTAINER, GtkContainer))
  43 #define GTK_CONTAINER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CONTAINER, GtkContainerClass))
  44 #define GTK_IS_CONTAINER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CONTAINER))
  45 #define GTK_IS_CONTAINER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CONTAINER))
  46 #define GTK_CONTAINER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CONTAINER, GtkContainerClass))
  47
  48
  49 typedef struct _GtkContainer              GtkContainer;
  50 typedef struct _GtkContainerPrivate       GtkContainerPrivate;
  51 typedef struct _GtkContainerClass         GtkContainerClass;
  52
  53 struct _GtkContainer
  54 {
  55   GtkWidget widget;
  56
  57   /*< private >*/
  58   GtkContainerPrivate *priv;
  59 };
  60
  61 struct _GtkContainerClass
  62 {
  63   GtkWidgetClass parent_class;
  64
  65   unsigned int handle_border_width : 1;
  66
  67   void    (*add)                (GtkContainer    *container,
  68                                  GtkWidget       *widget);
  69   void    (*remove)             (GtkContainer    *container,
  70                                  GtkWidget       *widget);
  71   void    (*check_resize)       (GtkContainer    *container);
  72   void    (*forall)             (GtkContainer    *container,
  73                                  gboolean         include_internals,
  74                                  GtkCallback      callback,
  75                                  gpointer         callback_data);
  76   void    (*set_focus_child)    (GtkContainer    *container,
  77                                  GtkWidget       *widget);
  78   GType   (*child_type)         (GtkContainer    *container);
  79   gchar*  (*composite_name)     (GtkContainer    *container,
  80                                  GtkWidget       *child);
  81   void    (*set_child_property) (GtkContainer    *container,
  82                                  GtkWidget       *child,
  83                                  guint            property_id,
  84                                  const GValue    *value,
  85                                  GParamSpec      *pspec);
  86   void    (*get_child_property) (GtkContainer    *container,
  87                                  GtkWidget       *child,
  88                                  guint            property_id,
  89                                  GValue          *value,
  90                                  GParamSpec      *pspec);
  91   GtkWidgetPath * (*get_path_for_child) (GtkContainer *container,
  92                                          GtkWidget    *child);
  93
  94   /* Padding for future expansion */
  95   void (*_gtk_reserved1) (void);
  96   void (*_gtk_reserved2) (void);
  97   void (*_gtk_reserved3) (void);
  98   void (*_gtk_reserved4) (void);
  99   void (*_gtk_reserved5) (void);
 100   void (*_gtk_reserved6) (void);
 101   void (*_gtk_reserved7) (void);
 102   void (*_gtk_reserved8) (void);
 103 };
 104
 105
 106 /* Application-level methods */
 107
 108 GType   gtk_container_get_type           (void) G_GNUC_CONST;
 109 void    gtk_container_set_border_width   (GtkContainer     *container,
 110                                           guint             border_width);
 111 guint   gtk_container_get_border_width   (GtkContainer     *container);
 112 void    gtk_container_add                (GtkContainer     *container,
 113                                           GtkWidget        *widget);
 114 void    gtk_container_remove             (GtkContainer     *container,
 115                                           GtkWidget        *widget);
 116
 117 void    gtk_container_set_resize_mode    (GtkContainer     *container,
 118                                           GtkResizeMode     resize_mode);
 119 GtkResizeMode gtk_container_get_resize_mode (GtkContainer     *container);
 120
 121 void    gtk_container_check_resize       (GtkContainer     *container);
 122
 123 void     gtk_container_foreach      (GtkContainer       *container,
 124                                      GtkCallback         callback,
 125                                      gpointer            callback_data);
 126 GList*   gtk_container_get_children     (GtkContainer       *container);
 127
 128 void     gtk_container_propagate_draw   (GtkContainer   *container,
 129                                          GtkWidget      *child,
 130                                          cairo_t        *cr);
 131
 132 void     gtk_container_set_focus_chain  (GtkContainer   *container,
 133                                          GList          *focusable_widgets);
 134 gboolean gtk_container_get_focus_chain  (GtkContainer   *container,
 135                                          GList         **focusable_widgets);
 136 void     gtk_container_unset_focus_chain (GtkContainer  *container);
 137
 138 #define GTK_IS_RESIZE_CONTAINER(widget) (GTK_IS_CONTAINER (widget) && \
 139                                         (gtk_container_get_resize_mode (GTK_CONTAINER (widget)) != GTK_RESIZE_PARENT))
 140
 141 /* Widget-level methods */
 142
 143 void   gtk_container_set_reallocate_redraws (GtkContainer    *container,
 144                                              gboolean         needs_redraws);
 145 void   gtk_container_set_focus_child       (GtkContainer     *container,
 146                                             GtkWidget        *child);
 147 GtkWidget *
 148        gtk_container_get_focus_child       (GtkContainer     *container);
 149 void   gtk_container_set_focus_vadjustment (GtkContainer     *container,
 150                                             GtkAdjustment    *adjustment);
 151 GtkAdjustment *gtk_container_get_focus_vadjustment (GtkContainer *container);
 152 void   gtk_container_set_focus_hadjustment (GtkContainer     *container,
 153                                             GtkAdjustment    *adjustment);
 154 GtkAdjustment *gtk_container_get_focus_hadjustment (GtkContainer *container);
 155
 156 void    gtk_container_resize_children      (GtkContainer     *container);
 157
 158 GType   gtk_container_child_type           (GtkContainer     *container);
 159
 160
 161 void         gtk_container_class_install_child_property (GtkContainerClass *cclass,
 162                                                          guint              property_id,
 163                                                          GParamSpec        *pspec);
 164 GParamSpec*  gtk_container_class_find_child_property    (GObjectClass      *cclass,
 165                                                          const gchar       *property_name);
 166 GParamSpec** gtk_container_class_list_child_properties  (GObjectClass      *cclass,
 167                                                          guint             *n_properties);
 168 void         gtk_container_add_with_properties          (GtkContainer      *container,
 169                                                          GtkWidget         *widget,
 170                                                          const gchar       *first_prop_name,
 171                                                          ...) G_GNUC_NULL_TERMINATED;
 172 void         gtk_container_child_set                    (GtkContainer      *container,
 173                                                          GtkWidget         *child,
 174                                                          const gchar       *first_prop_name,
 175                                                          ...) G_GNUC_NULL_TERMINATED;
 176 void         gtk_container_child_get                    (GtkContainer      *container,
 177                                                          GtkWidget         *child,
 178                                                          const gchar       *first_prop_name,
 179                                                          ...) G_GNUC_NULL_TERMINATED;
 180 void         gtk_container_child_set_valist             (GtkContainer      *container,
 181                                                          GtkWidget         *child,
 182                                                          const gchar       *first_property_name,
 183                                                          va_list            var_args);
 184 void         gtk_container_child_get_valist             (GtkContainer      *container,
 185                                                          GtkWidget         *child,
 186                                                          const gchar       *first_property_name,
 187                                                          va_list            var_args);
 188 void         gtk_container_child_set_property           (GtkContainer      *container,
 189                                                          GtkWidget         *child,
 190                                                          const gchar       *property_name,
 191                                                          const GValue      *value);
 192 void         gtk_container_child_get_property           (GtkContainer      *container,
 193                                                          GtkWidget         *child,
 194                                                          const gchar       *property_name,
 195                                                          GValue            *value);
 196
 197 /**
 198  * GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID:
 199  * @object: the #GObject on which set_child_property() or get_child_property()
 200  *  was called
 201  * @property_id: the numeric id of the property
 202  * @pspec: the #GParamSpec of the property
 203  *
 204  * This macro should be used to emit a standard warning about unexpected
 205  * properties in set_child_property() and get_child_property() implementations.
 206  */
 207 #define GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID(object, property_id, pspec) \
 208     G_OBJECT_WARN_INVALID_PSPEC ((object), "child property id", (property_id), (pspec))
 209
 210
 211 void    gtk_container_forall                 (GtkContainer *container,
 212                                               GtkCallback   callback,
 213                                               gpointer      callback_data);
 214
 215 void    gtk_container_class_handle_border_width (GtkContainerClass *klass);
 216
 217 /* Non-public methods */
 218 void    _gtk_container_queue_resize          (GtkContainer *container);
 219 void    _gtk_container_resize_invalidate     (GtkContainer *container);
 220 void    _gtk_container_clear_resize_widgets   (GtkContainer *container);
 221 gchar*  _gtk_container_child_composite_name   (GtkContainer *container,
 222                                               GtkWidget    *child);
 223 void   _gtk_container_dequeue_resize_handler (GtkContainer *container);
 224 GList *_gtk_container_focus_sort             (GtkContainer     *container,
 225                                               GList            *children,
 226                                               GtkDirectionType  direction,
 227                                               GtkWidget        *old_focus);
 228 gboolean _gtk_container_get_need_resize      (GtkContainer     *container);
 229 void     _gtk_container_set_need_resize      (GtkContainer     *container,
 230                                               gboolean          need_resize);
 231 gboolean _gtk_container_get_reallocate_redraws (GtkContainer   *container);
 232
 233 GtkWidgetPath * gtk_container_get_path_for_child (GtkContainer      *container,
 234                                                   GtkWidget         *child);
 235
 236 G_END_DECLS
 237
 238 #endif /* __GTK_CONTAINER_H__ */