src/adg/adg-model.h

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009,2010  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_MODEL_H__
  27 #define __ADG_MODEL_H__
  28
  29 #include "adg-pair.h"
  30
  31
  32 G_BEGIN_DECLS
  33
  34 #define ADG_TYPE_MODEL             (adg_model_get_type())
  35 #define ADG_MODEL(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_MODEL, AdgModel))
  36 #define ADG_MODEL_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_MODEL, AdgModel))
  37 #define ADG_IS_MODEL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_MODEL))
  38 #define ADG_IS_MODEL_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_MODEL))
  39 #define ADG_MODEL_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_MODEL, AdgModelClass))
  40
  41
  42 /* Forward declarations */
  43 ADG_FORWARD_DECL(AdgEntity);
  44
  45 typedef struct _AdgModel        AdgModel;
  46 typedef struct _AdgModelClass   AdgModelClass;
  47 typedef void    (*AdgDependencyFunc)            (AdgModel       *model,
  48                                                  AdgEntity      *entity,
  49                                                  gpointer        user_data);
  50 typedef void    (*AdgNamedPairFunc)             (AdgModel       *model,
  51                                                  const gchar    *name,
  52                                                  AdgPair        *pair,
  53                                                  gpointer        user_data);
  54
  55 struct _AdgModel {
  56     /*< private >*/
  57     GObject              parent;
  58     gpointer             data;
  59 };
  60
  61 struct _AdgModelClass {
  62     /*< private >*/
  63     GObjectClass         parent_class;
  64     /*< public >*/
  65     void                (*add_dependency)       (AdgModel         *model,
  66                                                  AdgEntity        *entity);
  67     void                (*remove_dependency)    (AdgModel         *model,
  68                                                  AdgEntity        *entity);
  69     const AdgPair *     (*named_pair)           (AdgModel         *model,
  70                                                  const gchar      *name);
  71     void                (*set_named_pair)       (AdgModel         *model,
  72                                                  const gchar      *name,
  73                                                  const AdgPair    *pair);
  74     void                (*clear)                (AdgModel         *model);
  75     void                (*changed)              (AdgModel         *model);
  76 };
  77
  78
  79 GType           adg_model_get_type              (void) G_GNUC_CONST;
  80
  81 void            adg_model_add_dependency        (AdgModel         *model,
  82                                                  AdgEntity        *entity);
  83 void            adg_model_remove_dependency     (AdgModel         *model,
  84                                                  AdgEntity        *entity);
  85 const GSList *  adg_model_get_dependencies      (AdgModel         *model);
  86 void            adg_model_foreach_dependency    (AdgModel         *model,
  87                                                  AdgDependencyFunc callback,
  88                                                  gpointer          user_data);
  89 void            adg_model_set_named_pair        (AdgModel         *model,
  90                                                  const gchar      *name,
  91                                                  const AdgPair    *pair);
  92 void            adg_model_set_named_pair_explicit
  93                                                 (AdgModel         *model,
  94                                                  const gchar      *name,
  95                                                  gdouble           x,
  96                                                  gdouble           y);
  97 const AdgPair * adg_model_get_named_pair        (AdgModel         *model,
  98                                                  const gchar      *name);
  99 void            adg_model_foreach_named_pair    (AdgModel         *model,
 100                                                  AdgNamedPairFunc  callback,
 101                                                  gpointer          user_data);
 102 void            adg_model_clear                 (AdgModel         *model);
 103 void            adg_model_changed               (AdgModel         *model);
 104
 105 G_END_DECLS
 106
 107
 108 #endif /* __ADG_MODEL_H__ */