src/adg/adg-canvas.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_CANVAS_H__
  27 #define __ADG_CANVAS_H__
  28
  29 #include "adg-container.h"
  30 #include "adg-title-block.h"
  31 #include "adg-style.h"
  32
  33
  34 G_BEGIN_DECLS
  35
  36 #define ADG_TYPE_CANVAS             (adg_canvas_get_type())
  37 #define ADG_CANVAS(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_CANVAS, AdgCanvas))
  38 #define ADG_CANVAS_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_CANVAS, AdgCanvasClass))
  39 #define ADG_IS_CANVAS(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_CANVAS))
  40 #define ADG_IS_CANVAS_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_CANVAS))
  41 #define ADG_CANVAS_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_CANVAS, AdgCanvasClass))
  42
  43 #if 0
  44 /* AdgCanvas declared in adg-entity.h */
  45 typedef struct _AdgCanvas        AdgCanvas;
  46 #endif
  47 typedef struct _AdgCanvasClass   AdgCanvasClass;
  48
  49
  50 struct _AdgCanvas {
  51     /*< private >*/
  52     AdgContainer         parent;
  53     gpointer             data;
  54 };
  55
  56 struct _AdgCanvasClass {
  57     /*< private >*/
  58     AdgContainerClass    parent_class;
  59 };
  60
  61
  62 GType           adg_canvas_get_type             (void) G_GNUC_CONST;
  63
  64 AdgCanvas *     adg_canvas_new                  (void);
  65 void            adg_canvas_set_size             (AdgCanvas      *canvas,
  66                                                  const AdgPair  *pair);
  67 void            adg_canvas_set_size_explicit    (AdgCanvas      *canvas,
  68                                                  gdouble         x,
  69                                                  gdouble         y);
  70 const AdgPair * adg_canvas_get_size             (AdgCanvas      *canvas);
  71 void            adg_canvas_set_background_dress (AdgCanvas      *canvas,
  72                                                  AdgDress        dress);
  73 AdgDress        adg_canvas_get_background_dress (AdgCanvas      *canvas);
  74 void            adg_canvas_set_frame_dress      (AdgCanvas      *canvas,
  75                                                  AdgDress        dress);
  76 AdgDress        adg_canvas_get_frame_dress      (AdgCanvas      *canvas);
  77 void            adg_canvas_set_title_block      (AdgCanvas      *canvas,
  78                                                  AdgTitleBlock  *title_block);
  79 AdgTitleBlock * adg_canvas_get_title_block      (AdgCanvas      *canvas);
  80 void            adg_canvas_set_top_margin       (AdgCanvas      *canvas,
  81                                                  gdouble         value);
  82 gdouble         adg_canvas_get_top_margin       (AdgCanvas      *canvas);
  83 void            adg_canvas_set_right_margin     (AdgCanvas      *canvas,
  84                                                  gdouble         value);
  85 gdouble         adg_canvas_get_right_margin     (AdgCanvas      *canvas);
  86 void            adg_canvas_set_bottom_margin    (AdgCanvas      *canvas,
  87                                                  gdouble         value);
  88 gdouble         adg_canvas_get_bottom_margin    (AdgCanvas      *canvas);
  89 void            adg_canvas_set_left_margin      (AdgCanvas      *canvas,
  90                                                  gdouble         value);
  91 gdouble         adg_canvas_get_left_margin      (AdgCanvas      *canvas);
  92 void            adg_canvas_set_margins          (AdgCanvas      *canvas,
  93                                                  gdouble         top,
  94                                                  gdouble         right,
  95                                                  gdouble         bottom,
  96                                                  gdouble         left);
  97 void            adg_canvas_switch_frame         (AdgCanvas      *canvas,
  98                                                  gboolean        new_state);
  99 gboolean        adg_canvas_has_frame            (AdgCanvas      *canvas);
 100 void            adg_canvas_set_top_padding      (AdgCanvas      *canvas,
 101                                                  gdouble         value);
 102 gdouble         adg_canvas_get_top_padding      (AdgCanvas      *canvas);
 103 void            adg_canvas_set_right_padding    (AdgCanvas      *canvas,
 104                                                  gdouble         value);
 105 gdouble         adg_canvas_get_right_padding    (AdgCanvas      *canvas);
 106 void            adg_canvas_set_bottom_padding   (AdgCanvas      *canvas,
 107                                                  gdouble         value);
 108 gdouble         adg_canvas_get_bottom_padding   (AdgCanvas      *canvas);
 109 void            adg_canvas_set_left_padding     (AdgCanvas      *canvas,
 110                                                  gdouble         value);
 111 gdouble         adg_canvas_get_left_padding     (AdgCanvas      *canvas);
 112 void            adg_canvas_set_paddings         (AdgCanvas      *canvas,
 113                                                  gdouble         top,
 114                                                  gdouble         right,
 115                                                  gdouble         bottom,
 116                                                  gdouble         left);
 117
 118 G_END_DECLS
 119
 120
 121 #endif /* __ADG_CANVAS_H__ */