src/adg/adg-canvas.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  * * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the
  15  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16  * Boston, MA  02110-1301, USA.
  17  */
  18
  19
  20 #if !defined(__ADG_H__)
  21 #error "Only <adg.h> can be included directly."
  22 #endif
  23
  24
  25 #ifndef __ADG_CANVAS_H__
  26 #define __ADG_CANVAS_H__
  27
  28
  29 G_BEGIN_DECLS
  30
  31 #define ADG_TYPE_CANVAS             (adg_canvas_get_type())
  32 #define ADG_CANVAS(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_CANVAS, AdgCanvas))
  33 #define ADG_CANVAS_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_CANVAS, AdgCanvasClass))
  34 #define ADG_IS_CANVAS(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_CANVAS))
  35 #define ADG_IS_CANVAS_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_CANVAS))
  36 #define ADG_CANVAS_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_CANVAS, AdgCanvasClass))
  37
  38 #if 0
  39 /* AdgCanvas declared in adg-entity.h */
  40 typedef struct _AdgCanvas        AdgCanvas;
  41 #endif
  42 typedef struct _AdgCanvasClass   AdgCanvasClass;
  43
  44
  45 struct _AdgCanvas {
  46     /*< private >*/
  47     AdgContainer         parent;
  48     gpointer             data;
  49 };
  50
  51 struct _AdgCanvasClass {
  52     /*< private >*/
  53     AdgContainerClass    parent_class;
  54 };
  55
  56
  57 GType           adg_canvas_get_type             (void) G_GNUC_CONST;
  58
  59 AdgCanvas *     adg_canvas_new                  (void);
  60 void            adg_canvas_set_size             (AdgCanvas      *canvas,
  61                                                  const AdgPair  *size);
  62 void            adg_canvas_set_size_explicit    (AdgCanvas      *canvas,
  63                                                  gdouble         x,
  64                                                  gdouble         y);
  65 const AdgPair * adg_canvas_get_size             (AdgCanvas      *canvas);
  66 void            adg_canvas_set_background_dress (AdgCanvas      *canvas,
  67                                                  AdgDress        dress);
  68 AdgDress        adg_canvas_get_background_dress (AdgCanvas      *canvas);
  69 void            adg_canvas_set_frame_dress      (AdgCanvas      *canvas,
  70                                                  AdgDress        dress);
  71 AdgDress        adg_canvas_get_frame_dress      (AdgCanvas      *canvas);
  72 void            adg_canvas_set_title_block      (AdgCanvas      *canvas,
  73                                                  AdgTitleBlock  *title_block);
  74 AdgTitleBlock * adg_canvas_get_title_block      (AdgCanvas      *canvas);
  75 void            adg_canvas_set_top_margin       (AdgCanvas      *canvas,
  76                                                  gdouble         value);
  77 gdouble         adg_canvas_get_top_margin       (AdgCanvas      *canvas);
  78 void            adg_canvas_set_right_margin     (AdgCanvas      *canvas,
  79                                                  gdouble         value);
  80 gdouble         adg_canvas_get_right_margin     (AdgCanvas      *canvas);
  81 void            adg_canvas_set_bottom_margin    (AdgCanvas      *canvas,
  82                                                  gdouble         value);
  83 gdouble         adg_canvas_get_bottom_margin    (AdgCanvas      *canvas);
  84 void            adg_canvas_set_left_margin      (AdgCanvas      *canvas,
  85                                                  gdouble         value);
  86 gdouble         adg_canvas_get_left_margin      (AdgCanvas      *canvas);
  87 void            adg_canvas_set_margins          (AdgCanvas      *canvas,
  88                                                  gdouble         top,
  89                                                  gdouble         right,
  90                                                  gdouble         bottom,
  91                                                  gdouble         left);
  92 void            adg_canvas_apply_margins        (AdgCanvas      *canvas,
  93                                                  CpmlExtents    *extents);
  94 void            adg_canvas_switch_frame         (AdgCanvas      *canvas,
  95                                                  gboolean        new_state);
  96 gboolean        adg_canvas_has_frame            (AdgCanvas      *canvas);
  97 void            adg_canvas_set_top_padding      (AdgCanvas      *canvas,
  98                                                  gdouble         value);
  99 gdouble         adg_canvas_get_top_padding      (AdgCanvas      *canvas);
 100 void            adg_canvas_set_right_padding    (AdgCanvas      *canvas,
 101                                                  gdouble         value);
 102 gdouble         adg_canvas_get_right_padding    (AdgCanvas      *canvas);
 103 void            adg_canvas_set_bottom_padding   (AdgCanvas      *canvas,
 104                                                  gdouble         value);
 105 gdouble         adg_canvas_get_bottom_padding   (AdgCanvas      *canvas);
 106 void            adg_canvas_set_left_padding     (AdgCanvas      *canvas,
 107                                                  gdouble         value);
 108 gdouble         adg_canvas_get_left_padding     (AdgCanvas      *canvas);
 109 void            adg_canvas_set_paddings         (AdgCanvas      *canvas,
 110                                                  gdouble         top,
 111                                                  gdouble         right,
 112                                                  gdouble         bottom,
 113                                                  gdouble         left);
 114
 115 void            adg_canvas_set_paper            (AdgCanvas      *canvas,
 116                                                  const gchar    *paper_name,
 117                                                  GtkPageOrientation orientation);
 118 void            adg_canvas_set_page_setup       (AdgCanvas      *canvas,
 119                                                  GtkPageSetup   *page_setup);
 120
 121
 122 G_END_DECLS
 123
 124
 125 #endif /* __ADG_CANVAS_H__ */