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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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-1999.  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 #ifndef __GTK_CONTAINER_H__
  28 #define __GTK_CONTAINER_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkenums.h>
  33 #include <gtk/gtkwidget.h>
  34 #include <gtk/gtkadjustment.h>
  35
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif /* __cplusplus */
  40
  41
  42 #define GTK_TYPE_CONTAINER              (gtk_container_get_type ())
  43 #define GTK_CONTAINER(obj)              (GTK_CHECK_CAST ((obj), GTK_TYPE_CONTAINER, GtkContainer))
  44 #define GTK_CONTAINER_CLASS(klass)      (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_CONTAINER, GtkContainerClass))
  45 #define GTK_IS_CONTAINER(obj)           (GTK_CHECK_TYPE ((obj), GTK_TYPE_CONTAINER))
  46 #define GTK_IS_CONTAINER_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CONTAINER))
  47
  48 #define GTK_IS_RESIZE_CONTAINER(widget) (GTK_IS_CONTAINER (widget) && ((GtkContainer*) (widget))->resize_mode != GTK_RESIZE_PARENT)
  49
  50
  51 typedef struct _GtkContainer       GtkContainer;
  52 typedef struct _GtkContainerClass  GtkContainerClass;
  53
  54 struct _GtkContainer
  55 {
  56   GtkWidget widget;
  57
  58   GtkWidget *focus_child;
  59
  60   guint border_width : 16;
  61   guint need_resize : 1;
  62   guint resize_mode : 2;
  63
  64
  65   /* The list of children that requested a resize
  66    */
  67   GSList *resize_widgets;
  68 };
  69
  70 struct _GtkContainerClass
  71 {
  72   GtkWidgetClass parent_class;
  73
  74   guint   n_child_args;
  75
  76   void (* add)                  (GtkContainer    *container,
  77                                  GtkWidget       *widget);
  78   void (* remove)               (GtkContainer    *container,
  79                                  GtkWidget       *widget);
  80   void (* check_resize)         (GtkContainer    *container);
  81   void (* forall)               (GtkContainer    *container,
  82                                  gboolean         include_internals,
  83                                  GtkCallback      callback,
  84                                  gpointer         callbabck_data);
  85   gint (* focus)                (GtkContainer    *container,
  86                                  GtkDirectionType  direction);
  87   void (* set_focus_child)      (GtkContainer    *container,
  88                                  GtkWidget       *widget);
  89   GtkType (*child_type)         (GtkContainer   *container);
  90   void    (*set_child_arg)      (GtkContainer   *container,
  91                                  GtkWidget      *child,
  92                                  GtkArg         *arg,
  93                                  guint           arg_id);
  94   void    (*get_child_arg)      (GtkContainer   *container,
  95                                  GtkWidget      *child,
  96                                  GtkArg         *arg,
  97                                  guint           arg_id);
  98   gchar*  (*composite_name)     (GtkContainer   *container,
  99                                  GtkWidget      *child);
 100 };
 101
 102 /* Application-level methods */
 103
 104 GtkType gtk_container_get_type           (void);
 105 void    gtk_container_set_border_width   (GtkContainer     *container,
 106                                           guint             border_width);
 107 void    gtk_container_add                (GtkContainer     *container,
 108                                           GtkWidget        *widget);
 109 void    gtk_container_remove             (GtkContainer     *container,
 110                                           GtkWidget        *widget);
 111
 112 void    gtk_container_set_resize_mode    (GtkContainer     *container,
 113                                           GtkResizeMode     resize_mode);
 114
 115 void    gtk_container_check_resize       (GtkContainer     *container);
 116
 117 void    gtk_container_foreach            (GtkContainer     *container,
 118                                           GtkCallback       callback,
 119                                           gpointer          callback_data);
 120 void    gtk_container_foreach_full       (GtkContainer     *container,
 121                                           GtkCallback       callback,
 122                                           GtkCallbackMarshal marshal,
 123                                           gpointer          callback_data,
 124                                           GtkDestroyNotify  notify);
 125 GList* gtk_container_children            (GtkContainer     *container);
 126 gint   gtk_container_focus                 (GtkContainer     *container,
 127                                             GtkDirectionType  direction);
 128
 129 /* Widget-level methods */
 130
 131 void   gtk_container_set_focus_child       (GtkContainer     *container,
 132                                             GtkWidget        *child);
 133 void   gtk_container_set_focus_vadjustment (GtkContainer     *container,
 134                                             GtkAdjustment    *adjustment);
 135 void   gtk_container_set_focus_hadjustment (GtkContainer     *container,
 136                                             GtkAdjustment    *adjustment);
 137 void    gtk_container_register_toplevel    (GtkContainer     *container);
 138 void    gtk_container_unregister_toplevel  (GtkContainer     *container);
 139 GList * gtk_container_get_toplevels        (void);
 140
 141 void    gtk_container_resize_children      (GtkContainer     *container);
 142
 143 GtkType gtk_container_child_type           (GtkContainer     *container);
 144
 145 /* the `arg_name' argument needs to be a const static string */
 146 void    gtk_container_add_child_arg_type   (const gchar      *arg_name,
 147                                             GtkType           arg_type,
 148                                             guint             arg_flags,
 149                                             guint             arg_id);
 150
 151 /* Allocate a GtkArg array of size nargs that hold the
 152  * names and types of the args that can be used with
 153  * gtk_container_child_getv/gtk_container_child_setv.
 154  * if (arg_flags!=NULL),
 155  * (*arg_flags) will be set to point to a newly allocated
 156  * guint array that holds the flags of the args.
 157  * It is the callers response to do a
 158  * g_free (returned_args); g_free (*arg_flags).
 159  */
 160 GtkArg* gtk_container_query_child_args     (GtkType            class_type,
 161                                             guint32          **arg_flags,
 162                                             guint             *nargs);
 163
 164 /* gtk_container_child_getv() sets an arguments type and value, or just
 165  * its type to GTK_TYPE_INVALID.
 166  * if GTK_FUNDAMENTAL_TYPE (arg->type) == GTK_TYPE_STRING, it's the callers
 167  * response to do a g_free (GTK_VALUE_STRING (arg));
 168  */
 169 void    gtk_container_child_getv           (GtkContainer      *container,
 170                                             GtkWidget         *child,
 171                                             guint              n_args,
 172                                             GtkArg            *args);
 173 void    gtk_container_child_setv           (GtkContainer      *container,
 174                                             GtkWidget         *child,
 175                                             guint              n_args,
 176                                             GtkArg            *args);
 177
 178 /* gtk_container_add_with_args() takes a variable argument list of the form:
 179  * (..., gchar *arg_name, ARG_VALUES, [repeatedly name/value pairs,] NULL)
 180  * where ARG_VALUES type depend on the argument and can consist of
 181  * more than one c-function argument.
 182  */
 183 void    gtk_container_add_with_args        (GtkContainer      *container,
 184                                             GtkWidget         *widget,
 185                                             const gchar       *first_arg_name,
 186                                             ...);
 187 void    gtk_container_addv                 (GtkContainer      *container,
 188                                             GtkWidget         *widget,
 189                                             guint              n_args,
 190                                             GtkArg            *args);
 191 void    gtk_container_child_set            (GtkContainer      *container,
 192                                             GtkWidget         *child,
 193                                             const gchar       *first_arg_name,
 194                                             ...);
 195
 196
 197 /* Non-public methods */
 198
 199 void    gtk_container_queue_resize         (GtkContainer *container);
 200 void    gtk_container_clear_resize_widgets (GtkContainer *container);
 201 void    gtk_container_arg_set              (GtkContainer *container,
 202                                             GtkWidget    *child,
 203                                             GtkArg       *arg,
 204                                             GtkArgInfo   *info);
 205 void    gtk_container_arg_get              (GtkContainer *container,
 206                                             GtkWidget    *child,
 207                                             GtkArg       *arg,
 208                                             GtkArgInfo   *info);
 209 gchar*  gtk_container_child_args_collect   (GtkType       object_type,
 210                                             GSList      **arg_list_p,
 211                                             GSList      **info_list_p,
 212                                             const gchar  *first_arg_name,
 213                                             va_list       args);
 214 gchar*  gtk_container_child_arg_get_info   (GtkType       object_type,
 215                                             const gchar  *arg_name,
 216                                             GtkArgInfo  **info_p);
 217 void    gtk_container_forall               (GtkContainer *container,
 218                                             GtkCallback   callback,
 219                                             gpointer      callback_data);
 220 gchar*  gtk_container_child_composite_name (GtkContainer *container,
 221                                             GtkWidget    *child);
 222
 223
 224 #ifdef __cplusplus
 225 }
 226 #endif /* __cplusplus */
 227
 228
 229 #endif /* __GTK_CONTAINER_H__ */