adg/adg-container.h

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009 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 #ifndef __ADG_CONTAINER_H__
  22 #define __ADG_CONTAINER_H__
  23
  24 #include <adg/adg-entity.h>
  25
  26
  27 G_BEGIN_DECLS
  28
  29 #define ADG_TYPE_CONTAINER             (adg_container_get_type ())
  30 #define ADG_CONTAINER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), ADG_TYPE_CONTAINER, AdgContainer))
  31 #define ADG_CONTAINER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), ADG_TYPE_CONTAINER, AdgContainerClass))
  32 #define ADG_IS_CONTAINER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ADG_TYPE_CONTAINER))
  33 #define ADG_IS_CONTAINER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), ADG_TYPE_CONTAINER))
  34 #define ADG_CONTAINER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), ADG_TYPE_CONTAINER, AdgContainerClass))
  35
  36
  37 /* AdgContainer declared in adg-entity.h */
  38 typedef struct _AdgContainerClass   AdgContainerClass;
  39 typedef struct _AdgContainerPrivate AdgContainerPrivate;
  40
  41 struct _AdgContainer {
  42     AdgEntity            entity;
  43
  44     /*< private >*/
  45     AdgContainerPrivate *priv;
  46 };
  47
  48 struct _AdgContainerClass {
  49     AdgEntityClass       parent_class;
  50
  51     /* Virtual Table */
  52     GSList *    (*get_children)                 (AdgContainer   *container);
  53     gboolean    (*add)                          (AdgContainer   *container,
  54                                                  AdgEntity      *entity);
  55     gboolean    (*remove)                       (AdgContainer   *container,
  56                                                  AdgEntity      *entity);
  57 };
  58
  59
  60 GType            adg_container_get_type         (void) G_GNUC_CONST;
  61 GSList *         adg_container_get_children     (AdgContainer   *container);
  62 void             adg_container_add              (AdgContainer   *container,
  63                                                  AdgEntity      *entity);
  64 void             adg_container_remove           (AdgContainer   *container,
  65                                                  AdgEntity      *entity);
  66
  67 void             adg_container_foreach          (AdgContainer   *container,
  68                                                  GCallback       callback,
  69                                                  gpointer        user_data);
  70 void             adg_container_propagate        (AdgContainer   *container,
  71                                                  guint           signal_id,
  72                                                  GQuark          detail,
  73                                                  ...);
  74 void             adg_container_propagate_by_name(AdgContainer   *container,
  75                                                  const gchar    *detailed_signal,
  76                                                  ...);
  77 void             adg_container_propagate_valist(AdgContainer    *container,
  78                                                  guint           signal_id,
  79                                                  GQuark          detail,
  80                                                  va_list         var_args);
  81 const AdgMatrix *adg_container_get_model_transformation
  82                                                 (AdgContainer   *container);
  83 void             adg_container_set_model_transformation
  84                                                 (AdgContainer   *container,
  85                                                  const AdgMatrix *transformation);
  86 const AdgMatrix *adg_container_get_paper_transformation
  87                                                 (AdgContainer   *container);
  88 void             adg_container_set_paper_transformation
  89                                                 (AdgContainer   *container,
  90                                                  const AdgMatrix *transformation);
  91
  92 G_END_DECLS
  93
  94
  95 #endif /* __ADG_CONTAINER_H__ */