src/adg/adg-canvas.h.in

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009,2010,2011,2012,2013  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
  39 typedef struct _AdgCanvasClass   AdgCanvasClass;
  40
  41 struct _AdgCanvas {
  42     /*< private >*/
  43     AdgContainer         parent;
  44     gpointer             data;
  45 };
  46
  47 struct _AdgCanvasClass {
  48     /*< private >*/
  49     AdgContainerClass    parent_class;
  50 };
  51
  52
  53 GType           adg_canvas_get_type             (void) G_GNUC_CONST;
  54
  55 AdgCanvas *     adg_canvas_new                  (void);
  56 void            adg_canvas_set_size             (AdgCanvas      *canvas,
  57                                                  const CpmlPair *size);
  58 void            adg_canvas_set_size_explicit    (AdgCanvas      *canvas,
  59                                                  gdouble         x,
  60                                                  gdouble         y);
  61 const CpmlPair *adg_canvas_get_size             (AdgCanvas      *canvas);
  62 void            adg_canvas_set_scales           (AdgCanvas      *canvas,
  63                                                  ...) G_GNUC_NULL_TERMINATED;
  64 void            adg_canvas_set_scales_valist    (AdgCanvas      *canvas,
  65                                                  va_list         var_args);
  66 void            adg_canvas_set_scales_array     (AdgCanvas      *canvas,
  67                                                  gchar         **scales);
  68 gchar **        adg_canvas_get_scales           (AdgCanvas      *canvas);
  69 void            adg_canvas_autoscale            (AdgCanvas      *canvas);
  70 void            adg_canvas_set_background_dress (AdgCanvas      *canvas,
  71                                                  AdgDress        dress);
  72 AdgDress        adg_canvas_get_background_dress (AdgCanvas      *canvas);
  73 void            adg_canvas_set_frame_dress      (AdgCanvas      *canvas,
  74                                                  AdgDress        dress);
  75 AdgDress        adg_canvas_get_frame_dress      (AdgCanvas      *canvas);
  76 void            adg_canvas_set_title_block      (AdgCanvas      *canvas,
  77                                                  AdgTitleBlock  *title_block);
  78 AdgTitleBlock * adg_canvas_get_title_block      (AdgCanvas      *canvas);
  79 void            adg_canvas_set_top_margin       (AdgCanvas      *canvas,
  80                                                  gdouble         value);
  81 gdouble         adg_canvas_get_top_margin       (AdgCanvas      *canvas);
  82 void            adg_canvas_set_right_margin     (AdgCanvas      *canvas,
  83                                                  gdouble         value);
  84 gdouble         adg_canvas_get_right_margin     (AdgCanvas      *canvas);
  85 void            adg_canvas_set_bottom_margin    (AdgCanvas      *canvas,
  86                                                  gdouble         value);
  87 gdouble         adg_canvas_get_bottom_margin    (AdgCanvas      *canvas);
  88 void            adg_canvas_set_left_margin      (AdgCanvas      *canvas,
  89                                                  gdouble         value);
  90 gdouble         adg_canvas_get_left_margin      (AdgCanvas      *canvas);
  91 void            adg_canvas_set_margins          (AdgCanvas      *canvas,
  92                                                  gdouble         top,
  93                                                  gdouble         right,
  94                                                  gdouble         bottom,
  95                                                  gdouble         left);
  96 void            adg_canvas_apply_margins        (AdgCanvas      *canvas,
  97                                                  CpmlExtents    *extents);
  98 void            adg_canvas_switch_frame         (AdgCanvas      *canvas,
  99                                                  gboolean        new_state);
 100 gboolean        adg_canvas_has_frame            (AdgCanvas      *canvas);
 101 void            adg_canvas_set_top_padding      (AdgCanvas      *canvas,
 102                                                  gdouble         value);
 103 gdouble         adg_canvas_get_top_padding      (AdgCanvas      *canvas);
 104 void            adg_canvas_set_right_padding    (AdgCanvas      *canvas,
 105                                                  gdouble         value);
 106 gdouble         adg_canvas_get_right_padding    (AdgCanvas      *canvas);
 107 void            adg_canvas_set_bottom_padding   (AdgCanvas      *canvas,
 108                                                  gdouble         value);
 109 gdouble         adg_canvas_get_bottom_padding   (AdgCanvas      *canvas);
 110 void            adg_canvas_set_left_padding     (AdgCanvas      *canvas,
 111                                                  gdouble         value);
 112 gdouble         adg_canvas_get_left_padding     (AdgCanvas      *canvas);
 113 void            adg_canvas_set_paddings         (AdgCanvas      *canvas,
 114                                                  gdouble         top,
 115                                                  gdouble         right,
 116                                                  gdouble         bottom,
 117                                                  gdouble         left);
 118 @ADG_CANVAS_H_ADDITIONAL@
 119
 120 G_END_DECLS
 121
 122
 123 #endif /* __ADG_CANVAS_H__ */