src/adg/adg-container.h

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009,2010,2011,2012  Nicola Fontana <ntd at entidi.it>
   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., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 #if !defined(__ADG_H__)
  22 #error "Only <adg.h> can be included directly."
  23 #endif
  24
  25
  26 #ifndef __ADG_CONTAINER_H__
  27 #define __ADG_CONTAINER_H__
  28
  29
  30 G_BEGIN_DECLS
  31
  32 #define ADG_TYPE_CONTAINER             (adg_container_get_type())
  33 #define ADG_CONTAINER(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_CONTAINER, AdgContainer))
  34 #define ADG_CONTAINER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_CONTAINER, AdgContainerClass))
  35 #define ADG_IS_CONTAINER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_CONTAINER))
  36 #define ADG_IS_CONTAINER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_CONTAINER))
  37 #define ADG_CONTAINER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_CONTAINER, AdgContainerClass))
  38
  39
  40 typedef struct _AdgContainer       AdgContainer;
  41 typedef struct _AdgContainerClass  AdgContainerClass;
  42
  43 struct _AdgContainer {
  44     /*< private >*/
  45     AdgEntity            parent;
  46     gpointer             data;
  47 };
  48
  49 struct _AdgContainerClass {
  50     /*< private >*/
  51     AdgEntityClass       parent_class;
  52
  53     /*< public >*/
  54     /* Virtual table */
  55     GSList *    (*children)                     (AdgContainer   *container);
  56
  57     /* Signals */
  58     void        (*add)                          (AdgContainer   *container,
  59                                                  AdgEntity      *entity);
  60     void        (*remove)                       (AdgContainer   *container,
  61                                                  AdgEntity      *entity);
  62 };
  63
  64
  65 GType           adg_container_get_type          (void) G_GNUC_CONST;
  66
  67 AdgContainer *  adg_container_new               (void);
  68 GSList *        adg_container_children          (AdgContainer    *container);
  69 void            adg_container_add               (AdgContainer    *container,
  70                                                  AdgEntity       *entity);
  71 void            adg_container_remove            (AdgContainer    *container,
  72                                                  AdgEntity       *entity);
  73
  74 void            adg_container_foreach           (AdgContainer    *container,
  75                                                  GCallback        callback,
  76                                                  gpointer         user_data);
  77 void            adg_container_propagate         (AdgContainer    *container,
  78                                                  guint            signal_id,
  79                                                  GQuark           detail,
  80                                                  ...);
  81 void            adg_container_propagate_by_name (AdgContainer    *container,
  82                                                  const gchar     *detailed_signal,
  83                                                  ...);
  84 void            adg_container_propagate_valist  (AdgContainer    *container,
  85                                                  guint            signal_id,
  86                                                  GQuark           detail,
  87                                                  va_list          var_args);
  88
  89 G_END_DECLS
  90
  91
  92 #endif /* __ADG_CONTAINER_H__ */