src/adg/adg-canvas.h.in

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007-2020  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
  30 G_BEGIN_DECLS
  31
  32 #define ADG_TYPE_CANVAS             (adg_canvas_get_type())
  33 #define ADG_CANVAS(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), ADG_TYPE_CANVAS, AdgCanvas))
  34 #define ADG_CANVAS_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), ADG_TYPE_CANVAS, AdgCanvasClass))
  35 #define ADG_IS_CANVAS(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), ADG_TYPE_CANVAS))
  36 #define ADG_IS_CANVAS_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), ADG_TYPE_CANVAS))
  37 #define ADG_CANVAS_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), ADG_TYPE_CANVAS, AdgCanvasClass))
  38
  39 #define ADG_CANVAS_ERROR            (adg_canvas_error_quark())
  40
  41
  42 typedef struct _AdgCanvasClass   AdgCanvasClass;
  43
  44 struct _AdgCanvas {
  45     /*< private >*/
  46     AdgContainer         parent;
  47 };
  48
  49 struct _AdgCanvasClass {
  50     /*< private >*/
  51     AdgContainerClass    parent_class;
  52 };
  53
  54 typedef enum {
  55     ADG_CANVAS_ERROR_SURFACE,
  56     ADG_CANVAS_ERROR_CAIRO,
  57 } AdgCanvasError;
  58
  59
  60 GType           adg_canvas_get_type             (void);
  61 GQuark          adg_canvas_error_quark          (void);
  62
  63 AdgCanvas *     adg_canvas_new                  (void);
  64 void            adg_canvas_set_size             (AdgCanvas      *canvas,
  65                                                  const CpmlPair *size);
  66 void            adg_canvas_set_size_explicit    (AdgCanvas      *canvas,
  67                                                  gdouble         x,
  68                                                  gdouble         y);
  69 const CpmlPair *adg_canvas_get_size             (AdgCanvas      *canvas);
  70 void            adg_canvas_set_factor           (AdgCanvas      *canvas,
  71                                                  double          factor);
  72 double          adg_canvas_get_factor           (AdgCanvas      *canvas);
  73 void            adg_canvas_set_scales           (AdgCanvas      *canvas,
  74                                                  ...) G_GNUC_NULL_TERMINATED;
  75 void            adg_canvas_set_scales_valist    (AdgCanvas      *canvas,
  76                                                  va_list         var_args);
  77 void            adg_canvas_set_scales_array     (AdgCanvas      *canvas,
  78                                                  gchar         **scales);
  79 gchar **        adg_canvas_get_scales           (AdgCanvas      *canvas);
  80 void            adg_canvas_autoscale            (AdgCanvas      *canvas);
  81 void            adg_canvas_set_background_dress (AdgCanvas      *canvas,
  82                                                  AdgDress        dress);
  83 AdgDress        adg_canvas_get_background_dress (AdgCanvas      *canvas);
  84 void            adg_canvas_set_frame_dress      (AdgCanvas      *canvas,
  85                                                  AdgDress        dress);
  86 AdgDress        adg_canvas_get_frame_dress      (AdgCanvas      *canvas);
  87 void            adg_canvas_set_title_block      (AdgCanvas      *canvas,
  88                                                  AdgTitleBlock  *title_block);
  89 AdgTitleBlock * adg_canvas_get_title_block      (AdgCanvas      *canvas);
  90 void            adg_canvas_set_top_margin       (AdgCanvas      *canvas,
  91                                                  gdouble         value);
  92 gdouble         adg_canvas_get_top_margin       (AdgCanvas      *canvas);
  93 void            adg_canvas_set_right_margin     (AdgCanvas      *canvas,
  94                                                  gdouble         value);
  95 gdouble         adg_canvas_get_right_margin     (AdgCanvas      *canvas);
  96 void            adg_canvas_set_bottom_margin    (AdgCanvas      *canvas,
  97                                                  gdouble         value);
  98 gdouble         adg_canvas_get_bottom_margin    (AdgCanvas      *canvas);
  99 void            adg_canvas_set_left_margin      (AdgCanvas      *canvas,
 100                                                  gdouble         value);
 101 gdouble         adg_canvas_get_left_margin      (AdgCanvas      *canvas);
 102 void            adg_canvas_set_margins          (AdgCanvas      *canvas,
 103                                                  gdouble         top,
 104                                                  gdouble         right,
 105                                                  gdouble         bottom,
 106                                                  gdouble         left);
 107 void            adg_canvas_get_margins          (AdgCanvas      *canvas,
 108                                                  gdouble        *top,
 109                                                  gdouble        *right,
 110                                                  gdouble        *bottom,
 111                                                  gdouble        *left);
 112 void            adg_canvas_apply_margins        (AdgCanvas      *canvas,
 113                                                  CpmlExtents    *extents);
 114 void            adg_canvas_switch_frame         (AdgCanvas      *canvas,
 115                                                  gboolean        new_state);
 116 gboolean        adg_canvas_has_frame            (AdgCanvas      *canvas);
 117 void            adg_canvas_set_top_padding      (AdgCanvas      *canvas,
 118                                                  gdouble         value);
 119 gdouble         adg_canvas_get_top_padding      (AdgCanvas      *canvas);
 120 void            adg_canvas_set_right_padding    (AdgCanvas      *canvas,
 121                                                  gdouble         value);
 122 gdouble         adg_canvas_get_right_padding    (AdgCanvas      *canvas);
 123 void            adg_canvas_set_bottom_padding   (AdgCanvas      *canvas,
 124                                                  gdouble         value);
 125 gdouble         adg_canvas_get_bottom_padding   (AdgCanvas      *canvas);
 126 void            adg_canvas_set_left_padding     (AdgCanvas      *canvas,
 127                                                  gdouble         value);
 128 gdouble         adg_canvas_get_left_padding     (AdgCanvas      *canvas);
 129 void            adg_canvas_set_paddings         (AdgCanvas      *canvas,
 130                                                  gdouble         top,
 131                                                  gdouble         right,
 132                                                  gdouble         bottom,
 133                                                  gdouble         left);
 134 void            adg_canvas_get_paddings         (AdgCanvas      *canvas,
 135                                                  gdouble        *top,
 136                                                  gdouble        *right,
 137                                                  gdouble        *bottom,
 138                                                  gdouble        *left);
 139 gboolean        adg_canvas_export               (AdgCanvas      *canvas,
 140                                                  cairo_surface_type_t type,
 141                                                  const gchar    *file,
 142                                                  GError        **gerror);
 143 @ADG_CANVAS_H_ADDITIONAL@
 144 G_END_DECLS
 145
 146
 147 #endif /* __ADG_CANVAS_H__ */