libspectre/spectre-document.h

Go to the documentation of this file.

/* This file is part of Libspectre.
 * 
 * Copyright (C) 2007 Albert Astals Cid <aacid@kde.org>
 * Copyright (C) 2007 Carlos Garcia Campos <carlosgc@gnome.org>
 *
 * Libspectre is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * Libspectre 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef SPECTRE_DOCUMENT_H
#define SPECTRE_DOCUMENT_H

#include <libspectre/spectre-macros.h>
#include <libspectre/spectre-status.h>
#include <libspectre/spectre-page.h>

SPECTRE_BEGIN_DECLS

typedef struct SpectreDocument SpectreDocument;

SpectreDocument   *spectre_document_new                (void);

void               spectre_document_load               (SpectreDocument *document,
                                                        const char      *filename);

SpectreStatus      spectre_document_status             (SpectreDocument *document);

void               spectre_document_free               (SpectreDocument *document);

unsigned int       spectre_document_get_n_pages        (SpectreDocument *document);

SpectreOrientation spectre_document_get_orientation    (SpectreDocument *document);

const char        *spectre_document_get_title          (SpectreDocument *document);

const char        *spectre_document_get_creator        (SpectreDocument *document);

const char        *spectre_document_get_for            (SpectreDocument *document);

const char        *spectre_document_get_creation_date  (SpectreDocument *document);

const char        *spectre_document_get_format         (SpectreDocument *document);

int                spectre_document_is_eps             (SpectreDocument *document);

unsigned int       spectre_document_get_language_level (SpectreDocument *document);

SpectrePage       *spectre_document_get_page           (SpectreDocument *document,
                                                        unsigned int     page_index);

SpectrePage       *spectre_document_get_page_by_label  (SpectreDocument *document,
                                                        const char      *label);

void               spectre_document_render_full        (SpectreDocument      *document,
                                                        SpectreRenderContext *rc,
                                                        unsigned char       **page_data,
                                                        int                  *row_length);

void               spectre_document_render             (SpectreDocument      *document,
                                                        unsigned char       **page_data,
                                                        int                  *row_length);

/*  Convenient function for getting the page size of documents with no pages, tipically eps.
    When used with multi-page documents the size of the first page will be returned.
    @param document the document whose page will be returned
    @width the page width will be returned here, or NULL
    @height the page height will be returned here, or NULL
*/
void               spectre_document_get_page_size      (SpectreDocument      *document,
                                                        int                  *width,
                                                        int                  *height);

void               spectre_document_save               (SpectreDocument *document,
                                                        const char      *filename);
/* Save document as a pdf document. This function can fail
   @param document the document that will be saved
   @param filename the path where document will be saved as pdf
   @see spectre_document_status
*/
void               spectre_document_save_to_pdf        (SpectreDocument *document,
                                                        const char      *filename);
SPECTRE_END_DECLS

#endif /* SPECTRE_DOCUMENT_H */

---