rsvg.h

Go to the documentation of this file.

/* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* vim: set sw=4 sts=4 expandtab: */
/*
   rsvg.h: Public C API for librsvg.
 
   Copyright (C) 2000 Eazel, Inc.
   Copyright (C) 2026 Randy Butler
 
   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public
   License along with this program; if not, write to the
   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/
 
#ifndef RSVG_H
#define RSVG_H
 
#define __RSVG_RSVG_H_INSIDE__
 
#include <glib-object.h>
#include <gio/gio.h>
 
G_BEGIN_DECLS
 
#ifndef RSVG_API
# define RSVG_API
#endif
 
#if defined(RSVG_DISABLE_DEPRECATION_WARNINGS) || !GLIB_CHECK_VERSION (2, 31, 0)
#define RSVG_DEPRECATED RSVG_API
#define RSVG_DEPRECATED_FOR(f) RSVG_API
#else
#define RSVG_DEPRECATED G_DEPRECATED RSVG_API
#define RSVG_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f) RSVG_API
#endif
 
typedef enum {
    RSVG_ERROR_FAILED
} RsvgError;
 
#define RSVG_ERROR (rsvg_error_quark ())
 
RSVG_API
GQuark rsvg_error_quark (void) G_GNUC_CONST;
 
RSVG_API
GType rsvg_error_get_type (void);
#define RSVG_TYPE_ERROR (rsvg_error_get_type())
 
#define RSVG_TYPE_HANDLE                  (rsvg_handle_get_type ())
#define RSVG_HANDLE(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), RSVG_TYPE_HANDLE, RsvgHandle))
#define RSVG_HANDLE_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), RSVG_TYPE_HANDLE, RsvgHandleClass))
#define RSVG_IS_HANDLE(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), RSVG_TYPE_HANDLE))
#define RSVG_IS_HANDLE_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), RSVG_TYPE_HANDLE))
#define RSVG_HANDLE_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), RSVG_TYPE_HANDLE, RsvgHandleClass))
 
RSVG_API
GType rsvg_handle_get_type (void);
 
#ifdef RSVG_COMPILATION
typedef struct RsvgHandlePrivate RsvgHandlePrivate;
#endif
 
typedef struct _RsvgHandle RsvgHandle;
typedef struct _RsvgHandleClass RsvgHandleClass;
typedef struct _RsvgDimensionData RsvgDimensionData;
typedef struct _RsvgPositionData RsvgPositionData;
typedef struct _RsvgRectangle RsvgRectangle;
 
struct _RsvgHandleClass {
    GObjectClass parent;
 
    /*< private >*/
    gpointer _abi_padding[15];
};
 
struct _RsvgHandle {
    GObject parent;
 
    /*< private >*/
#ifdef RSVG_COMPILATION
    RsvgHandlePrivate *priv;
    gpointer _abi_padding[15];
#else
    gpointer _abi_padding[16];
#endif
};
 
struct _RsvgDimensionData {
    int width;
    int height;
    gdouble em;
    gdouble ex;
};
 
struct _RsvgPositionData {
    int x;
    int y;
};
 
struct _RsvgRectangle {
    double x;
    double y;
    double width;
    double height;
};
 
typedef enum {
    RSVG_UNIT_PERCENT,
    RSVG_UNIT_PX,
    RSVG_UNIT_EM,
    RSVG_UNIT_EX,
    RSVG_UNIT_IN,
    RSVG_UNIT_CM,
    RSVG_UNIT_MM,
    RSVG_UNIT_PT,
    RSVG_UNIT_PC,
    RSVG_UNIT_CH
} RsvgUnit;
 
typedef struct {
    double   length;
    RsvgUnit unit;
} RsvgLength;
 
RSVG_DEPRECATED
void rsvg_cleanup (void);
 
RSVG_DEPRECATED
void rsvg_set_default_dpi (double dpi);
 
RSVG_DEPRECATED
void rsvg_set_default_dpi_x_y (double dpi_x, double dpi_y);
 
RSVG_API
void rsvg_handle_set_dpi (RsvgHandle *handle, double dpi);
 
RSVG_API
void rsvg_handle_set_dpi_x_y (RsvgHandle *handle, double dpi_x, double dpi_y);
 
RSVG_API
RsvgHandle *rsvg_handle_new (void);
 
RSVG_DEPRECATED_FOR(rsvg_handle_read_stream_sync)
gboolean rsvg_handle_write (RsvgHandle   *handle,
                            const guchar *buf,
                            gsize         count,
                            GError      **error);
 
RSVG_DEPRECATED_FOR(rsvg_handle_read_stream_sync)
gboolean rsvg_handle_close (RsvgHandle *handle, GError **error);
 
RSVG_API
const char *rsvg_handle_get_base_uri (RsvgHandle *handle);
 
RSVG_API
void rsvg_handle_set_base_uri (RsvgHandle *handle, const char *base_uri);
 
