netsurf/desktop/print.h

/*
 * Copyright 2008 Adam Blokus <adamblokus@gmail.com>
 *
 * This file is part of NetSurf, http://www.netsurf-browser.org/
 *
 * NetSurf 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; version 2 of the License.
 *
 * NetSurf 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, see <http://www.gnu.org/licenses/>.
 */

/** \file
 * Conception:
 * 	Generalized output-in-pages. Allows the current content to be 'printed':
 * either into a pdf file (any other later?) or to any kind of other output
 * destination that divides the website into pages - as a printer.
 * 	The basic usage is calling print_basic_run which sets everything up,
 * prints page after page until the whole content is printed and cleans
 * everyting up.
 * 	If there are any other, printer specific routines to be performed in the
 * meantime - there can be set up any other printing funcion, which can use
 * print_set_up, print_draw_next_page and print_cleanup directly.
*/

#ifndef NETSURF_DESKTOP_PRINT_H
#define NETSURF_DESKTOP_PRINT_H

#include <stdbool.h>
#include <libcss/libcss.h>

struct hlcache_handle;
struct printer;
struct gui_layout_table;

enum { MARGINLEFT = 0, MARGINRIGHT = 1, MARGINTOP = 2, MARGINBOTTOM = 3};

/** Predefined printing configuration names*/
typedef enum { PRINT_DEFAULT, PRINT_OPTIONS } print_configuration;

/** Settings for a print - filled in by print_make_settings or
 * 'manually' by the caller
*/
struct print_settings{
	/*Standard parameters*/
	float page_width, page_height;
	css_fixed margins[4];
	
	float scale;

	unsigned int copies;

	/*Output destinations - file/printer name*/
	const char *output;

	/*the functions used to measure fonts*/
	const struct gui_layout_table *font_func;

	/* Private data for the plotter context */
	const void *priv;
};


bool print_basic_run(struct hlcache_handle *, const struct printer *, 
		struct print_settings *);
bool print_set_up(struct hlcache_handle *content, const struct printer *printer,
		struct print_settings *settings, double *height);
bool print_draw_next_page(const struct printer *printer,
		struct print_settings *settings);
bool print_cleanup(struct hlcache_handle *, const struct printer *,
		struct print_settings *settings);

/**
 * Setup print settings for print render operation.
 */
struct print_settings *print_make_settings(print_configuration configuration, const char *url, const struct gui_layout_table *font_func);

/*is the content currently redrawn for printing?*/
extern bool html_redraw_printing;
/*if something is partially under this Y coordinate it won't be drawn...*/
extern int html_redraw_printing_border;
/*...and the highest of the tops of all cropped elements will be remembered*/
extern int html_redraw_printing_top_cropped;

#endif