1/* cairo - a vector graphics library with display and print output
2 *
3 * cairo-svg.h
4 *
5 * Copyright © 2005 Emmanuel Pacaud <emmanuel.pacaud@univ-poitiers.fr>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it either under the terms of the GNU Lesser General Public
9 * License version 2.1 as published by the Free Software Foundation
10 * (the "LGPL") or, at your option, under the terms of the Mozilla
11 * Public License Version 1.1 (the "MPL"). If you do not alter this
12 * notice, a recipient may use your version of this file under either
13 * the MPL or the LGPL.
14 *
15 * You should have received a copy of the LGPL along with this library
16 * in the file COPYING-LGPL-2.1; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
18 * You should have received a copy of the MPL along with this library
19 * in the file COPYING-MPL-1.1
20 *
21 * The contents of this file are subject to the Mozilla Public License
22 * Version 1.1 (the "License"); you may not use this file except in
23 * compliance with the License. You may obtain a copy of the License at
24 * http://www.mozilla.org/MPL/
25 *
26 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
27 * OF ANY KIND, either express or implied. See the LGPL or the MPL for
28 * the specific language governing rights and limitations.
29 *
30 */
31
32#ifndef CAIRO_SVG_H
33#define CAIRO_SVG_H
34
35#include "cairo.h"
36
37#if CAIRO_HAS_SVG_SURFACE
38
39CAIRO_BEGIN_DECLS
40
41/**
42 * cairo_svg_version_t:
43 * @CAIRO_SVG_VERSION_1_1: The version 1.1 of the SVG specification. (Since 1.2)
44 * @CAIRO_SVG_VERSION_1_2: The version 1.2 of the SVG specification. (Since 1.2)
45 *
46 * #cairo_svg_version_t is used to describe the version number of the SVG
47 * specification that a generated SVG file will conform to.
48 *
49 * Since: 1.2
50 **/
51typedef enum _cairo_svg_version {
52 CAIRO_SVG_VERSION_1_1,
53 CAIRO_SVG_VERSION_1_2
54} cairo_svg_version_t;
55
56/**
57 * cairo_svg_version_t:
58 *
59 * @CAIRO_SVG_UNIT_USER: User unit, a value in the current coordinate system.
60 * If used in the root element for the initial coordinate systems it
61 * corresponds to pixels. (Since 1.16)
62 * @CAIRO_SVG_UNIT_EM: The size of the element's font. (Since 1.16)
63 * @CAIRO_SVG_UNIT_EX: The x-height of the element’s font. (Since 1.16)
64 * @CAIRO_SVG_UNIT_PX: Pixels (1px = 1/96th of 1in). (Since 1.16)
65 * @CAIRO_SVG_UNIT_IN: Inches (1in = 2.54cm = 96px). (Since 1.16)
66 * @CAIRO_SVG_UNIT_CM: Centimeters (1cm = 96px/2.54). (Since 1.16)
67 * @CAIRO_SVG_UNIT_MM: Millimeters (1mm = 1/10th of 1cm). (Since 1.16)
68 * @CAIRO_SVG_UNIT_PT: Points (1pt = 1/72th of 1in). (Since 1.16)
69 * @CAIRO_SVG_UNIT_PC: Picas (1pc = 1/6th of 1in). (Since 1.16)
70 * @CAIRO_SVG_UNIT_PERCENT: Percent, a value that is some fraction of another
71 * reference value. (Since 1.16)
72 *
73 * #cairo_svg_unit_t is used to describe the units valid for coordinates and
74 * lengths in the SVG specification.
75 *
76 * See also:
77 * https://www.w3.org/TR/SVG/coords.html#Units
78 * https://www.w3.org/TR/SVG/types.html#DataTypeLength
79 * https://www.w3.org/TR/css-values-3/#lengths
80 *
81 * Since: 1.16
82 **/
83typedef enum _cairo_svg_unit {
84 CAIRO_SVG_UNIT_USER = 0,
85 CAIRO_SVG_UNIT_EM,
86 CAIRO_SVG_UNIT_EX,
87 CAIRO_SVG_UNIT_PX,
88 CAIRO_SVG_UNIT_IN,
89 CAIRO_SVG_UNIT_CM,
90 CAIRO_SVG_UNIT_MM,
91 CAIRO_SVG_UNIT_PT,
92 CAIRO_SVG_UNIT_PC,
93 CAIRO_SVG_UNIT_PERCENT
94} cairo_svg_unit_t;
95
96cairo_public cairo_surface_t *
97cairo_svg_surface_create (const char *filename,
98 double width_in_points,
99 double height_in_points);
100
101cairo_public cairo_surface_t *
102cairo_svg_surface_create_for_stream (cairo_write_func_t write_func,
103 void *closure,
104 double width_in_points,
105 double height_in_points);
106
107cairo_public void
108cairo_svg_surface_restrict_to_version (cairo_surface_t *surface,
109 cairo_svg_version_t version);
110
111cairo_public void
112cairo_svg_get_versions (cairo_svg_version_t const **versions,
113 int *num_versions);
114
115cairo_public const char *
116cairo_svg_version_to_string (cairo_svg_version_t version);
117
118cairo_public void
119cairo_svg_surface_set_document_unit (cairo_surface_t *surface,
120 cairo_svg_unit_t unit);
121
122cairo_public cairo_svg_unit_t
123cairo_svg_surface_get_document_unit (cairo_surface_t *surface);
124
125CAIRO_END_DECLS
126
127#else /* CAIRO_HAS_SVG_SURFACE */
128# error Cairo was not compiled with support for the svg backend
129#endif /* CAIRO_HAS_SVG_SURFACE */
130
131#endif /* CAIRO_SVG_H */
132