RSVG_DEPRECATED_FOR(rsvg_handle_get_intrinsic_size_in_pixels)
void rsvg_handle_get_dimensions (RsvgHandle *handle, RsvgDimensionData *dimension_data);
 
RSVG_DEPRECATED_FOR(rsvg_handle_get_geometry_for_layer)
gboolean rsvg_handle_get_dimensions_sub (RsvgHandle        *handle,
                                         RsvgDimensionData *dimension_data,
                                         const char        *id);
 
RSVG_DEPRECATED_FOR(rsvg_handle_get_geometry_for_layer)
gboolean rsvg_handle_get_position_sub (RsvgHandle       *handle,
                                       RsvgPositionData *position_data,
                                       const char       *id);
 
RSVG_API
gboolean rsvg_handle_has_sub (RsvgHandle *handle, const char *id);
 
typedef enum /*< flags >*/
{
    RSVG_HANDLE_FLAGS_NONE           = 0,
    RSVG_HANDLE_FLAG_UNLIMITED       = 1 << 0,
    RSVG_HANDLE_FLAG_KEEP_IMAGE_DATA = 1 << 1
} RsvgHandleFlags;
 
RSVG_API
GType rsvg_handle_flags_get_type (void);
#define RSVG_TYPE_HANDLE_FLAGS (rsvg_handle_flags_get_type())
 
RSVG_API
RsvgHandle *rsvg_handle_new_with_flags (RsvgHandleFlags flags);
 
RSVG_API
void rsvg_handle_set_base_gfile (RsvgHandle *handle, GFile *base_file);
 
RSVG_API
gboolean rsvg_handle_read_stream_sync (RsvgHandle   *handle,
                                       GInputStream *stream,
                                       GCancellable *cancellable,
                                       GError      **error);
 
RSVG_API
RsvgHandle *rsvg_handle_new_from_gfile_sync (GFile          *file,
                                             RsvgHandleFlags flags,
                                             GCancellable   *cancellable,
                                             GError        **error);
 
RSVG_API
RsvgHandle *rsvg_handle_new_from_stream_sync (GInputStream   *input_stream,
                                              GFile          *base_file,
                                              RsvgHandleFlags flags,
                                              GCancellable   *cancellable,
                                              GError        **error);
 
RSVG_API
RsvgHandle *rsvg_handle_new_from_data (const guint8 *data, gsize data_len, GError **error);
 
RSVG_API
RsvgHandle *rsvg_handle_new_from_file (const gchar *filename, GError **error);
 
RSVG_API
gboolean rsvg_handle_set_stylesheet (RsvgHandle   *handle,
                                     const guint8 *css,
                                     gsize         css_len,
                                     GError      **error);
 
RSVG_API
void rsvg_handle_set_cancellable_for_rendering (RsvgHandle   *handle,
                                                GCancellable *cancellable);
 
RSVG_API
void rsvg_handle_get_intrinsic_dimensions (RsvgHandle    *handle,
                                           gboolean      *out_has_width,
                                           RsvgLength    *out_width,
                                           gboolean      *out_has_height,
                                           RsvgLength    *out_height,
                                           gboolean      *out_has_viewbox,
                                           RsvgRectangle *out_viewbox);
 
RSVG_API
gboolean rsvg_handle_get_intrinsic_size_in_pixels (RsvgHandle *handle,
                                                   gdouble    *out_width,
                                                   gdouble    *out_height);
 
#ifndef __GTK_DOC_IGNORE__
RSVG_API
void rsvg_handle_internal_set_testing (RsvgHandle *handle, gboolean testing);
#endif
 
RSVG_DEPRECATED_FOR(g_type_init)
void rsvg_init (void);
 
RSVG_DEPRECATED
void rsvg_term (void);
 
RSVG_DEPRECATED_FOR(g_object_unref)
void rsvg_handle_free (RsvgHandle *handle);
 
typedef void (*RsvgSizeFunc) (gint *width, gint *height, gpointer user_data);
 
RSVG_DEPRECATED
void rsvg_handle_set_size_callback (RsvgHandle    *handle,
                                    RsvgSizeFunc   size_func,
                                    gpointer       user_data,
                                    GDestroyNotify user_data_destroy);
 
RSVG_DEPRECATED
const char *rsvg_handle_get_title (RsvgHandle *handle);
 
RSVG_DEPRECATED
const char *rsvg_handle_get_desc (RsvgHandle *handle);
 
RSVG_DEPRECATED
const char *rsvg_handle_get_metadata (RsvgHandle *handle);
 
G_END_DECLS
 
#include "rsvg-version.h"
#include "rsvg-features.h"
#include "rsvg-cairo.h"
 
#if LIBRSVG_HAVE_PIXBUF
#include "rsvg-pixbuf.h"
#endif
 
#undef __RSVG_RSVG_H_INSIDE__
 
#endif /* RSVG_H */